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

Class CaptchaResponse

java.lang.Object

software.amazon.awssdk.services.wafv2.model.CaptchaResponse

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class CaptchaResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CaptchaResponse.Builder,CaptchaResponse>

The result from the inspection of the web request for a valid CAPTCHA token.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CaptchaResponse.Builder

Method Summary

Modifier and Type	Method	Description
static CaptchaResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FailureReason	failureReason()	The reason for failure, populated when the evaluation of the token fails.
String	failureReasonAsString()	The reason for failure, populated when the evaluation of the token fails.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	responseCode()	The HTTP response code indicating the status of the CAPTCHA token in the web request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CaptchaResponse.Builder>	serializableBuilderClass()
Long	solveTimestamp()	The time that the CAPTCHA was last solved for the supplied token.
CaptchaResponse.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

responseCode

public final Integer responseCode()

The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed.

Returns:

The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed.

solveTimestamp

public final Long solveTimestamp()

The time that the CAPTCHA was last solved for the supplied token.

Returns:

The time that the CAPTCHA was last solved for the supplied token.

failureReason

public final FailureReason failureReason()

The reason for failure, populated when the evaluation of the token fails.

If the service returns an enum value that is not available in the current SDK version, failureReason will return FailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureReasonAsString().

Returns:

The reason for failure, populated when the evaluation of the token fails.

See Also:

FailureReason

failureReasonAsString

public final String failureReasonAsString()

The reason for failure, populated when the evaluation of the token fails.

If the service returns an enum value that is not available in the current SDK version, failureReason will return FailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureReasonAsString().

Returns:

The reason for failure, populated when the evaluation of the token fails.

See Also:

FailureReason

toBuilder

public CaptchaResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CaptchaResponse.Builder,CaptchaResponse>

builder

public static CaptchaResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CaptchaResponse.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo