java.lang.Object
- software.amazon.awssdk.services.wafv2.model.RegexPatternSetReferenceStatement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RegexPatternSetReferenceStatement.Builder,RegexPatternSetReferenceStatement>
```
@Generated("software.amazon.awssdk:codegen")
public final class RegexPatternSetReferenceStatement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RegexPatternSetReferenceStatement.Builder,RegexPatternSetReferenceStatement>
```
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RegexPatternSetReferenceStatement.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
`static RegexPatternSetReferenceStatement.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FieldToMatch`	`fieldToMatch()`	The part of the web request that you want WAF to inspect.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTextTransformations()`	For responses, this returns true if the service returned a value for the TextTransformations property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegexPatternSetReferenceStatement.Builder>`	`serializableBuilderClass()`
`List<TextTransformation>`	`textTransformations()`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
`RegexPatternSetReferenceStatement.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
  - fieldToMatch
```
public final FieldToMatch fieldToMatch()
```
    The part of the web request that you want WAF to inspect.
    
    Returns:
    
    The part of the web request that you want WAF to inspect.
  - hasTextTransformations
```
public final boolean hasTextTransformations()
```
    For responses, this returns true if the service returned a value for the TextTransformations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - textTransformations
```
public final List<TextTransformation> textTransformations()
```
    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTextTransformations() method.
    
    Returns:
    
    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
  - toBuilder
```
public RegexPatternSetReferenceStatement.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegexPatternSetReferenceStatement.Builder,RegexPatternSetReferenceStatement>
  - builder
```
public static RegexPatternSetReferenceStatement.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegexPatternSetReferenceStatement.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegexPatternSetReferenceStatement

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

fieldToMatch

hasTextTransformations

textTransformations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields