Class SignUpRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cognitoidp.model.SignUpRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class SignUpRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to register a user.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description SignUpRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SignUpRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getClientId()
The ID of the client associated with the user pool.String
getPassword()
The password of the user you wish to register.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.List<AttributeType>
getUserAttributes()
An array of name-value pairs representing user attributes.String
getUsername()
The user name of the user you wish to register.List<AttributeType>
getValidationData()
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.SignUpRequest
withClientId(String clientId)
The ID of the client associated with the user pool.SignUpRequest
withPassword(String password)
The password of the user you wish to register.SignUpRequest
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.SignUpRequest
withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.SignUpRequest
withUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.SignUpRequest
withUsername(String username)
The user name of the user you wish to register.SignUpRequest
withValidationData(AttributeType... validationData)
The validation data in the request to register a user.SignUpRequest
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
-
-
-
-
Method Detail
-
setClientId
public void setClientId(String clientId)
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.
-
getClientId
public String getClientId()
The ID of the client associated with the user pool.
- Returns:
- The ID of the client associated with the user pool.
-
withClientId
public SignUpRequest withClientId(String clientId)
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
public 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.
- 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
public 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.
- 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
public SignUpRequest 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.
- 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
public void setUsername(String username)
The user name of the user you wish to register.
- Parameters:
username
- The user name of the user you wish to register.
-
getUsername
public String getUsername()
The user name of the user you wish to register.
- Returns:
- The user name of the user you wish to register.
-
withUsername
public SignUpRequest withUsername(String username)
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
public void setPassword(String password)
The password of the user you wish to register.
- Parameters:
password
- The password of the user you wish to register.
-
getPassword
public String getPassword()
The password of the user you wish to register.
- Returns:
- The password of the user you wish to register.
-
withPassword
public SignUpRequest withPassword(String password)
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
public List<AttributeType> getUserAttributes()
An array of name-value pairs representing user attributes.
- Returns:
- An array of name-value pairs representing user attributes.
-
setUserAttributes
public void setUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.
-
withUserAttributes
public SignUpRequest withUserAttributes(AttributeType... userAttributes)
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
public SignUpRequest withUserAttributes(Collection<AttributeType> userAttributes)
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
public List<AttributeType> getValidationData()
The validation data in the request to register a user.
- Returns:
- The validation data in the request to register a user.
-
setValidationData
public void setValidationData(Collection<AttributeType> validationData)
The validation data in the request to register a user.
- Parameters:
validationData
- The validation data in the request to register a user.
-
withValidationData
public SignUpRequest withValidationData(AttributeType... validationData)
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
public SignUpRequest withValidationData(Collection<AttributeType> validationData)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public SignUpRequest 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:
Object.clone()
-
-