RegexPatternSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.RegexPatternSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegexPatternSet
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Contains one or more regular expressions.

AWS WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RegexPatternSet()

Constructors
Constructor and Description
`RegexPatternSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RegexPatternSet`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the entity.
`String`	`getDescription()` A friendly description of the set.
`String`	`getId()` A unique identifier for the set.
`String`	`getName()` A friendly name of the set.
`List<Regex>`	`getRegularExpressionList()` The regular expression patterns in the set.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`void`	`setDescription(String description)` A friendly description of the set.
`void`	`setId(String id)` A unique identifier for the set.
`void`	`setName(String name)` A friendly name of the set.
`void`	`setRegularExpressionList(Collection<Regex> regularExpressionList)` The regular expression patterns in the set.
`String`	`toString()` Returns a string representation of this object.
`RegexPatternSet`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`RegexPatternSet`	`withDescription(String description)` A friendly description of the set.
`RegexPatternSet`	`withId(String id)` A unique identifier for the set.
`RegexPatternSet`	`withName(String name)` A friendly name of the set.
`RegexPatternSet`	`withRegularExpressionList(Collection<Regex> regularExpressionList)` The regular expression patterns in the set.
`RegexPatternSet`	`withRegularExpressionList(Regex... regularExpressionList)` The regular expression patterns in the set.

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

- Constructor Detail
  - RegexPatternSet
```
public RegexPatternSet()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    A friendly name of the set. You cannot change the name after you create the set.
    
    Parameters:
    
    name - A friendly name of the set. You cannot change the name after you create the set.
  - getName
```
public String getName()
```
    A friendly name of the set. You cannot change the name after you create the set.
    
    Returns:
    
    A friendly name of the set. You cannot change the name after you create the set.
  - withName
```
public RegexPatternSet withName(String name)
```
    A friendly name of the set. You cannot change the name after you create the set.
    
    Parameters:
    
    name - A friendly name of the set. You cannot change the name after you create the set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - getId
```
public String getId()
```
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - withId
```
public RegexPatternSet withId(String id)
```
    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withARN
```
public RegexPatternSet withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A friendly description of the set. You cannot change the description of a set after you create it.
    
    Parameters:
    
    description - A friendly description of the set. You cannot change the description of a set after you create it.
  - getDescription
```
public String getDescription()
```
    A friendly description of the set. You cannot change the description of a set after you create it.
    
    Returns:
    
    A friendly description of the set. You cannot change the description of a set after you create it.
  - withDescription
```
public RegexPatternSet withDescription(String description)
```
    A friendly description of the set. You cannot change the description of a set after you create it.
    
    Parameters:
    
    description - A friendly description of the set. You cannot change the description of a set after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRegularExpressionList
```
public List<Regex> getRegularExpressionList()
```
    The regular expression patterns in the set.
    
    Returns:
    
    The regular expression patterns in the set.
  - setRegularExpressionList
```
public void setRegularExpressionList(Collection<Regex> regularExpressionList)
```
    The regular expression patterns in the set.
    
    Parameters:
    
    regularExpressionList - The regular expression patterns in the set.
  - withRegularExpressionList
```
public RegexPatternSet withRegularExpressionList(Regex... regularExpressionList)
```
    The regular expression patterns in the set.
    
    NOTE: This method appends the values to the existing list (if any). Use setRegularExpressionList(java.util.Collection) or withRegularExpressionList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    regularExpressionList - The regular expression patterns in the set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRegularExpressionList
```
public RegexPatternSet withRegularExpressionList(Collection<Regex> regularExpressionList)
```
    The regular expression patterns in the set.
    
    Parameters:
    
    regularExpressionList - The regular expression patterns in the set.
    
    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 RegexPatternSet 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.

Did this page help you?

Class RegexPatternSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegexPatternSet

Method Detail

setName

getName

withName

setId

getId

withId

setARN

getARN

withARN

setDescription

getDescription

withDescription

getRegularExpressionList

setRegularExpressionList

withRegularExpressionList

withRegularExpressionList

toString

equals

hashCode

clone

marshall