JsonBody (AWS Java SDK for AWS WAFV2 1.11.970 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JsonBody
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The body of a web request, inspected as JSON. The body immediately follows the request headers. This is used in the FieldToMatch specification.

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON that result from the matches that you indicate.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JsonBody()

Constructors
Constructor and Description
`JsonBody()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsonBody`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getInvalidFallbackBehavior()` The inspection behavior to fall back to if the JSON in the request body is invalid.
`JsonMatchPattern`	`getMatchPattern()` The patterns to look for in the JSON body.
`String`	`getMatchScope()` The parts of the JSON to match against using the `MatchPattern`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setInvalidFallbackBehavior(String invalidFallbackBehavior)` The inspection behavior to fall back to if the JSON in the request body is invalid.
`void`	`setMatchPattern(JsonMatchPattern matchPattern)` The patterns to look for in the JSON body.
`void`	`setMatchScope(String matchScope)` The parts of the JSON to match against using the `MatchPattern`.
`String`	`toString()` Returns a string representation of this object.
`JsonBody`	`withInvalidFallbackBehavior(BodyParsingFallbackBehavior invalidFallbackBehavior)` The inspection behavior to fall back to if the JSON in the request body is invalid.
`JsonBody`	`withInvalidFallbackBehavior(String invalidFallbackBehavior)` The inspection behavior to fall back to if the JSON in the request body is invalid.
`JsonBody`	`withMatchPattern(JsonMatchPattern matchPattern)` The patterns to look for in the JSON body.
`JsonBody`	`withMatchScope(JsonMatchScope matchScope)` The parts of the JSON to match against using the `MatchPattern`.
`JsonBody`	`withMatchScope(String matchScope)` The parts of the JSON to match against using the `MatchPattern`.

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

- Constructor Detail
  - JsonBody
```
public JsonBody()
```
- Method Detail
  - setMatchPattern
```
public void setMatchPattern(JsonMatchPattern matchPattern)
```
    The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
    
    Parameters:
    
    matchPattern - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
  - getMatchPattern
```
public JsonMatchPattern getMatchPattern()
```
    The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
    
    Returns:
    
    The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
  - withMatchPattern
```
public JsonBody withMatchPattern(JsonMatchPattern matchPattern)
```
    The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
    
    Parameters:
    
    matchPattern - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMatchScope
```
public void setMatchScope(String matchScope)
```
    The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    Parameters:
    
    matchScope - The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    See Also:
    
    JsonMatchScope
  - getMatchScope
```
public String getMatchScope()
```
    The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    Returns:
    
    The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    See Also:
    
    JsonMatchScope
  - withMatchScope
```
public JsonBody withMatchScope(String matchScope)
```
    The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    Parameters:
    
    matchScope - The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JsonMatchScope
  - withMatchScope
```
public JsonBody withMatchScope(JsonMatchScope matchScope)
```
    The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    Parameters:
    
    matchScope - The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JsonMatchScope
  - setInvalidFallbackBehavior
```
public void setInvalidFallbackBehavior(String invalidFallbackBehavior)
```
    The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    - MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    - EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    Parameters:
    invalidFallbackBehavior - The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    
    MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    
    EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    See Also:
    
    BodyParsingFallbackBehavior
  - getInvalidFallbackBehavior
```
public String getInvalidFallbackBehavior()
```
    The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    - MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    - EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    Returns:
    The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    
    MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    
    EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    See Also:
    
    BodyParsingFallbackBehavior
  - withInvalidFallbackBehavior
```
public JsonBody withInvalidFallbackBehavior(String invalidFallbackBehavior)
```
    The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    - MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    - EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    Parameters:
    invalidFallbackBehavior - The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    
    MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    
    EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BodyParsingFallbackBehavior
  - withInvalidFallbackBehavior
```
public JsonBody withInvalidFallbackBehavior(BodyParsingFallbackBehavior invalidFallbackBehavior)
```
    The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    - MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    - EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    Parameters:
    invalidFallbackBehavior - The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content.
    
    You can specify the following fallback behaviors:
    
    MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    
    EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
    
    If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BodyParsingFallbackBehavior
  - 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 JsonBody clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class JsonBody

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JsonBody

Method Detail

setMatchPattern

getMatchPattern

withMatchPattern

setMatchScope

getMatchScope

withMatchScope

withMatchScope

setInvalidFallbackBehavior

getInvalidFallbackBehavior

withInvalidFallbackBehavior

withInvalidFallbackBehavior

toString

equals

hashCode

clone

marshall