Package software.amazon.awssdk.services.waf.model

Class XssMatchSet

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

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.

A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

See Also:

  • Method Details

    • xssMatchSetId

      public final String xssMatchSetId()

      A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

      XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

      Returns:
      A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

      XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    • name

      public final String name()

      The name, if any, of the XssMatchSet.

      Returns:
      The name, if any, of the XssMatchSet.

    • hasXssMatchTuples

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

    • xssMatchTuples

      public final List<XssMatchTuple> xssMatchTuples()

      Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

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

      Returns:
      Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    • toBuilder

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

    • builder

      public static XssMatchSet.Builder builder()

    • serializableBuilderClass

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