Class HeaderOrder

java.lang.Object
software.amazon.awssdk.services.wafv2.model.HeaderOrder
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HeaderOrder.Builder,HeaderOrder>
@Generated("software.amazon.awssdk:codegen") public final class HeaderOrder extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • oversizeHandling

      public final OversizeHandling 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 return OversizeHandling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from oversizeHandlingAsString().

      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

      public final String 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 return OversizeHandling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from oversizeHandlingAsString().

      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

      public HeaderOrder.Builder 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 interface ToCopyableBuilder<HeaderOrder.Builder,HeaderOrder>
      Returns:
      a builder for type T

    • builder

      public static HeaderOrder.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HeaderOrder.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.