Class ByteMatchSet
- All Implemented Interfaces:
Serializable
,Cloneable
In a GetByteMatchSet request, ByteMatchSet
is a complex
type that contains the ByteMatchSetId
and Name
of a
ByteMatchSet
, and the values that you specified when you updated
the ByteMatchSet
.
A complex type that contains ByteMatchTuple
objects, 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 ByteMatchSet
contains more than one ByteMatchTuple
object, a request needs to
match the settings in only one ByteMatchTuple
to be considered a
match.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
TheByteMatchSetId
for aByteMatchSet
.Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.getName()
A friendly name or description of the ByteMatchSet.int
hashCode()
void
setByteMatchSetId
(String byteMatchSetId) TheByteMatchSetId
for aByteMatchSet
.void
setByteMatchTuples
(Collection<ByteMatchTuple> byteMatchTuples) Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.void
A friendly name or description of the ByteMatchSet.toString()
Returns a string representation of this object; useful for testing and debugging.withByteMatchSetId
(String byteMatchSetId) TheByteMatchSetId
for aByteMatchSet
.withByteMatchTuples
(ByteMatchTuple... byteMatchTuples) Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.withByteMatchTuples
(Collection<ByteMatchTuple> byteMatchTuples) Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.A friendly name or description of the ByteMatchSet.
-
Constructor Details
-
ByteMatchSet
public ByteMatchSet()
-
-
Method Details
-
setByteMatchSetId
The
ByteMatchSetId
for aByteMatchSet
. You useByteMatchSetId
to get information about aByteMatchSet
(see GetByteMatchSet), update aByteMatchSet
(see UpdateByteMatchSet), insert aByteMatchSet
into aRule
or delete one from aRule
(see UpdateRule), and delete aByteMatchSet
from AWS WAF (see DeleteByteMatchSet).ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.- Parameters:
byteMatchSetId
- TheByteMatchSetId
for aByteMatchSet
. You useByteMatchSetId
to get information about aByteMatchSet
(see GetByteMatchSet), update aByteMatchSet
(see UpdateByteMatchSet), insert aByteMatchSet
into aRule
or delete one from aRule
(see UpdateRule), and delete aByteMatchSet
from AWS WAF (see DeleteByteMatchSet).ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
-
getByteMatchSetId
The
ByteMatchSetId
for aByteMatchSet
. You useByteMatchSetId
to get information about aByteMatchSet
(see GetByteMatchSet), update aByteMatchSet
(see UpdateByteMatchSet), insert aByteMatchSet
into aRule
or delete one from aRule
(see UpdateRule), and delete aByteMatchSet
from AWS WAF (see DeleteByteMatchSet).ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.- Returns:
- The
ByteMatchSetId
for aByteMatchSet
. You useByteMatchSetId
to get information about aByteMatchSet
(see GetByteMatchSet), update aByteMatchSet
(see UpdateByteMatchSet), insert aByteMatchSet
into aRule
or delete one from aRule
(see UpdateRule), and delete aByteMatchSet
from AWS WAF (see DeleteByteMatchSet).ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
-
withByteMatchSetId
The
ByteMatchSetId
for aByteMatchSet
. You useByteMatchSetId
to get information about aByteMatchSet
(see GetByteMatchSet), update aByteMatchSet
(see UpdateByteMatchSet), insert aByteMatchSet
into aRule
or delete one from aRule
(see UpdateRule), and delete aByteMatchSet
from AWS WAF (see DeleteByteMatchSet).ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.- Parameters:
byteMatchSetId
- TheByteMatchSetId
for aByteMatchSet
. You useByteMatchSetId
to get information about aByteMatchSet
(see GetByteMatchSet), update aByteMatchSet
(see UpdateByteMatchSet), insert aByteMatchSet
into aRule
or delete one from aRule
(see UpdateRule), and delete aByteMatchSet
from AWS WAF (see DeleteByteMatchSet).ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
A friendly name or description of the ByteMatchSet. You can't change
Name
after you create aByteMatchSet
.- Parameters:
name
- A friendly name or description of the ByteMatchSet. You can't changeName
after you create aByteMatchSet
.
-
getName
A friendly name or description of the ByteMatchSet. You can't change
Name
after you create aByteMatchSet
.- Returns:
- A friendly name or description of the ByteMatchSet. You
can't change
Name
after you create aByteMatchSet
.
-
withName
A friendly name or description of the ByteMatchSet. You can't change
Name
after you create aByteMatchSet
.- Parameters:
name
- A friendly name or description of the ByteMatchSet. You can't changeName
after you create aByteMatchSet
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getByteMatchTuples
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
- Returns:
- Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
-
setByteMatchTuples
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
- Parameters:
byteMatchTuples
- Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
-
withByteMatchTuples
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
NOTE: This method appends the values to the existing list (if any). Use
setByteMatchTuples(java.util.Collection)
orwithByteMatchTuples(java.util.Collection)
if you want to override the existing values.- Parameters:
byteMatchTuples
- Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withByteMatchTuples
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
- Parameters:
byteMatchTuples
- Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-