RegexPatternSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.waf.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 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.

The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

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`	`getName()` A friendly name or description of the RegexPatternSet.
`String`	`getRegexPatternSetId()` The identifier for the `RegexPatternSet`.
`List<String>`	`getRegexPatternStrings()` Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`.
`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 RegexPatternSet.
`void`	`setRegexPatternSetId(String regexPatternSetId)` The identifier for the `RegexPatternSet`.
`void`	`setRegexPatternStrings(Collection<String> regexPatternStrings)` Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`.
`String`	`toString()` Returns a string representation of this object.
`RegexPatternSet`	`withName(String name)` A friendly name or description of the RegexPatternSet.
`RegexPatternSet`	`withRegexPatternSetId(String regexPatternSetId)` The identifier for the `RegexPatternSet`.
`RegexPatternSet`	`withRegexPatternStrings(Collection<String> regexPatternStrings)` Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`.
`RegexPatternSet`	`withRegexPatternStrings(String... regexPatternStrings)` Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`.

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

- Constructor Detail
  - RegexPatternSet
```
public RegexPatternSet()
```
- Method Detail
  - setRegexPatternSetId
```
public void setRegexPatternSetId(String regexPatternSetId)
```
    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.
    
    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
    
    Parameters:
    
    regexPatternSetId - The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.
    
    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
  - getRegexPatternSetId
```
public String getRegexPatternSetId()
```
    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.
    
    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
    
    Returns:
    
    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.
    
    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
  - withRegexPatternSetId
```
public RegexPatternSet withRegexPatternSetId(String regexPatternSetId)
```
    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.
    
    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
    
    Parameters:
    
    regexPatternSetId - The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.
    
    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
    
    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 RegexPatternSet. You can't change Name after you create a RegexPatternSet.
    
    Parameters:
    
    name - A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
  - getName
```
public String getName()
```
    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
    
    Returns:
    
    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
  - withName
```
public RegexPatternSet withName(String name)
```
    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
    
    Parameters:
    
    name - A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRegexPatternStrings
```
public List<String> getRegexPatternStrings()
```
    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
    
    Returns:
    
    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
  - setRegexPatternStrings
```
public void setRegexPatternStrings(Collection<String> regexPatternStrings)
```
    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
    
    Parameters:
    
    regexPatternStrings - Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
  - withRegexPatternStrings
```
public RegexPatternSet withRegexPatternStrings(String... regexPatternStrings)
```
    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
    
    NOTE: This method appends the values to the existing list (if any). Use setRegexPatternStrings(java.util.Collection) or withRegexPatternStrings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    regexPatternStrings - Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRegexPatternStrings
```
public RegexPatternSet withRegexPatternStrings(Collection<String> regexPatternStrings)
```
    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
    
    Parameters:
    
    regexPatternStrings - Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
    
    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

setRegexPatternSetId

getRegexPatternSetId

withRegexPatternSetId

setName

getName

withName

getRegexPatternStrings

setRegexPatternStrings

withRegexPatternStrings

withRegexPatternStrings

toString

equals

hashCode

clone

marshall