Class Cookies

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

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

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

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

See Also:

  • Method Details

    • matchPattern

      public final CookieMatchPattern matchPattern()

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

      You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

      Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

      Returns:
      The filter to use to identify the subset of cookies to inspect in a web request.

      You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

      Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

    • matchScope

      public final MapMatchScope matchScope()

      The parts of the cookies to inspect 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 cookies to inspect 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 cookies to inspect 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 cookies to inspect 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 cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

      The options for oversize handling are the following:

      • CONTINUE - Inspect the available cookies 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 cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

      The options for oversize handling are the following:

      • CONTINUE - Inspect the available cookies 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 cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

      The options for oversize handling are the following:

      • CONTINUE - Inspect the available cookies 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 cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

      The options for oversize handling are the following:

      • CONTINUE - Inspect the available cookies 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 Cookies.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<Cookies.Builder,Cookies>
      Returns:
      a builder for type T

    • builder

      public static Cookies.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Cookies.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.