software.amazon.awssdk.services.waf.model

Class RegexMatchSet

java.lang.Object

software.amazon.awssdk.services.waf.model.RegexMatchSet

All Implemented Interfaces:

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

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

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 GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you specified when you updated the RegexMatchSet.

The values are contained in a RegexMatchTuple object, 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 RegexMatchSet contains more than one RegexMatchTuple 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	RegexMatchSet.Builder

Method Summary

Modifier and Type	Method and Description
static RegexMatchSet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegexMatchTuples() Returns true if the RegexMatchTuples 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() A friendly name or description of the RegexMatchSet.
String	regexMatchSetId() The RegexMatchSetId for a RegexMatchSet.
List<RegexMatchTuple>	regexMatchTuples() Contains an array of RegexMatchTuple objects.
List<SdkField<?>>	sdkFields()
static Class<? extends RegexMatchSet.Builder>	serializableBuilderClass()
RegexMatchSet.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

regexMatchSetId

public final String regexMatchSetId()

The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

Returns:

The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

name

public final String name()

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

Returns:

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

hasRegexMatchTuples

public final boolean hasRegexMatchTuples()

Returns true if the RegexMatchTuples 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.

regexMatchTuples

public final List<RegexMatchTuple> regexMatchTuples()

Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

• The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

• The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

• Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

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

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

Returns:

Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

• The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

• The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

• Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

toBuilder

public RegexMatchSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegexMatchSet.Builder,RegexMatchSet>

builder

public static RegexMatchSet.Builder builder()

serializableBuilderClass

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