software.amazon.awssdk.services.waf.model

Class RegexMatchSet

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<RegexMatchSet.Builder,RegexMatchSet>

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

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.

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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.
static Class<? extends RegexMatchSet.Builder>	serializableBuilderClass()
RegexMatchSet.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

regexMatchSetId

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

regexMatchTuples

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

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

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<RegexMatchSet.Builder,RegexMatchSet>

Returns:

a builder for type T

builder

public static RegexMatchSet.Builder builder()

serializableBuilderClass

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.