java.lang.Object
- software.amazon.awssdk.services.waf.model.RegexMatchTuple

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RegexMatchTuple.Builder,RegexMatchTuple>
```
@Generated("software.amazon.awssdk:codegen")
public final class RegexMatchTuple
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RegexMatchTuple.Builder,RegexMatchTuple>
```
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 regular expression pattern 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. Each RegexMatchTuple object contains:
- The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.
- The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
- Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RegexMatchTuple.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RegexMatchTuple.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FieldToMatch`	`fieldToMatch()`	Specifies where in a web request to look for the `RegexPatternSet`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`regexPatternSetId()`	The `RegexPatternSetId` for a `RegexPatternSet`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegexMatchTuple.Builder>`	`serializableBuilderClass()`
`TextTransformation`	`textTransformation()`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.
`String`	`textTransformationAsString()`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.
`RegexMatchTuple.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
  - fieldToMatch
```
public final FieldToMatch fieldToMatch()
```
    Specifies where in a web request to look for the RegexPatternSet.
    
    Returns:
    
    Specifies where in a web request to look for the RegexPatternSet.
  - textTransformation
```
public final TextTransformation textTransformation()
```
    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.
    
    You can only specify a single type of TextTransformation.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
    
    Delete the following characters: \ " ' ^
    
    Delete spaces before the following characters: / (
    
    Replace the following characters with a space: , ;
    
    Replace multiple spaces with one space
    
    Convert uppercase letters (A-Z) to lowercase (a-z)
    
    COMPRESS_WHITE_SPACE
    
    Use this option to replace the following characters with a space character (decimal 32):
    
    \f, formfeed, decimal 12
    
    \t, tab, decimal 9
    
    \n, newline, decimal 10
    
    \r, carriage return, decimal 13
    
    \v, vertical tab, decimal 11
    
    non-breaking space, decimal 160
    
    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
    
    HTML_ENTITY_DECODE
    
    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
    
    Replaces (ampersand)quot; with "
    
    Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    
    Replaces (ampersand)lt; with a "less than" symbol
    
    Replaces (ampersand)gt; with >
    
    Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    
    Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters
    
    LOWERCASE
    
    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
    
    URL_DECODE
    
    Use this option to decode a URL-encoded value.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    If the service returns an enum value that is not available in the current SDK version, textTransformation will return TextTransformation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textTransformationAsString().
    Returns:
    
    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.
    
    You can only specify a single type of TextTransformation.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
    
    Delete the following characters: \ " ' ^
    
    Delete spaces before the following characters: / (
    
    Replace the following characters with a space: , ;
    
    Replace multiple spaces with one space
    
    Convert uppercase letters (A-Z) to lowercase (a-z)
    
    COMPRESS_WHITE_SPACE
    
    Use this option to replace the following characters with a space character (decimal 32):
    
    \f, formfeed, decimal 12
    
    \t, tab, decimal 9
    
    \n, newline, decimal 10
    
    \r, carriage return, decimal 13
    
    \v, vertical tab, decimal 11
    
    non-breaking space, decimal 160
    
    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
    
    HTML_ENTITY_DECODE
    
    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
    
    Replaces (ampersand)quot; with "
    
    Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    
    Replaces (ampersand)lt; with a "less than" symbol
    
    Replaces (ampersand)gt; with >
    
    Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    
    Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters
    
    LOWERCASE
    
    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
    
    URL_DECODE
    
    Use this option to decode a URL-encoded value.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    See Also:
    
    TextTransformation
  - textTransformationAsString
```
public final String textTransformationAsString()
```
    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.
    
    You can only specify a single type of TextTransformation.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
    
    Delete the following characters: \ " ' ^
    
    Delete spaces before the following characters: / (
    
    Replace the following characters with a space: , ;
    
    Replace multiple spaces with one space
    
    Convert uppercase letters (A-Z) to lowercase (a-z)
    
    COMPRESS_WHITE_SPACE
    
    Use this option to replace the following characters with a space character (decimal 32):
    
    \f, formfeed, decimal 12
    
    \t, tab, decimal 9
    
    \n, newline, decimal 10
    
    \r, carriage return, decimal 13
    
    \v, vertical tab, decimal 11
    
    non-breaking space, decimal 160
    
    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
    
    HTML_ENTITY_DECODE
    
    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
    
    Replaces (ampersand)quot; with "
    
    Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    
    Replaces (ampersand)lt; with a "less than" symbol
    
    Replaces (ampersand)gt; with >
    
    Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    
    Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters
    
    LOWERCASE
    
    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
    
    URL_DECODE
    
    Use this option to decode a URL-encoded value.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    If the service returns an enum value that is not available in the current SDK version, textTransformation will return TextTransformation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textTransformationAsString().
    Returns:
    
    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.
    
    You can only specify a single type of TextTransformation.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
    
    Delete the following characters: \ " ' ^
    
    Delete spaces before the following characters: / (
    
    Replace the following characters with a space: , ;
    
    Replace multiple spaces with one space
    
    Convert uppercase letters (A-Z) to lowercase (a-z)
    
    COMPRESS_WHITE_SPACE
    
    Use this option to replace the following characters with a space character (decimal 32):
    
    \f, formfeed, decimal 12
    
    \t, tab, decimal 9
    
    \n, newline, decimal 10
    
    \r, carriage return, decimal 13
    
    \v, vertical tab, decimal 11
    
    non-breaking space, decimal 160
    
    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
    
    HTML_ENTITY_DECODE
    
    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
    
    Replaces (ampersand)quot; with "
    
    Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    
    Replaces (ampersand)lt; with a "less than" symbol
    
    Replaces (ampersand)gt; with >
    
    Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    
    Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters
    
    LOWERCASE
    
    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
    
    URL_DECODE
    
    Use this option to decode a URL-encoded value.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    See Also:
    
    TextTransformation
  - regexPatternSetId
```
public final String regexPatternSetId()
```
    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).
    
    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
    
    Returns:
    
    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).
    
    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
  - toBuilder
```
public RegexMatchTuple.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegexMatchTuple.Builder,RegexMatchTuple>
  - builder
```
public static RegexMatchTuple.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegexMatchTuple.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 RegexMatchTuple

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

fieldToMatch

textTransformation

textTransformationAsString

regexPatternSetId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields