Class HeaderOrder
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HeaderOrder.Builder,
HeaderOrder>
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that
WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its
inspection. WAF separates the header names in the string using colons and no added spaces, for example
host:user-agent:accept:authorization:referer
.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic HeaderOrder.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final OversizeHandling
What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect.final String
What WAF should do if the headers determined by your match scope are more numerous or larger than WAF can inspect.static Class
<? extends HeaderOrder.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
oversizeHandling
What WAF should do if the headers determined by your match scope 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.
If the service returns an enum value that is not available in the current SDK version,
oversizeHandling
will returnOversizeHandling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoversizeHandlingAsString()
.- Returns:
- What WAF should do if the headers determined by your match scope 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.
-
- See Also:
-
-
oversizeHandlingAsString
What WAF should do if the headers determined by your match scope 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.
If the service returns an enum value that is not available in the current SDK version,
oversizeHandling
will returnOversizeHandling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoversizeHandlingAsString()
.- Returns:
- What WAF should do if the headers determined by your match scope 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.
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<HeaderOrder.Builder,
HeaderOrder> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-