SizeConstraintStatement (AWS Java SDK for AWS WAFV2 1.12.544 API)

java.lang.Object
- com.amazonaws.services.wafv2.model.SizeConstraintStatement

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SizeConstraintStatement
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 kilobytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SizeConstraintStatement()

Constructors
Constructor and Description
`SizeConstraintStatement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SizeConstraintStatement`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getComparisonOperator()` The operator to use to compare the request part to the size setting.
`FieldToMatch`	`getFieldToMatch()` The part of the web request that you want WAF to inspect.
`Long`	`getSize()` The size, in byte, to compare to the request part, after any transformations.
`List<TextTransformation>`	`getTextTransformations()` Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setComparisonOperator(String comparisonOperator)` The operator to use to compare the request part to the size setting.
`void`	`setFieldToMatch(FieldToMatch fieldToMatch)` The part of the web request that you want WAF to inspect.
`void`	`setSize(Long size)` The size, in byte, to compare to the request part, after any transformations.
`void`	`setTextTransformations(Collection<TextTransformation> textTransformations)` Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
`String`	`toString()` Returns a string representation of this object.
`SizeConstraintStatement`	`withComparisonOperator(ComparisonOperator comparisonOperator)` The operator to use to compare the request part to the size setting.
`SizeConstraintStatement`	`withComparisonOperator(String comparisonOperator)` The operator to use to compare the request part to the size setting.
`SizeConstraintStatement`	`withFieldToMatch(FieldToMatch fieldToMatch)` The part of the web request that you want WAF to inspect.
`SizeConstraintStatement`	`withSize(Long size)` The size, in byte, to compare to the request part, after any transformations.
`SizeConstraintStatement`	`withTextTransformations(Collection<TextTransformation> textTransformations)` Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
`SizeConstraintStatement`	`withTextTransformations(TextTransformation... textTransformations)` Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

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

- Constructor Detail
  - SizeConstraintStatement
```
public SizeConstraintStatement()
```
- Method Detail
  - setFieldToMatch
```
public void setFieldToMatch(FieldToMatch fieldToMatch)
```
    The part of the web request that you want WAF to inspect.
    
    Parameters:
    
    fieldToMatch - The part of the web request that you want WAF to inspect.
  - getFieldToMatch
```
public FieldToMatch getFieldToMatch()
```
    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.
  - withFieldToMatch
```
public SizeConstraintStatement withFieldToMatch(FieldToMatch fieldToMatch)
```
    The part of the web request that you want WAF to inspect.
    
    Parameters:
    
    fieldToMatch - The part of the web request that you want WAF to inspect.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComparisonOperator
```
public void setComparisonOperator(String comparisonOperator)
```
    The operator to use to compare the request part to the size setting.
    
    Parameters:
    
    comparisonOperator - The operator to use to compare the request part to the size setting.
    
    See Also:
    
    ComparisonOperator
  - getComparisonOperator
```
public String getComparisonOperator()
```
    The operator to use to compare the request part to the size setting.
    
    Returns:
    
    The operator to use to compare the request part to the size setting.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public SizeConstraintStatement withComparisonOperator(String comparisonOperator)
```
    The operator to use to compare the request part to the size setting.
    
    Parameters:
    
    comparisonOperator - The operator to use to compare the request part to the size setting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public SizeConstraintStatement withComparisonOperator(ComparisonOperator comparisonOperator)
```
    The operator to use to compare the request part to the size setting.
    
    Parameters:
    
    comparisonOperator - The operator to use to compare the request part to the size setting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - setSize
```
public void setSize(Long size)
```
    The size, in byte, to compare to the request part, after any transformations.
    
    Parameters:
    
    size - The size, in byte, to compare to the request part, after any transformations.
  - getSize
```
public Long getSize()
```
    The size, in byte, to compare to the request part, after any transformations.
    
    Returns:
    
    The size, in byte, to compare to the request part, after any transformations.
  - withSize
```
public SizeConstraintStatement withSize(Long size)
```
    The size, in byte, to compare to the request part, after any transformations.
    
    Parameters:
    
    size - The size, in byte, to compare to the request part, after any transformations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTextTransformations
```
public List<TextTransformation> getTextTransformations()
```
    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 component contents.
    
    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 component contents.
  - setTextTransformations
```
public void setTextTransformations(Collection<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 component contents.
    
    Parameters:
    
    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 component contents.
  - withTextTransformations
```
public SizeConstraintStatement withTextTransformations(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 component contents.
    
    NOTE: This method appends the values to the existing list (if any). Use setTextTransformations(java.util.Collection) or withTextTransformations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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 component contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTextTransformations
```
public SizeConstraintStatement withTextTransformations(Collection<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 component contents.
    
    Parameters:
    
    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 component contents.
    
    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 SizeConstraintStatement clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SizeConstraintStatement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SizeConstraintStatement

Method Detail

setFieldToMatch

getFieldToMatch

withFieldToMatch

setComparisonOperator

getComparisonOperator

withComparisonOperator

withComparisonOperator

setSize

getSize

withSize

getTextTransformations

setTextTransformations

withTextTransformations

withTextTransformations

toString

equals

hashCode

clone

marshall