software.amazon.awssdk.services.wafv2.model

Class RegexPatternSet

java.lang.Object

software.amazon.awssdk.services.wafv2.model.RegexPatternSet

All Implemented Interfaces:

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

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

Contains one or more regular expressions.

WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegexPatternSet.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the entity.
static RegexPatternSet.Builder	builder()
String	description() A description of the set that helps with identification.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegularExpressionList() For responses, this returns true if the service returned a value for the RegularExpressionList property.
String	id() A unique identifier for the set.
String	name() The name of the set.
List<Regex>	regularExpressionList() The regular expression patterns in the set.
List<SdkField<?>>	sdkFields()
static Class<? extends RegexPatternSet.Builder>	serializableBuilderClass()
RegexPatternSet.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

name

public final String name()

The name of the set. You cannot change the name after you create the set.

Returns:

The name of the set. You cannot change the name after you create the set.

id

public final String id()

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

arn

public final String arn()

The Amazon Resource Name (ARN) of the entity.

Returns:

The Amazon Resource Name (ARN) of the entity.

description

public final String description()

A description of the set that helps with identification.

Returns:

A description of the set that helps with identification.

hasRegularExpressionList

public final boolean hasRegularExpressionList()

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

regularExpressionList

public final List<Regex> regularExpressionList()

The regular expression patterns in the set.

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

Returns:

The regular expression patterns in the set.

toBuilder

public RegexPatternSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegexPatternSet.Builder,RegexPatternSet>

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)

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