@Generated(value="software.amazon.awssdk:codegen") public final class ForgotPasswordRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<ForgotPasswordRequest.Builder,ForgotPasswordRequest>
Represents the request to reset a user's password.
Modifier and Type | Class and Description |
---|---|
static interface |
ForgotPasswordRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ForgotPasswordRequest.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 |
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 ForgotPasswordRequest.Builder> |
serializableBuilderClass() |
ForgotPasswordRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
username()
The user name of the user for whom you want to enter a code to reset a forgotten password.
|
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 for whom you want to enter a code to reset a forgotten password.
public ForgotPasswordRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ForgotPasswordRequest.Builder,ForgotPasswordRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static ForgotPasswordRequest.Builder builder()
public static Class<? extends ForgotPasswordRequest.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.