software.amazon.awssdk.services.waf.model

Class ByteMatchSet

java.lang.Object

software.amazon.awssdk.services.waf.model.ByteMatchSet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ByteMatchSet.Builder,ByteMatchSet>

@Generated(value="software.amazon.awssdk:codegen")
public final class ByteMatchSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ByteMatchSet.Builder,ByteMatchSet>

In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ByteMatchSet.Builder

Method Summary

Modifier and Type	Method and Description
static ByteMatchSet.Builder	builder()
String	byteMatchSetId() The ByteMatchSetId for a ByteMatchSet.
List<ByteMatchTuple>	byteMatchTuples() Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() A friendly name or description of the ByteMatchSet.
List<SdkField<?>>	sdkFields()
static Class<? extends ByteMatchSet.Builder>	serializableBuilderClass()
ByteMatchSet.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

byteMatchSetId

public String byteMatchSetId()

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Returns:

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

name

public String name()

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

Returns:

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

byteMatchTuples

public List<ByteMatchTuple> byteMatchTuples()

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

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

Returns:

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

toBuilder

public ByteMatchSet.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<ByteMatchSet.Builder,ByteMatchSet>

Returns:

a builder for type T

builder

public static ByteMatchSet.Builder builder()

serializableBuilderClass

public static Class<? extends ByteMatchSet.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.