Package software.amazon.awssdk.services.wafv2.model

Class Headers

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

Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead.

Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

See Also:

  • Method Details

    • matchPattern

      public final HeaderMatchPattern matchPattern()

      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" ] }

      Returns:
      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" ] }

    • matchScope

      public final MapMatchScope matchScope()

      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.

      If the service returns an enum value that is not available in the current SDK version, matchScope will return MapMatchScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchScopeAsString().

      Returns:
      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.

      See Also:

    • matchScopeAsString

      public final String matchScopeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, matchScope will return MapMatchScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchScopeAsString().

      Returns:
      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.

      See Also:

    • 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 Headers.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<Headers.Builder,Headers>

    • builder

      public static Headers.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Headers.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo