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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SizeConstraint.Builder,SizeConstraint>
```
@Generated("software.amazon.awssdk:codegen")
public final class SizeConstraint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SizeConstraint.Builder,SizeConstraint>
```
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.

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of " Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SizeConstraint.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SizeConstraint.Builder`	`builder()`
`ComparisonOperator`	`comparisonOperator()`	The type of comparison you want AWS WAF to perform.
`String`	`comparisonOperatorAsString()`	The type of comparison you want AWS WAF to perform.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FieldToMatch`	`fieldToMatch()`	Specifies where in a web request to look for the size constraint.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SizeConstraint.Builder>`	`serializableBuilderClass()`
`Long`	`size()`	The size in bytes that you want AWS WAF to compare against the size of the specified `FieldToMatch`.
`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.
`SizeConstraint.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 size constraint.
    
    Returns:
    
    Specifies where in a web request to look for the size constraint.
  - 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 FieldToMatch before inspecting it for a match.
    
    You can only specify a single type of TextTransformation.
    
    Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system command line 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.
    
    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 FieldToMatch before inspecting it for a match.
    
    You can only specify a single type of TextTransformation.
    
    Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system command line 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.
    
    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 FieldToMatch before inspecting it for a match.
    
    You can only specify a single type of TextTransformation.
    
    Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system command line 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.
    
    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 FieldToMatch before inspecting it for a match.
    
    You can only specify a single type of TextTransformation.
    
    Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.
    
    NONE
    
    Specify NONE if you don't want to perform any text transformations.
    
    CMD_LINE
    
    When you're concerned that attackers are injecting an operating system command line 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.
    
    See Also:
    
    TextTransformation
  - comparisonOperator
```
public final ComparisonOperator comparisonOperator()
```
    The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
    
    EQ: Used to test if the Size is equal to the size of the FieldToMatch
    
    NE: Used to test if the Size is not equal to the size of the FieldToMatch
    
    LE: Used to test if the Size is less than or equal to the size of the FieldToMatch
    
    LT: Used to test if the Size is strictly less than the size of the FieldToMatch
    
    GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch
    
    GT: Used to test if the Size is strictly greater than the size of the FieldToMatch
    
    If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().
    
    Returns:
    
    The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
    
    EQ: Used to test if the Size is equal to the size of the FieldToMatch
    
    NE: Used to test if the Size is not equal to the size of the FieldToMatch
    
    LE: Used to test if the Size is less than or equal to the size of the FieldToMatch
    
    LT: Used to test if the Size is strictly less than the size of the FieldToMatch
    
    GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch
    
    GT: Used to test if the Size is strictly greater than the size of the FieldToMatch
    
    See Also:
    
    ComparisonOperator
  - comparisonOperatorAsString
```
public final String comparisonOperatorAsString()
```
    The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
    
    EQ: Used to test if the Size is equal to the size of the FieldToMatch
    
    NE: Used to test if the Size is not equal to the size of the FieldToMatch
    
    LE: Used to test if the Size is less than or equal to the size of the FieldToMatch
    
    LT: Used to test if the Size is strictly less than the size of the FieldToMatch
    
    GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch
    
    GT: Used to test if the Size is strictly greater than the size of the FieldToMatch
    
    If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().
    
    Returns:
    
    The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
    
    EQ: Used to test if the Size is equal to the size of the FieldToMatch
    
    NE: Used to test if the Size is not equal to the size of the FieldToMatch
    
    LE: Used to test if the Size is less than or equal to the size of the FieldToMatch
    
    LT: Used to test if the Size is strictly less than the size of the FieldToMatch
    
    GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch
    
    GT: Used to test if the Size is strictly greater than the size of the FieldToMatch
    
    See Also:
    
    ComparisonOperator
  - size
```
public final Long size()
```
    The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
    
    Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
    
    If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
    
    Returns:
    
    The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
    
    Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
    
    If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
  - toBuilder
```
public SizeConstraint.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SizeConstraint.Builder,SizeConstraint>
  - builder
```
public static SizeConstraint.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SizeConstraint.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 SizeConstraint

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

comparisonOperator

comparisonOperatorAsString

size

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields