public class SignUpRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the request to register 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 |
password
The password of the user you wish to register.
|
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.util.List<AttributeType> |
userAttributes
An array of name-value pairs representing user attributes.
|
private java.lang.String |
username
The user name of the user you wish to register.
|
private java.util.List<AttributeType> |
validationData
The validation data in the request to register a user.
|
NOOP
Constructor and Description |
---|
SignUpRequest() |
Modifier and Type | Method and Description |
---|---|
SignUpRequest |
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 |
getPassword()
The password of the user you wish to register.
|
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.util.List<AttributeType> |
getUserAttributes()
An array of name-value pairs representing user attributes.
|
java.lang.String |
getUsername()
The user name of the user you wish to register.
|
java.util.List<AttributeType> |
getValidationData()
The validation data in the request to register a user.
|
int |
hashCode() |
void |
setClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
void |
setPassword(java.lang.String password)
The password of the user you wish to register.
|
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 |
setUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
|
void |
setUsername(java.lang.String username)
The user name of the user you wish to register.
|
void |
setValidationData(java.util.Collection<AttributeType> validationData)
The validation data in the request to register a user.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SignUpRequest |
withClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
SignUpRequest |
withPassword(java.lang.String password)
The password of the user you wish to register.
|
SignUpRequest |
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.
|
SignUpRequest |
withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
|
SignUpRequest |
withUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
|
SignUpRequest |
withUsername(java.lang.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(java.util.Collection<AttributeType> validationData)
The validation data in the request to register a user.
|
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 you wish to register.
private java.lang.String password
The password of the user you wish to register.
private java.util.List<AttributeType> userAttributes
An array of name-value pairs representing user attributes.
private java.util.List<AttributeType> validationData
The validation data in the request to register a user.
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 SignUpRequest 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 SignUpRequest 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 you wish to register.
username
- The user name of the user you wish to register.public java.lang.String getUsername()
The user name of the user you wish to register.
public SignUpRequest withUsername(java.lang.String username)
The user name of the user you wish to register.
username
- The user name of the user you wish to register.public void setPassword(java.lang.String password)
The password of the user you wish to register.
password
- The password of the user you wish to register.public java.lang.String getPassword()
The password of the user you wish to register.
public SignUpRequest withPassword(java.lang.String password)
The password of the user you wish to register.
password
- The password of the user you wish to register.public java.util.List<AttributeType> getUserAttributes()
An array of name-value pairs representing user attributes.
public void setUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
userAttributes
- An array of name-value pairs representing user attributes.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)
or
withUserAttributes(java.util.Collection)
if you want to override
the existing values.
userAttributes
- An array of name-value pairs representing user attributes.public SignUpRequest withUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
userAttributes
- An array of name-value pairs representing user attributes.public java.util.List<AttributeType> getValidationData()
The validation data in the request to register a user.
public void setValidationData(java.util.Collection<AttributeType> validationData)
The validation data in the request to register a user.
validationData
- The validation data in the request to register a user.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)
or
withValidationData(java.util.Collection)
if you want to override
the existing values.
validationData
- The validation data in the request to register a user.public SignUpRequest withValidationData(java.util.Collection<AttributeType> validationData)
The validation data in the request to register a user.
validationData
- The validation data in the request to register a user.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 SignUpRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()