SizeConstraint (AWS SDK for Java

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

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SizeConstraint.Builder

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()`
`String`	`comparisonOperator()`	The type of comparison you want AWS WAF to perform.
`boolean`	`equals(Object obj)`
`FieldToMatch`	`fieldToMatch()`	Specifies where in a web request to look for the size constraint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`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`.
`String`	`textTransformation()`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.
`SizeConstraint.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

- Method Detail
  - fieldToMatch
```
public 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 String 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 a request for a match.
    
    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.
    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 a request for a match.
    
    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 String 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
    
    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 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SizeConstraint.Builder,SizeConstraint>
    
    Returns:
    
    a builder for type T
  - builder
```
public static SizeConstraint.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SizeConstraint.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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.

Class SizeConstraint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fieldToMatch

textTransformation

comparisonOperator

size

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall