Class SignUpRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to register a user.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The ID of the client associated with the user pool.The password of the user you wish to register.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.An array of name-value pairs representing user attributes.The user name of the user you wish to register.The validation data in the request to register a user.int
hashCode()
void
setClientId
(String clientId) The ID of the client associated with the user pool.void
setPassword
(String password) The password of the user you wish to register.void
setSecretHash
(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
setUserAttributes
(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.void
setUsername
(String username) The user name of the user you wish to register.void
setValidationData
(Collection<AttributeType> validationData) The validation data in the request to register a user.toString()
Returns a string representation of this object; useful for testing and debugging.withClientId
(String clientId) The ID of the client associated with the user pool.withPassword
(String password) The password of the user you wish to register.withSecretHash
(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.withUserAttributes
(AttributeType... userAttributes) An array of name-value pairs representing user attributes.withUserAttributes
(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.withUsername
(String username) The user name of the user you wish to register.withValidationData
(AttributeType... validationData) The validation data in the request to register a user.withValidationData
(Collection<AttributeType> validationData) The validation data in the request to register a user.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
Constructor Details
-
SignUpRequest
public SignUpRequest()
-
-
Method Details
-
setClientId
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.
-
getClientId
The ID of the client associated with the user pool.
- Returns:
- The ID of the client associated with the user pool.
-
withClientId
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSecretHash
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withSecretHash
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUsername
The user name of the user you wish to register.
- Parameters:
username
- The user name of the user you wish to register.
-
getUsername
The user name of the user you wish to register.
- Returns:
- The user name of the user you wish to register.
-
withUsername
The user name of the user you wish to register.
- Parameters:
username
- The user name of the user you wish to register.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPassword
The password of the user you wish to register.
- Parameters:
password
- The password of the user you wish to register.
-
getPassword
The password of the user you wish to register.
- Returns:
- The password of the user you wish to register.
-
withPassword
The password of the user you wish to register.
- Parameters:
password
- The password of the user you wish to register.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getUserAttributes
An array of name-value pairs representing user attributes.
- Returns:
- An array of name-value pairs representing user attributes.
-
setUserAttributes
An array of name-value pairs representing user attributes.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.
-
withUserAttributes
An array of name-value pairs representing user attributes.
NOTE: This method appends the values to the existing list (if any). Use
setUserAttributes(java.util.Collection)
orwithUserAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withUserAttributes
An array of name-value pairs representing user attributes.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getValidationData
The validation data in the request to register a user.
- Returns:
- The validation data in the request to register a user.
-
setValidationData
The validation data in the request to register a user.
- Parameters:
validationData
- The validation data in the request to register a user.
-
withValidationData
The validation data in the request to register a user.
NOTE: This method appends the values to the existing list (if any). Use
setValidationData(java.util.Collection)
orwithValidationData(java.util.Collection)
if you want to override the existing values.- Parameters:
validationData
- The validation data in the request to register a user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withValidationData
The validation data in the request to register a user.
- Parameters:
validationData
- The validation data in the request to register a user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-