software.amazon.awssdk.services.cognitoidentityprovider.model

Class ForgotPasswordRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.ForgotPasswordRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ForgotPasswordRequest.Builder,ForgotPasswordRequest>

@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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ForgotPasswordRequest.Builder

Method Summary

Modifier and Type	Method and Description
AnalyticsMetadataType	analyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
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()
List<SdkField<?>>	sdkFields()
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()
UserContextDataType	userContextData() Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String	username() The user name of the user for whom you want to enter a code to reset a forgotten password.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientId

public String clientId()

The ID of the client associated with the user pool.

Returns:

The ID of the client associated with the user pool.

secretHash

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.

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.

userContextData

public UserContextDataType userContextData()

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

username

public String username()

The user name of the user for whom you want to enter a code to reset a forgotten password.

Returns:

The user name of the user for whom you want to enter a code to reset a forgotten password.

analyticsMetadata

public AnalyticsMetadataType analyticsMetadata()

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.

Returns:

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.

toBuilder

public ForgotPasswordRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ForgotPasswordRequest.Builder,ForgotPasswordRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

Returns:

a builder for type T

builder

public static ForgotPasswordRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ForgotPasswordRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.