Struct HeadersBuilder

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

A builder for Headers.

Implementations

impl HeadersBuilder

pub fn match_pattern(self, input: HeaderMatchPattern) -> Self

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": \[ "KeyToExclude1", "KeyToExclude2" \] }

This field is required.

pub fn set_match_pattern(self, input: Option<HeaderMatchPattern>) -> Self

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": \[ "KeyToExclude1", "KeyToExclude2" \] }

pub fn get_match_pattern(&self) -> &Option<HeaderMatchPattern>

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": \[ "KeyToExclude1", "KeyToExclude2" \] }

pub fn match_scope(self, input: MapMatchScope) -> Self

The parts of the headers to match with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

This field is required.

pub fn set_match_scope(self, input: Option<MapMatchScope>) -> Self

The parts of the headers to match with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

pub fn get_match_scope(&self) -> &Option<MapMatchScope>

The parts of the headers to match with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

pub fn oversize_handling(self, input: OversizeHandling) -> Self

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

• CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

This field is required.

pub fn set_oversize_handling(self, input: Option<OversizeHandling>) -> Self

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

• CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

pub fn get_oversize_handling(&self) -> &Option<OversizeHandling>

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

• CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

pub fn build(self) -> Result<Headers, BuildError>

Consumes the builder and constructs a Headers. This method will fail if any of the following fields are not set:

• match_scope
• oversize_handling

Trait Implementations

impl Clone for HeadersBuilder

fn clone(&self) -> HeadersBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeadersBuilder

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

Formats the value using the given formatter.

impl Default for HeadersBuilder

fn default() -> HeadersBuilder

Returns the “default value” for a type.

impl PartialEq for HeadersBuilder

fn eq(&self, other: &HeadersBuilder) -> 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 HeadersBuilder