@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RegexMatchSet extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
RegexMatchSet() |
Modifier and Type | Method and Description |
---|---|
RegexMatchSet |
clone() |
boolean |
equals(Object obj) |
String |
getName()
A friendly name or description of the RegexMatchSet.
|
String |
getRegexMatchSetId()
The
RegexMatchSetId for a RegexMatchSet . |
List<RegexMatchTuple> |
getRegexMatchTuples()
Contains an array of RegexMatchTuple objects.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setName(String name)
A friendly name or description of the RegexMatchSet.
|
void |
setRegexMatchSetId(String regexMatchSetId)
The
RegexMatchSetId for a RegexMatchSet . |
void |
setRegexMatchTuples(Collection<RegexMatchTuple> regexMatchTuples)
Contains an array of RegexMatchTuple objects.
|
String |
toString()
Returns a string representation of this object.
|
RegexMatchSet |
withName(String name)
A friendly name or description of the RegexMatchSet.
|
RegexMatchSet |
withRegexMatchSetId(String regexMatchSetId)
The
RegexMatchSetId for a RegexMatchSet . |
RegexMatchSet |
withRegexMatchTuples(Collection<RegexMatchTuple> regexMatchTuples)
Contains an array of RegexMatchTuple objects.
|
RegexMatchSet |
withRegexMatchTuples(RegexMatchTuple... regexMatchTuples)
Contains an array of RegexMatchTuple objects.
|
public void setRegexMatchSetId(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.
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.
public String getRegexMatchSetId()
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.
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.
public RegexMatchSet withRegexMatchSetId(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.
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.
public void setName(String name)
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a
RegexMatchSet
.
name
- A friendly name or description of the RegexMatchSet. You can't change Name
after you
create a RegexMatchSet
.public String getName()
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a
RegexMatchSet
.
Name
after you
create a RegexMatchSet
.public RegexMatchSet withName(String name)
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a
RegexMatchSet
.
name
- A friendly name or description of the RegexMatchSet. You can't change Name
after you
create a RegexMatchSet
.public List<RegexMatchTuple> getRegexMatchTuples()
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.
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.
public void setRegexMatchTuples(Collection<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.
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.
public RegexMatchSet withRegexMatchTuples(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.
NOTE: This method appends the values to the existing list (if any). Use
setRegexMatchTuples(java.util.Collection)
or withRegexMatchTuples(java.util.Collection)
if you
want to override the existing values.
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.
public RegexMatchSet withRegexMatchTuples(Collection<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.
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.
public String toString()
toString
in class Object
Object.toString()
public RegexMatchSet clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.