software.amazon.awssdk.services.cognitoidentityprovider.model

Class VerifySoftwareTokenResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.VerifySoftwareTokenResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<VerifySoftwareTokenResponse.Builder,VerifySoftwareTokenResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class VerifySoftwareTokenResponse
extends CognitoIdentityProviderResponse
implements ToCopyableBuilder<VerifySoftwareTokenResponse.Builder,VerifySoftwareTokenResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VerifySoftwareTokenResponse.Builder

Method Summary

Modifier and Type	Method and Description
static VerifySoftwareTokenResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends VerifySoftwareTokenResponse.Builder>	serializableBuilderClass()
String	session() The session which should be passed both ways in challenge-response calls to the service.
VerifySoftwareTokenResponseType	status() The status of the verify software token.
String	statusAsString() The status of the verify software token.
VerifySoftwareTokenResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

status

public final VerifySoftwareTokenResponseType status()

The status of the verify software token.

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

Returns:

The status of the verify software token.

See Also:

VerifySoftwareTokenResponseType

statusAsString

public final String statusAsString()

The status of the verify software token.

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

Returns:

The status of the verify software token.

See Also:

VerifySoftwareTokenResponseType

session

public final String session()

The session which should be passed both ways in challenge-response calls to the service.

Returns:

The session which should be passed both ways in challenge-response calls to the service.

toBuilder

public VerifySoftwareTokenResponse.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<VerifySoftwareTokenResponse.Builder,VerifySoftwareTokenResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static VerifySoftwareTokenResponse.Builder builder()

serializableBuilderClass

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