Class ForgotPasswordRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.cognitoidp.model.ForgotPasswordRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the request to reset a user's password.

See Also:
  • Constructor Details

    • ForgotPasswordRequest

      public ForgotPasswordRequest()
  • Method Details

    • setClientId

      public void setClientId(String clientId)

      The ID of the client associated with the user pool.

      Parameters:
      clientId - The ID of the client associated with the user pool.
    • getClientId

      public String getClientId()

      The ID of the client associated with the user pool.

      Returns:
      The ID of the client associated with the user pool.
    • withClientId

      public ForgotPasswordRequest withClientId(String clientId)

      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

      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.

      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

      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.

      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

      public ForgotPasswordRequest 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.

      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

      public void setUsername(String username)

      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

      public String 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

      public ForgotPasswordRequest withUsername(String username)

      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

      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ForgotPasswordRequest 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 class AmazonWebServiceRequest
      See Also: