SignUpRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.6.15 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.SignUpRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class SignUpRequest
extends AmazonWebServiceRequest
implements Serializable
```
Registers the user in the specified user pool and creates a user name, password, and user attributes.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SignUpRequest()

Constructors
Constructor and Description
`SignUpRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The pinpoint installation id.
`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.
`UserContextDataType`	`getUserContextData()` Base64 encoded string for user context data collected for risk evaluation
`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`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The pinpoint installation id.
`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`	`setUserContextData(UserContextDataType userContextData)` Base64 encoded string for user context data collected for risk evaluation
`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`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The pinpoint installation id.
`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`	`withUserContextData(UserContextDataType userContextData)` Base64 encoded string for user context data collected for risk evaluation
`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
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SignUpRequest
```
public SignUpRequest()
```
- Method Detail
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The ID of the client associated with the user pool.
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - 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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsername
```
public String getUsername()
```
    The user name of the user you wish to register.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The user name of the user you wish to register.
  - setUsername
```
public void setUsername(String username)
```
    The user name of the user you wish to register.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user you wish to register.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPassword
```
public String getPassword()
```
    The password of the user you wish to register.
    
    Constraints:
    Length: 6 - 256
    Pattern: [\S]+
    
    Returns:
    
    The password of the user you wish to register.
  - setPassword
```
public void setPassword(String password)
```
    The password of the user you wish to register.
    
    Constraints:
    Length: 6 - 256
    Pattern: [\S]+
    
    Parameters:
    
    password -
    The password of the user you wish to register.
  - withPassword
```
public SignUpRequest withPassword(String password)
```
    The password of the user you wish to register.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 256
    Pattern: [\S]+
    
    Parameters:
    
    password -
    The password of the user you wish to register.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userAttributes -
    An array of name-value pairs representing user attributes.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userAttributes -
    An array of name-value pairs representing user attributes.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    validationData -
    The validation data in the request to register a user.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    validationData -
    The validation data in the request to register a user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserContextData
```
public UserContextDataType getUserContextData()
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns:
    
    Base64 encoded string for user context data collected for risk evaluation
  - setUserContextData
```
public void setUserContextData(UserContextDataType userContextData)
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Parameters:
    
    userContextData -
    Base64 encoded string for user context data collected for risk evaluation
  - withUserContextData
```
public SignUpRequest withUserContextData(UserContextDataType userContextData)
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userContextData -
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The pinpoint installation id.
    
    Returns:
    
    The pinpoint installation id.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The pinpoint installation id.
    
    Parameters:
    
    analyticsMetadata -
    The pinpoint installation id.
  - withAnalyticsMetadata
```
public SignUpRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The pinpoint installation id.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The pinpoint installation id.
    
    Returns:
    
    A reference to this updated 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 class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class SignUpRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SignUpRequest

Method Detail

getClientId

setClientId

withClientId

getSecretHash

setSecretHash

withSecretHash

getUsername

setUsername

withUsername

getPassword

setPassword

withPassword

getUserAttributes

setUserAttributes

withUserAttributes

withUserAttributes

getValidationData

setValidationData

withValidationData

withValidationData

getUserContextData

setUserContextData

withUserContextData

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

toString

hashCode

equals