Struct SampledHttpRequestBuilder

#[non_exhaustive]
pub struct SampledHttpRequestBuilder { /* private fields */ }

A builder for SampledHttpRequest.

Implementations

impl SampledHttpRequestBuilder

pub fn request(self, input: HttpRequest) -> Self

A complex type that contains detailed information about the request.

This field is required.

pub fn set_request(self, input: Option<HttpRequest>) -> Self

A complex type that contains detailed information about the request.

pub fn get_request(&self) -> &Option<HttpRequest>

A complex type that contains detailed information about the request.

pub fn weight(self, input: i64) -> Self

A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.

This field is required.

pub fn set_weight(self, input: Option<i64>) -> Self

A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.

pub fn get_weight(&self) -> &Option<i64>

A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.

pub fn timestamp(self, input: DateTime) -> Self

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

pub fn set_timestamp(self, input: Option<DateTime>) -> Self

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

pub fn get_timestamp(&self) -> &Option<DateTime>

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

pub fn action(self, input: impl Into<String>) -> Self

The action that WAF applied to the request.

pub fn set_action(self, input: Option<String>) -> Self

The action that WAF applied to the request.

pub fn get_action(&self) -> &Option<String>

The action that WAF applied to the request.

pub fn rule_name_within_rule_group(self, input: impl Into<String>) -> Self

The name of the Rule that the request matched. For managed rule groups, the format for this name is # # . For your own rule groups, the format for this name is # . If the rule is not in a rule group, this field is absent.

pub fn set_rule_name_within_rule_group(self, input: Option<String>) -> Self

The name of the Rule that the request matched. For managed rule groups, the format for this name is # # . For your own rule groups, the format for this name is # . If the rule is not in a rule group, this field is absent.

pub fn get_rule_name_within_rule_group(&self) -> &Option<String>

The name of the Rule that the request matched. For managed rule groups, the format for this name is # # . For your own rule groups, the format for this name is # . If the rule is not in a rule group, this field is absent.

pub fn request_headers_inserted(self, input: HttpHeader) -> Self

Appends an item to request_headers_inserted.

To override the contents of this collection use set_request_headers_inserted.

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

pub fn set_request_headers_inserted( self, input: Option<Vec<HttpHeader>>, ) -> Self

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

pub fn get_request_headers_inserted(&self) -> &Option<Vec<HttpHeader>>

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

pub fn response_code_sent(self, input: i32) -> Self

The response code that was sent for the request.

pub fn set_response_code_sent(self, input: Option<i32>) -> Self

The response code that was sent for the request.

pub fn get_response_code_sent(&self) -> &Option<i32>

The response code that was sent for the request.

pub fn labels(self, input: Label) -> Self

Appends an item to labels.

To override the contents of this collection use set_labels.

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

pub fn set_labels(self, input: Option<Vec<Label>>) -> Self

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

pub fn get_labels(&self) -> &Option<Vec<Label>>

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

pub fn captcha_response(self, input: CaptchaResponse) -> Self

The CAPTCHA response for the request.

pub fn set_captcha_response(self, input: Option<CaptchaResponse>) -> Self

The CAPTCHA response for the request.

pub fn get_captcha_response(&self) -> &Option<CaptchaResponse>

The CAPTCHA response for the request.

pub fn challenge_response(self, input: ChallengeResponse) -> Self

The Challenge response for the request.

pub fn set_challenge_response(self, input: Option<ChallengeResponse>) -> Self

The Challenge response for the request.

pub fn get_challenge_response(&self) -> &Option<ChallengeResponse>

The Challenge response for the request.

pub fn overridden_action(self, input: impl Into<String>) -> Self

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

pub fn set_overridden_action(self, input: Option<String>) -> Self

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

pub fn get_overridden_action(&self) -> &Option<String>

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

pub fn build(self) -> SampledHttpRequest

Consumes the builder and constructs a SampledHttpRequest.

Trait Implementations

impl Clone for SampledHttpRequestBuilder

fn clone(&self) -> SampledHttpRequestBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SampledHttpRequestBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SampledHttpRequestBuilder

fn default() -> SampledHttpRequestBuilder

Returns the “default value” for a type.

impl PartialEq for SampledHttpRequestBuilder

fn eq(&self, other: &SampledHttpRequestBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SampledHttpRequestBuilder