Class JsonMatchPattern

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

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

See Also:

  • Method Details

    • all

      public final All all()

      Match all of the elements. See also MatchScope in JsonBody.

      You must specify either this setting or the IncludedPaths setting, but not both.

      Returns:
      Match all of the elements. See also MatchScope in JsonBody.

      You must specify either this setting or the IncludedPaths setting, but not both.

    • hasIncludedPaths

      public final boolean hasIncludedPaths()
      For responses, this returns true if the service returned a value for the IncludedPaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • includedPaths

      public final List<String> includedPaths()

      Match only the specified include paths. See also MatchScope in JsonBody.

      Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

      You must specify either this setting or the All setting, but not both.

      Don't use this option to include all paths. Instead, use the All setting.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludedPaths() method.

      Returns:
      Match only the specified include paths. See also MatchScope in JsonBody.

      Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

      You must specify either this setting or the All setting, but not both.

      Don't use this option to include all paths. Instead, use the All setting.

    • toBuilder

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

    • builder

      public static JsonMatchPattern.Builder builder()

    • serializableBuilderClass

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