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>

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.

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasByteMatchTuples() For responses, this returns true if the service returned a value for the ByteMatchTuples property.
int	hashCode()
String	name() A friendly name or description of the ByteMatchSet.
List<SdkField<?>>	sdkFields()
static Class<? extends ByteMatchSet.Builder>	serializableBuilderClass()
ByteMatchSet.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

byteMatchSetId

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

hasByteMatchTuples

public final boolean hasByteMatchTuples()

For responses, this returns true if the service returned a value for the ByteMatchTuples 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.

byteMatchTuples

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

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<ByteMatchSet.Builder,ByteMatchSet>

builder

public static ByteMatchSet.Builder builder()

serializableBuilderClass

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