Class ByteMatchSet
- java.lang.Object
-
- com.amazonaws.services.waf.model.ByteMatchSet
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ByteMatchSet extends Object implements Serializable, Cloneable
In a GetByteMatchSet request,
ByteMatchSet
is a complex type that contains theByteMatchSetId
andName
of aByteMatchSet
, and the values that you specified when you updated theByteMatchSet
.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 aByteMatchSet
contains more than oneByteMatchTuple
object, a request needs to match the settings in only oneByteMatchTuple
to be considered a match.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ByteMatchSet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ByteMatchSet
clone()
boolean
equals(Object obj)
String
getByteMatchSetId()
TheByteMatchSetId
for aByteMatchSet
.List<ByteMatchTuple>
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.String
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
setName(String name)
A friendly name or description of the ByteMatchSet.String
toString()
Returns a string representation of this object; useful for testing and debugging.ByteMatchSet
withByteMatchSetId(String byteMatchSetId)
TheByteMatchSetId
for aByteMatchSet
.ByteMatchSet
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.ByteMatchSet
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.ByteMatchSet
withName(String name)
A friendly name or description of the ByteMatchSet.
-
-
-
Method Detail
-
setByteMatchSetId
public void setByteMatchSetId(String byteMatchSetId)
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
public String 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
public ByteMatchSet withByteMatchSetId(String byteMatchSetId)
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
public void setName(String name)
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
public String 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
public ByteMatchSet withName(String name)
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
public List<ByteMatchTuple> 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
public 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.
- 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
public ByteMatchSet 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.
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
public ByteMatchSet 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.
- 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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ByteMatchSet clone()
-
-