@Generated(value="software.amazon.awssdk:codegen") public final class SignUpRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<SignUpRequest.Builder,SignUpRequest>
Represents the request to register a user.
Modifier and Type | Class and Description |
---|---|
static interface |
SignUpRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SignUpRequest.Builder |
builder() |
String |
clientId()
The ID of the client associated with the user pool.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
password()
The password of the user you wish to register.
|
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.
|
static Class<? extends SignUpRequest.Builder> |
serializableBuilderClass() |
SignUpRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<AttributeType> |
userAttributes()
An array of name-value pairs representing user attributes.
|
String |
username()
The user name of the user you wish to register.
|
List<AttributeType> |
validationData()
The validation data in the request to register a user.
|
overrideConfiguration
copy
public String clientId()
The ID of the client associated with the user pool.
public 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.
public String username()
The user name of the user you wish to register.
public String password()
The password of the user you wish to register.
public List<AttributeType> userAttributes()
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
public List<AttributeType> validationData()
The validation data in the request to register a user.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public SignUpRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SignUpRequest.Builder,SignUpRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static SignUpRequest.Builder builder()
public static Class<? extends SignUpRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.