Package software.amazon.awssdk.services.wafv2.model

Class ResponseInspectionHeader

java.lang.Object

software.amazon.awssdk.services.wafv2.model.ResponseInspectionHeader

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResponseInspectionHeader.Builder,ResponseInspectionHeader>

@Generated("software.amazon.awssdk:codegen")
public final class ResponseInspectionHeader
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResponseInspectionHeader.Builder

Method Summary

Modifier and Type	Method	Description
static ResponseInspectionHeader.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	failureValues()	Values in the response header with the specified name that indicate a failed login or account creation attempt.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailureValues()	For responses, this returns true if the service returned a value for the FailureValues property.
int	hashCode()
boolean	hasSuccessValues()	For responses, this returns true if the service returned a value for the SuccessValues property.
String	name()	The name of the header to match against.
List<SdkField<?>>	sdkFields()
static Class<? extends ResponseInspectionHeader.Builder>	serializableBuilderClass()
List<String>	successValues()	Values in the response header with the specified name that indicate a successful login or account creation attempt.
ResponseInspectionHeader.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String 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 the isEmpty() 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

public final List<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" ]

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 the isEmpty() 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

public final List<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" ]

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

public ResponseInspectionHeader.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResponseInspectionHeader.Builder,ResponseInspectionHeader>

builder

public static ResponseInspectionHeader.Builder builder()

serializableBuilderClass

public static Class<? extends ResponseInspectionHeader.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo