Class ForgotPasswordRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to reset a user's password.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The ID of the client associated with the user pool.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.The user name of the user for whom you want to enter a code to retrieve a forgotten password.int
hashCode()
void
setClientId
(String clientId) The ID of the client associated with the user pool.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
setUsername
(String username) The user name of the user for whom you want to enter a code to retrieve a forgotten password.toString()
Returns a string representation of this object; useful for testing and debugging.withClientId
(String clientId) The ID of the client associated with the user pool.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.withUsername
(String username) The user name of the user for whom you want to enter a code to retrieve a forgotten password.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
Constructor Details
-
ForgotPasswordRequest
public ForgotPasswordRequest()
-
-
Method Details
-
setClientId
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.
-
getClientId
The ID of the client associated with the user pool.
- Returns:
- The ID of the client associated with the user pool.
-
withClientId
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSecretHash
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.
- 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.
-
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.
- 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.
-
withSecretHash
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setUsername
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
- Parameters:
username
- The user name of the user for whom you want to enter a code to retrieve a forgotten password.
-
getUsername
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
- Returns:
- The user name of the user for whom you want to enter a code to retrieve a forgotten password.
-
withUsername
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
- Parameters:
username
- The user name of the user for whom you want to enter a code to retrieve a forgotten password.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-