ByteMatchSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.waf.model.ByteMatchSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ByteMatchSet
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 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ByteMatchSet()

Constructors
Constructor and Description
`ByteMatchSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteMatchSet`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getByteMatchSetId()` The `ByteMatchSetId` for a `ByteMatchSet`.
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setByteMatchSetId(String byteMatchSetId)` The `ByteMatchSetId` for a `ByteMatchSet`.
`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.
`ByteMatchSet`	`withByteMatchSetId(String byteMatchSetId)` The `ByteMatchSetId` for a `ByteMatchSet`.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ByteMatchSet
```
public ByteMatchSet()
```
- Method Detail
  - setByteMatchSetId
```
public void setByteMatchSetId(String byteMatchSetId)
```
    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
    
    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
    
    Parameters:
    
    byteMatchSetId - The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
    
    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
  - getByteMatchSetId
```
public String getByteMatchSetId()
```
    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
    
    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
    
    Returns:
    
    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
    
    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
  - withByteMatchSetId
```
public ByteMatchSet withByteMatchSetId(String byteMatchSetId)
```
    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
    
    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
    
    Parameters:
    
    byteMatchSetId - The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet 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 a ByteMatchSet.
    
    Parameters:
    
    name - A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
  - getName
```
public String getName()
```
    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
    
    Returns:
    
    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
  - withName
```
public ByteMatchSet withName(String name)
```
    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
    
    Parameters:
    
    name - A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
    
    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) or withByteMatchTuples(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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ByteMatchSet clone()
```
    Overrides:
    
    clone in class Object
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class ByteMatchSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteMatchSet

Method Detail

setByteMatchSetId

getByteMatchSetId

withByteMatchSetId

setName

getName

withName

getByteMatchTuples

setByteMatchTuples

withByteMatchTuples

withByteMatchTuples

toString

equals

hashCode

clone

marshall