Class StartVerificationResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartVerificationResponse.Builder,StartVerificationResponse>

@Generated("software.amazon.awssdk:codegen") public final class StartVerificationResponse extends PartnerCentralAccountResponse implements ToCopyableBuilder<StartVerificationResponse.Builder,StartVerificationResponse>
  • Method Details

    • verificationType

      public final VerificationType verificationType()

      The type of verification that was started based on the provided verification details.

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

      Returns:
      The type of verification that was started based on the provided verification details.
      See Also:
    • verificationTypeAsString

      public final String verificationTypeAsString()

      The type of verification that was started based on the provided verification details.

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

      Returns:
      The type of verification that was started based on the provided verification details.
      See Also:
    • verificationStatus

      public final VerificationStatus verificationStatus()

      The initial status of the verification process after it has been started. Typically this will be pending or in-progress.

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

      Returns:
      The initial status of the verification process after it has been started. Typically this will be pending or in-progress.
      See Also:
    • verificationStatusAsString

      public final String verificationStatusAsString()

      The initial status of the verification process after it has been started. Typically this will be pending or in-progress.

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

      Returns:
      The initial status of the verification process after it has been started. Typically this will be pending or in-progress.
      See Also:
    • verificationStatusReason

      public final String verificationStatusReason()

      Additional information about the initial verification status, including any immediate feedback about the submitted verification details.

      Returns:
      Additional information about the initial verification status, including any immediate feedback about the submitted verification details.
    • verificationResponseDetails

      public final VerificationResponseDetails verificationResponseDetails()

      Initial response details specific to the type of verification started, which may include next steps or additional requirements.

      Returns:
      Initial response details specific to the type of verification started, which may include next steps or additional requirements.
    • startedAt

      public final Instant startedAt()

      The timestamp when the verification process was successfully initiated.

      Returns:
      The timestamp when the verification process was successfully initiated.
    • completedAt

      public final Instant completedAt()

      The timestamp when the verification process was completed. This field is typically null for newly started verifications unless they complete immediately.

      Returns:
      The timestamp when the verification process was completed. This field is typically null for newly started verifications unless they complete immediately.
    • 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<StartVerificationResponse.Builder,StartVerificationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static StartVerificationResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends StartVerificationResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.