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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public CaptchaResponse.Builder 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 interface ToCopyableBuilder<CaptchaResponse.Builder,CaptchaResponse>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.