Headers (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Headers
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead.

Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Headers()

Constructors
Constructor and Description
`Headers()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Headers`	`clone()`
`boolean`	`equals(Object obj)`
`HeaderMatchPattern`	`getMatchPattern()` The filter to use to identify the subset of headers to inspect in a web request.
`String`	`getMatchScope()` The parts of the headers to match with the rule inspection criteria.
`String`	`getOversizeHandling()` What WAF should do if the headers of the request are larger than WAF can inspect.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMatchPattern(HeaderMatchPattern matchPattern)` The filter to use to identify the subset of headers to inspect in a web request.
`void`	`setMatchScope(String matchScope)` The parts of the headers to match with the rule inspection criteria.
`void`	`setOversizeHandling(String oversizeHandling)` What WAF should do if the headers of the request are larger than WAF can inspect.
`String`	`toString()` Returns a string representation of this object.
`Headers`	`withMatchPattern(HeaderMatchPattern matchPattern)` The filter to use to identify the subset of headers to inspect in a web request.
`Headers`	`withMatchScope(MapMatchScope matchScope)` The parts of the headers to match with the rule inspection criteria.
`Headers`	`withMatchScope(String matchScope)` The parts of the headers to match with the rule inspection criteria.
`Headers`	`withOversizeHandling(OversizeHandling oversizeHandling)` What WAF should do if the headers of the request are larger than WAF can inspect.
`Headers`	`withOversizeHandling(String oversizeHandling)` What WAF should do if the headers of the request are larger than WAF can inspect.

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

- Constructor Detail
  - Headers
```
public Headers()
```
- Method Detail
  - setMatchPattern
```
public void setMatchPattern(HeaderMatchPattern matchPattern)
```
    The filter to use to identify the subset of headers to inspect in a web request.
    
    You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
    
    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
    
    Parameters:
    
    matchPattern - The filter to use to identify the subset of headers to inspect in a web request.
    
    You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
    
    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
  - getMatchPattern
```
public HeaderMatchPattern getMatchPattern()
```
    The filter to use to identify the subset of headers to inspect in a web request.
    
    You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
    
    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
    
    Returns:
    
    The filter to use to identify the subset of headers to inspect in a web request.
    
    You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
    
    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
  - withMatchPattern
```
public Headers withMatchPattern(HeaderMatchPattern matchPattern)
```
    The filter to use to identify the subset of headers to inspect in a web request.
    
    You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
    
    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
    
    Parameters:
    
    matchPattern - The filter to use to identify the subset of headers to inspect in a web request.
    
    You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.
    
    Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
    
    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 headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    Parameters:
    
    matchScope - The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    See Also:
    
    MapMatchScope
  - getMatchScope
```
public String getMatchScope()
```
    The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    Returns:
    
    The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    See Also:
    
    MapMatchScope
  - withMatchScope
```
public Headers withMatchScope(String matchScope)
```
    The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    Parameters:
    
    matchScope - The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MapMatchScope
  - withMatchScope
```
public Headers withMatchScope(MapMatchScope matchScope)
```
    The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    Parameters:
    
    matchScope - The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MapMatchScope
  - setOversizeHandling
```
public void setOversizeHandling(String oversizeHandling)
```
    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    - CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    - MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    Parameters:
    oversizeHandling - What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    
    CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    
    MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    See Also:
    
    OversizeHandling
  - getOversizeHandling
```
public String getOversizeHandling()
```
    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    - CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    - MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    Returns:
    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    
    CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    
    MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    See Also:
    
    OversizeHandling
  - withOversizeHandling
```
public Headers withOversizeHandling(String oversizeHandling)
```
    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    - CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    - MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    Parameters:
    oversizeHandling - What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    
    CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    
    MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OversizeHandling
  - withOversizeHandling
```
public Headers withOversizeHandling(OversizeHandling oversizeHandling)
```
    What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    - CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    - MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    - NO_MATCH - Treat the web request as not matching the rule statement.
    Parameters:
    oversizeHandling - What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
    
    The options for oversize handling are the following:
    
    CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
    
    MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
    
    NO_MATCH - Treat the web request as not matching the rule statement.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OversizeHandling
  - 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 Headers 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.

AWS SDK for Java 1.x API Reference - 1.12.476

Class Headers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Headers

Method Detail

setMatchPattern

getMatchPattern

withMatchPattern

setMatchScope

getMatchScope

withMatchScope

withMatchScope

setOversizeHandling

getOversizeHandling

withOversizeHandling

withOversizeHandling

toString

equals

hashCode

clone

marshall