software.amazon.awssdk.services.waf.model

Class RegexPatternSet

java.lang.Object

software.amazon.awssdk.services.waf.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>

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.

The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

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
static RegexPatternSet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegexPatternStrings() For responses, this returns true if the service returned a value for the RegexPatternStrings property.
String	name() A friendly name or description of the RegexPatternSet.
String	regexPatternSetId() The identifier for the RegexPatternSet.
List<String>	regexPatternStrings() Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
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

regexPatternSetId

public final String regexPatternSetId()

The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Returns:

The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

name

public final String name()

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

Returns:

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

hasRegexPatternStrings

public final boolean hasRegexPatternStrings()

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

regexPatternStrings

public final List<String> regexPatternStrings()

Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

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

Returns:

Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

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