com.amazonaws.services.cognitoidp.model

Class VerifySoftwareTokenRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.VerifySoftwareTokenRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VerifySoftwareTokenRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
VerifySoftwareTokenRequest()

Method Summary

Modifier and Type	Method and Description
VerifySoftwareTokenRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccessToken() A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
String	getFriendlyDeviceName() The friendly device name.
String	getSession() The session that should be passed both ways in challenge-response calls to the service.
String	getUserCode() The one- time password computed using the secret code returned by AssociateSoftwareToken.
int	hashCode()
void	setAccessToken(String accessToken) A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
void	setFriendlyDeviceName(String friendlyDeviceName) The friendly device name.
void	setSession(String session) The session that should be passed both ways in challenge-response calls to the service.
void	setUserCode(String userCode) The one- time password computed using the secret code returned by AssociateSoftwareToken.
String	toString() Returns a string representation of this object.
VerifySoftwareTokenRequest	withAccessToken(String accessToken) A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
VerifySoftwareTokenRequest	withFriendlyDeviceName(String friendlyDeviceName) The friendly device name.
VerifySoftwareTokenRequest	withSession(String session) The session that should be passed both ways in challenge-response calls to the service.
VerifySoftwareTokenRequest	withUserCode(String userCode) The one- time password computed using the secret code returned by AssociateSoftwareToken.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VerifySoftwareTokenRequest

public VerifySoftwareTokenRequest()

Method Detail

setAccessToken

public void setAccessToken(String accessToken)

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

Parameters:

accessToken - A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

getAccessToken

public String getAccessToken()

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

Returns:

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

withAccessToken

public VerifySoftwareTokenRequest withAccessToken(String accessToken)

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

Parameters:

accessToken - A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSession

public void setSession(String session)

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

Parameters:

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

getSession

public String getSession()

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

Returns:

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

withSession

public VerifySoftwareTokenRequest withSession(String session)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserCode

public void setUserCode(String userCode)

The one- time password computed using the secret code returned by AssociateSoftwareToken.

Parameters:

userCode - The one- time password computed using the secret code returned by AssociateSoftwareToken.

getUserCode

public String getUserCode()

The one- time password computed using the secret code returned by AssociateSoftwareToken.

Returns:

The one- time password computed using the secret code returned by AssociateSoftwareToken.

withUserCode

public VerifySoftwareTokenRequest withUserCode(String userCode)

The one- time password computed using the secret code returned by AssociateSoftwareToken.

Parameters:

userCode - The one- time password computed using the secret code returned by AssociateSoftwareToken.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFriendlyDeviceName

public void setFriendlyDeviceName(String friendlyDeviceName)

The friendly device name.

Parameters:

friendlyDeviceName - The friendly device name.

getFriendlyDeviceName

public String getFriendlyDeviceName()

The friendly device name.

Returns:

The friendly device name.

withFriendlyDeviceName

public VerifySoftwareTokenRequest withFriendlyDeviceName(String friendlyDeviceName)

The friendly device name.

Parameters:

friendlyDeviceName - The friendly device name.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public VerifySoftwareTokenRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()