ResponseInspectionHeader (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResponseInspectionHeader
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Configures inspection of the response header. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ResponseInspectionHeader()

Constructors
Constructor and Description
`ResponseInspectionHeader()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResponseInspectionHeader`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getFailureValues()` Values in the response header with the specified name that indicate a failed login or account creation attempt.
`String`	`getName()` The name of the header to match against.
`List<String>`	`getSuccessValues()` Values in the response header with the specified name that indicate a successful login or account creation attempt.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFailureValues(Collection<String> failureValues)` Values in the response header with the specified name that indicate a failed login or account creation attempt.
`void`	`setName(String name)` The name of the header to match against.
`void`	`setSuccessValues(Collection<String> successValues)` Values in the response header with the specified name that indicate a successful login or account creation attempt.
`String`	`toString()` Returns a string representation of this object.
`ResponseInspectionHeader`	`withFailureValues(Collection<String> failureValues)` Values in the response header with the specified name that indicate a failed login or account creation attempt.
`ResponseInspectionHeader`	`withFailureValues(String... failureValues)` Values in the response header with the specified name that indicate a failed login or account creation attempt.
`ResponseInspectionHeader`	`withName(String name)` The name of the header to match against.
`ResponseInspectionHeader`	`withSuccessValues(Collection<String> successValues)` Values in the response header with the specified name that indicate a successful login or account creation attempt.
`ResponseInspectionHeader`	`withSuccessValues(String... successValues)` Values in the response header with the specified name that indicate a successful login or account creation attempt.

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

- Constructor Detail
  - ResponseInspectionHeader
```
public ResponseInspectionHeader()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "RequestResult" ]
    
    Parameters:
    
    name - The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "RequestResult" ]
  - getName
```
public String getName()
```
    The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "RequestResult" ]
    
    Returns:
    
    The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "RequestResult" ]
  - withName
```
public ResponseInspectionHeader withName(String name)
```
    The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "RequestResult" ]
    
    Parameters:
    
    name - The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "RequestResult" ]
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSuccessValues
```
public List<String> getSuccessValues()
```
    Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
    
    Returns:
    
    Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
  - setSuccessValues
```
public void setSuccessValues(Collection<String> successValues)
```
    Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
    
    Parameters:
    
    successValues - Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
  - withSuccessValues
```
public ResponseInspectionHeader withSuccessValues(String... successValues)
```
    Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
    
    NOTE: This method appends the values to the existing list (if any). Use setSuccessValues(java.util.Collection) or withSuccessValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    successValues - Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSuccessValues
```
public ResponseInspectionHeader withSuccessValues(Collection<String> successValues)
```
    Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
    
    Parameters:
    
    successValues - Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFailureValues
```
public List<String> getFailureValues()
```
    Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
    
    Returns:
    
    Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
  - setFailureValues
```
public void setFailureValues(Collection<String> failureValues)
```
    Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
    
    Parameters:
    
    failureValues - Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
  - withFailureValues
```
public ResponseInspectionHeader withFailureValues(String... failureValues)
```
    Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
    
    NOTE: This method appends the values to the existing list (if any). Use setFailureValues(java.util.Collection) or withFailureValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    failureValues - Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFailureValues
```
public ResponseInspectionHeader withFailureValues(Collection<String> failureValues)
```
    Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
    
    Parameters:
    
    failureValues - Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]
    
    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 ResponseInspectionHeader 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.793

Class ResponseInspectionHeader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResponseInspectionHeader

Method Detail

setName

getName

withName

getSuccessValues

setSuccessValues

withSuccessValues

withSuccessValues

getFailureValues

setFailureValues

withFailureValues

withFailureValues

toString

equals

hashCode

clone

marshall