@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.
Constructor and Description |
---|
ResponseInspectionHeader() |
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.
|
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" ]
name
- The name of the header to match against. The name must be an exact match, including case.
JSON example: "Name": [ "RequestResult" ]
public String getName()
The name of the header to match against. The name must be an exact match, including case.
JSON example: "Name": [ "RequestResult" ]
JSON example: "Name": [ "RequestResult" ]
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" ]
name
- The name of the header to match against. The name must be an exact match, including case.
JSON example: "Name": [ "RequestResult" ]
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" ]
JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ]
and
"SuccessValues": [ "AccountCreated", "Successful account creation" ]
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" ]
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" ]
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.
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" ]
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" ]
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" ]
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" ]
JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ]
and
"FailureValues": [ "AccountCreationFailed" ]
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" ]
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" ]
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.
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" ]
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" ]
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" ]
public String toString()
toString
in class Object
Object.toString()
public ResponseInspectionHeader clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.