Class ResponseInspectionHeader
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ResponseInspectionHeader.Builder,
ResponseInspectionHeader>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Values in the response header with the specified name that indicate a failed login or account creation attempt.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FailureValues property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SuccessValues property.final String
name()
The name of the header to match against.static Class
<? extends ResponseInspectionHeader.Builder> Values in the response header with the specified name that indicate a successful login or account creation attempt.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
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" ]
-
hasSuccessValues
public final boolean hasSuccessValues()For responses, this returns true if the service returned a value for the SuccessValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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" ]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSuccessValues()
method.- 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" ]
-
hasFailureValues
public final boolean hasFailureValues()For responses, this returns true if the service returned a value for the FailureValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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" ]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFailureValues()
method.- 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" ]
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ResponseInspectionHeader.Builder,
ResponseInspectionHeader> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-