public class ForgotPasswordRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the request to reset a user's password.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
clientId
The ID of the client associated with the user pool.
|
private java.lang.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.
|
private java.lang.String |
username
The user name of the user for whom you want to enter a code to retrieve a
forgotten password.
|
NOOP
Constructor and Description |
---|
ForgotPasswordRequest() |
Modifier and Type | Method and Description |
---|---|
ForgotPasswordRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getClientId()
The ID of the client associated with the user pool.
|
java.lang.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.
|
java.lang.String |
getUsername()
The user name of the user for whom you want to enter a code to retrieve a
forgotten password.
|
int |
hashCode() |
void |
setClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
void |
setSecretHash(java.lang.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(java.lang.String username)
The user name of the user for whom you want to enter a code to retrieve a
forgotten password.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ForgotPasswordRequest |
withClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
ForgotPasswordRequest |
withSecretHash(java.lang.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.
|
ForgotPasswordRequest |
withUsername(java.lang.String username)
The user name of the user for whom you want to enter a code to retrieve a
forgotten password.
|
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
private java.lang.String clientId
The ID of the client associated with the user pool.
private java.lang.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.
private java.lang.String username
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
public void setClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.public java.lang.String getClientId()
The ID of the client associated with the user pool.
public ForgotPasswordRequest withClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.public void setSecretHash(java.lang.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.
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 java.lang.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.
public ForgotPasswordRequest withSecretHash(java.lang.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.
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 void setUsername(java.lang.String username)
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
username
- The user name of the user for whom you want to enter a code to
retrieve a forgotten password.public java.lang.String getUsername()
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
public ForgotPasswordRequest withUsername(java.lang.String username)
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
username
- The user name of the user for whom you want to enter a code to
retrieve a forgotten password.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ForgotPasswordRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()