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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XssMatchSet.Builder

Method Summary

Modifier and Type	Method and Description
static XssMatchSet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasXssMatchTuples() Returns true if the XssMatchTuples property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() The name, if any, of the XssMatchSet.
List<SdkField<?>>	sdkFields()
static Class<? extends XssMatchSet.Builder>	serializableBuilderClass()
XssMatchSet.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	xssMatchSetId() A unique identifier for an XssMatchSet.
List<XssMatchTuple>	xssMatchTuples() Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Returns true if the XssMatchTuples property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasXssMatchTuples() to see if a value was sent in this field.

Returns:

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

toBuilder

public XssMatchSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<XssMatchSet.Builder,XssMatchSet>

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)

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