Class RegexPatternSet

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

See Also:

  • Method Details

    • regexPatternSetId

      public final String regexPatternSetId()

      The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

      RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

      Returns:
      The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

      RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    • name

      public final String name()

      A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

      Returns:
      A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    • hasRegexPatternStrings

      public final boolean hasRegexPatternStrings()
      For responses, this returns true if the service returned a value for the RegexPatternStrings 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.

    • regexPatternStrings

      public final List<String> regexPatternStrings()

      Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

      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 hasRegexPatternStrings() method.

      Returns:
      Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    • toBuilder

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

    • builder

      public static RegexPatternSet.Builder builder()

    • serializableBuilderClass

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