ConfirmForgotPasswordRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.13.4 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.ConfirmForgotPasswordRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class ConfirmForgotPasswordRequest
extends AmazonWebServiceRequest
implements Serializable
```
Allows a user to enter a confirmation code to reset a forgotten password.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConfirmForgotPasswordRequest()

Constructors
Constructor and Description
`ConfirmForgotPasswordRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The Amazon Pinpoint analytics metadata for collecting metrics for `ConfirmForgotPassword` calls.
`String`	`getClientId()` The app client ID of the app associated with the user pool.
`String`	`getConfirmationCode()` The confirmation code sent by a user's request to retrieve a forgotten password.
`String`	`getPassword()` The password sent by a user's request to retrieve a forgotten password.
`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.
`UserContextDataType`	`getUserContextData()` 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`	`getUsername()` The user name of the user for whom you want to enter a code to retrieve a forgotten password.
`int`	`hashCode()`
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata for collecting metrics for `ConfirmForgotPassword` calls.
`void`	`setClientId(String clientId)` The app client ID of the app associated with the user pool.
`void`	`setConfirmationCode(String confirmationCode)` The confirmation code sent by a user's request to retrieve a forgotten password.
`void`	`setPassword(String password)` The password sent by a user's request to retrieve a forgotten password.
`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`	`setUserContextData(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.
`void`	`setUsername(String username)` The user name of the user for whom you want to enter a code to retrieve a forgotten password.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ConfirmForgotPasswordRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata for collecting metrics for `ConfirmForgotPassword` calls.
`ConfirmForgotPasswordRequest`	`withClientId(String clientId)` The app client ID of the app associated with the user pool.
`ConfirmForgotPasswordRequest`	`withConfirmationCode(String confirmationCode)` The confirmation code sent by a user's request to retrieve a forgotten password.
`ConfirmForgotPasswordRequest`	`withPassword(String password)` The password sent by a user's request to retrieve a forgotten password.
`ConfirmForgotPasswordRequest`	`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.
`ConfirmForgotPasswordRequest`	`withUserContextData(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.
`ConfirmForgotPasswordRequest`	`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
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfirmForgotPasswordRequest
```
public ConfirmForgotPasswordRequest()
```
- Method Detail
  - getClientId
```
public String getClientId()
```
    The app client ID of the app associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The app client ID of the app associated with the user pool.
  - setClientId
```
public void setClientId(String clientId)
```
    The app client ID of the app associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID of the app associated with the user pool.
  - withClientId
```
public ConfirmForgotPasswordRequest withClientId(String clientId)
```
    The app client ID of the app associated with the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID of the app associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSecretHash
```
public 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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - setSecretHash
```
public 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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - withSecretHash
```
public ConfirmForgotPasswordRequest 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsername
```
public String getUsername()
```
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
  - setUsername
```
public void setUsername(String username)
```
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
  - withUsername
```
public ConfirmForgotPasswordRequest withUsername(String username)
```
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getConfirmationCode
```
public String getConfirmationCode()
```
    The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
    
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Returns:
    
    The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
  - setConfirmationCode
```
public void setConfirmationCode(String confirmationCode)
```
    The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
    
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Parameters:
    
    confirmationCode -
    The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
  - withConfirmationCode
```
public ConfirmForgotPasswordRequest withConfirmationCode(String confirmationCode)
```
    The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Parameters:
    
    confirmationCode -
    The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPassword
```
public String getPassword()
```
    The password sent by a user's request to retrieve a forgotten password.
    
    Constraints:
    Length: 6 - 256
    Pattern: [\S]+
    
    Returns:
    
    The password sent by a user's request to retrieve a forgotten password.
  - setPassword
```
public void setPassword(String password)
```
    The password sent by a user's request to retrieve a forgotten password.
    
    Constraints:
    Length: 6 - 256
    Pattern: [\S]+
    
    Parameters:
    
    password -
    The password sent by a user's request to retrieve a forgotten password.
  - withPassword
```
public ConfirmForgotPasswordRequest withPassword(String password)
```
    The password sent by a user's request to retrieve a forgotten password.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 256
    Pattern: [\S]+
    
    Parameters:
    
    password -
    The password sent by a user's request to retrieve a forgotten password.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
    
    Returns:
    
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
    
    Parameters:
    
    analyticsMetadata -
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
  - withAnalyticsMetadata
```
public ConfirmForgotPasswordRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserContextData
```
public UserContextDataType getUserContextData()
```
    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.
  - setUserContextData
```
public void setUserContextData(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.
    
    Parameters:
    
    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.
  - withUserContextData
```
public ConfirmForgotPasswordRequest withUserContextData(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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ConfirmForgotPasswordRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ConfirmForgotPasswordRequest

Method Detail

getClientId

setClientId

withClientId

getSecretHash

setSecretHash

withSecretHash

getUsername

setUsername

withUsername

getConfirmationCode

setConfirmationCode

withConfirmationCode

getPassword

setPassword

withPassword

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

getUserContextData

setUserContextData

withUserContextData

toString

hashCode

equals