FieldToMatch (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FieldToMatch
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The part of a web request that you want AWS WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FieldToMatch()

Constructors
Constructor and Description
`FieldToMatch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldToMatch`	`clone()`
`boolean`	`equals(Object obj)`
`AllQueryArguments`	`getAllQueryArguments()` Inspect all query arguments.
`Body`	`getBody()` Inspect the request body as plain text.
`JsonBody`	`getJsonBody()` Inspect the request body as JSON.
`Method`	`getMethod()` Inspect the HTTP method.
`QueryString`	`getQueryString()` Inspect the query string.
`SingleHeader`	`getSingleHeader()` Inspect a single header.
`SingleQueryArgument`	`getSingleQueryArgument()` Inspect a single query argument.
`UriPath`	`getUriPath()` Inspect the request URI path.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllQueryArguments(AllQueryArguments allQueryArguments)` Inspect all query arguments.
`void`	`setBody(Body body)` Inspect the request body as plain text.
`void`	`setJsonBody(JsonBody jsonBody)` Inspect the request body as JSON.
`void`	`setMethod(Method method)` Inspect the HTTP method.
`void`	`setQueryString(QueryString queryString)` Inspect the query string.
`void`	`setSingleHeader(SingleHeader singleHeader)` Inspect a single header.
`void`	`setSingleQueryArgument(SingleQueryArgument singleQueryArgument)` Inspect a single query argument.
`void`	`setUriPath(UriPath uriPath)` Inspect the request URI path.
`String`	`toString()` Returns a string representation of this object.
`FieldToMatch`	`withAllQueryArguments(AllQueryArguments allQueryArguments)` Inspect all query arguments.
`FieldToMatch`	`withBody(Body body)` Inspect the request body as plain text.
`FieldToMatch`	`withJsonBody(JsonBody jsonBody)` Inspect the request body as JSON.
`FieldToMatch`	`withMethod(Method method)` Inspect the HTTP method.
`FieldToMatch`	`withQueryString(QueryString queryString)` Inspect the query string.
`FieldToMatch`	`withSingleHeader(SingleHeader singleHeader)` Inspect a single header.
`FieldToMatch`	`withSingleQueryArgument(SingleQueryArgument singleQueryArgument)` Inspect a single query argument.
`FieldToMatch`	`withUriPath(UriPath uriPath)` Inspect the request URI path.

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

- Constructor Detail
  - FieldToMatch
```
public FieldToMatch()
```
- Method Detail
  - setSingleHeader
```
public void setSingleHeader(SingleHeader singleHeader)
```
    Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
    
    Example JSON: "SingleHeader": { "Name": "haystack" }
    
    Parameters:
    
    singleHeader - Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
    
    Example JSON: "SingleHeader": { "Name": "haystack" }
  - getSingleHeader
```
public SingleHeader getSingleHeader()
```
    Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
    
    Example JSON: "SingleHeader": { "Name": "haystack" }
    
    Returns:
    
    Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
    
    Example JSON: "SingleHeader": { "Name": "haystack" }
  - withSingleHeader
```
public FieldToMatch withSingleHeader(SingleHeader singleHeader)
```
    Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
    
    Example JSON: "SingleHeader": { "Name": "haystack" }
    
    Parameters:
    
    singleHeader - Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
    
    Example JSON: "SingleHeader": { "Name": "haystack" }
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSingleQueryArgument
```
public void setSingleQueryArgument(SingleQueryArgument singleQueryArgument)
```
    Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    
    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
    
    Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
    
    Parameters:
    
    singleQueryArgument - Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    
    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
    
    Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
  - getSingleQueryArgument
```
public SingleQueryArgument getSingleQueryArgument()
```
    Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    
    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
    
    Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
    
    Returns:
    
    Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    
    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
    
    Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
  - withSingleQueryArgument
```
public FieldToMatch withSingleQueryArgument(SingleQueryArgument singleQueryArgument)
```
    Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    
    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
    
    Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
    
    Parameters:
    
    singleQueryArgument - Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    
    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
    
    Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllQueryArguments
```
public void setAllQueryArguments(AllQueryArguments allQueryArguments)
```
    Inspect all query arguments.
    
    Parameters:
    
    allQueryArguments - Inspect all query arguments.
  - getAllQueryArguments
```
public AllQueryArguments getAllQueryArguments()
```
    Inspect all query arguments.
    
    Returns:
    
    Inspect all query arguments.
  - withAllQueryArguments
```
public FieldToMatch withAllQueryArguments(AllQueryArguments allQueryArguments)
```
    Inspect all query arguments.
    
    Parameters:
    
    allQueryArguments - Inspect all query arguments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUriPath
```
public void setUriPath(UriPath uriPath)
```
    Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    
    Parameters:
    
    uriPath - Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
  - getUriPath
```
public UriPath getUriPath()
```
    Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    
    Returns:
    
    Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
  - withUriPath
```
public FieldToMatch withUriPath(UriPath uriPath)
```
    Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    
    Parameters:
    
    uriPath - Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryString
```
public void setQueryString(QueryString queryString)
```
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Parameters:
    
    queryString - Inspect the query string. This is the part of a URL that appears after a ? character, if any.
  - getQueryString
```
public QueryString getQueryString()
```
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Returns:
    
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
  - withQueryString
```
public FieldToMatch withQueryString(QueryString queryString)
```
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Parameters:
    
    queryString - Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBody
```
public void setBody(Body body)
```
    Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    Parameters:
    
    body - Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
  - getBody
```
public Body getBody()
```
    Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    Returns:
    
    Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
  - withBody
```
public FieldToMatch withBody(Body body)
```
    Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    Parameters:
    
    body - Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMethod
```
public void setMethod(Method method)
```
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Parameters:
    
    method - Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
  - getMethod
```
public Method getMethod()
```
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Returns:
    
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
  - withMethod
```
public FieldToMatch withMethod(Method method)
```
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Parameters:
    
    method - Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJsonBody
```
public void setJsonBody(JsonBody jsonBody)
```
    Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    Parameters:
    
    jsonBody - Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
  - getJsonBody
```
public JsonBody getJsonBody()
```
    Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    Returns:
    
    Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
  - withJsonBody
```
public FieldToMatch withJsonBody(JsonBody jsonBody)
```
    Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    Parameters:
    
    jsonBody - Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
    
    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
    
    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 FieldToMatch clone()
```
    Overrides:
    
    clone 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.

Did this page help you?

Class FieldToMatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldToMatch

Method Detail

setSingleHeader

getSingleHeader

withSingleHeader

setSingleQueryArgument

getSingleQueryArgument

withSingleQueryArgument

setAllQueryArguments

getAllQueryArguments

withAllQueryArguments

setUriPath

getUriPath

withUriPath

setQueryString

getQueryString

withQueryString

setBody

getBody

withBody

setMethod

getMethod

withMethod

setJsonBody

getJsonBody

withJsonBody

toString

equals

hashCode

clone

marshall