public class ConfirmSignUpRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the request to confirm registration of a user.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
clientId
The ID of the client associated with the user pool.
|
private java.lang.String |
confirmationCode
The confirmation code sent by a user's request to confirm registration.
|
private java.lang.Boolean |
forceAliasCreation
Boolean to be specified to force user confirmation irrespective of
existing alias.
|
private java.lang.String |
secretHash
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
|
private java.lang.String |
username
The user name of the user whose registration you wish to confirm.
|
NOOP
Constructor and Description |
---|
ConfirmSignUpRequest() |
Modifier and Type | Method and Description |
---|---|
ConfirmSignUpRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getClientId()
The ID of the client associated with the user pool.
|
java.lang.String |
getConfirmationCode()
The confirmation code sent by a user's request to confirm registration.
|
java.lang.Boolean |
getForceAliasCreation()
Boolean to be specified to force user confirmation irrespective of
existing alias.
|
java.lang.String |
getSecretHash()
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
|
java.lang.String |
getUsername()
The user name of the user whose registration you wish to confirm.
|
int |
hashCode() |
java.lang.Boolean |
isForceAliasCreation()
Boolean to be specified to force user confirmation irrespective of
existing alias.
|
void |
setClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
void |
setConfirmationCode(java.lang.String confirmationCode)
The confirmation code sent by a user's request to confirm registration.
|
void |
setForceAliasCreation(java.lang.Boolean forceAliasCreation)
Boolean to be specified to force user confirmation irrespective of
existing alias.
|
void |
setSecretHash(java.lang.String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
|
void |
setUsername(java.lang.String username)
The user name of the user whose registration you wish to confirm.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ConfirmSignUpRequest |
withClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
ConfirmSignUpRequest |
withConfirmationCode(java.lang.String confirmationCode)
The confirmation code sent by a user's request to confirm registration.
|
ConfirmSignUpRequest |
withForceAliasCreation(java.lang.Boolean forceAliasCreation)
Boolean to be specified to force user confirmation irrespective of
existing alias.
|
ConfirmSignUpRequest |
withSecretHash(java.lang.String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
|
ConfirmSignUpRequest |
withUsername(java.lang.String username)
The user name of the user whose registration you wish to confirm.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String clientId
The ID of the client associated with the user pool.
private java.lang.String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
private java.lang.String username
The user name of the user whose registration you wish to confirm.
private java.lang.String confirmationCode
The confirmation code sent by a user's request to confirm registration.
private java.lang.Boolean forceAliasCreation
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
public void setClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.public java.lang.String getClientId()
The ID of the client associated with the user pool.
public ConfirmSignUpRequest withClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.public void setSecretHash(java.lang.String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
secretHash
- A keyed-hash message authentication code (HMAC) calculated using
the secret key of a user pool client and username plus the client
ID in the message.public java.lang.String getSecretHash()
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
public ConfirmSignUpRequest withSecretHash(java.lang.String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
secretHash
- A keyed-hash message authentication code (HMAC) calculated using
the secret key of a user pool client and username plus the client
ID in the message.public void setUsername(java.lang.String username)
The user name of the user whose registration you wish to confirm.
username
- The user name of the user whose registration you wish to confirm.public java.lang.String getUsername()
The user name of the user whose registration you wish to confirm.
public ConfirmSignUpRequest withUsername(java.lang.String username)
The user name of the user whose registration you wish to confirm.
username
- The user name of the user whose registration you wish to confirm.public void setConfirmationCode(java.lang.String confirmationCode)
The confirmation code sent by a user's request to confirm registration.
confirmationCode
- The confirmation code sent by a user's request to confirm
registration.public java.lang.String getConfirmationCode()
The confirmation code sent by a user's request to confirm registration.
public ConfirmSignUpRequest withConfirmationCode(java.lang.String confirmationCode)
The confirmation code sent by a user's request to confirm registration.
confirmationCode
- The confirmation code sent by a user's request to confirm
registration.public void setForceAliasCreation(java.lang.Boolean forceAliasCreation)
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
forceAliasCreation
- Boolean to be specified to force user confirmation irrespective of
existing alias. By default set to False. If this parameter is set
to True and the phone number/email used for sign up confirmation
already exists as an alias with a different user, the API call
will migrate the alias from the previous user to the newly created
user being confirmed. If set to False, the API will throw an
AliasExistsException error.public java.lang.Boolean getForceAliasCreation()
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
public ConfirmSignUpRequest withForceAliasCreation(java.lang.Boolean forceAliasCreation)
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
forceAliasCreation
- Boolean to be specified to force user confirmation irrespective of
existing alias. By default set to False. If this parameter is set
to True and the phone number/email used for sign up confirmation
already exists as an alias with a different user, the API call
will migrate the alias from the previous user to the newly created
user being confirmed. If set to False, the API will throw an
AliasExistsException error.public java.lang.Boolean isForceAliasCreation()
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ConfirmSignUpRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()