ResponseInspectionHeader (AWS Java SDK for AWS WAFV2 1.12.433 API)

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.

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 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 attempt.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setFailureValues(Collection<String> failureValues)` Values in the response header with the specified name that indicate a failed login 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 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 attempt.
`ResponseInspectionHeader`	`withFailureValues(String... failureValues)` Values in the response header with the specified name that indicate a failed login 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 attempt.
`ResponseInspectionHeader`	`withSuccessValues(String... successValues)` Values in the response header with the specified name that indicate a successful login attempt.

Methods inherited from class java.lang.Object
finalize, 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": [ "LoginResult" ]
    
    Parameters:
    
    name - The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "LoginResult" ]
  - getName
```
public String getName()
```
    The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "LoginResult" ]
    
    Returns:
    
    The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "LoginResult" ]
  - 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": [ "LoginResult" ]
    
    Parameters:
    
    name - The name of the header to match against. The name must be an exact match, including case.
    
    JSON example: "Name": [ "LoginResult" ]
    
    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 attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
    
    Returns:
    
    Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
  - setSuccessValues
```
public void setSuccessValues(Collection<String> successValues)
```
    Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
    
    Parameters:
    
    successValues - Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
  - withSuccessValues
```
public ResponseInspectionHeader withSuccessValues(String... successValues)
```
    Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
    
    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 attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
    
    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 attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
    
    Parameters:
    
    successValues - Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ]
    
    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 attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
    
    Returns:
    
    Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
  - setFailureValues
```
public void setFailureValues(Collection<String> failureValues)
```
    Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
    
    Parameters:
    
    failureValues - Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
  - withFailureValues
```
public ResponseInspectionHeader withFailureValues(String... failureValues)
```
    Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
    
    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 attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
    
    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 attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
    
    Parameters:
    
    failureValues - Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
    
    JSON example: "FailureValues": [ "LoginFailed", "Failed login" ]
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

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