com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights
 * Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.cognitoidp.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 * The request representing the confirmation for a password reset.
 * 
 */
public class ConfirmForgotPasswordRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {
    /**
     * 
     * The ID of the client associated with the user pool.
     * 
     */
    private String clientId;
    /**
     * 
     * 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 String secretHash;
    /**
     * 
     * The user name of the user for whom you want to enter a code to retrieve a
     * forgotten password.
     * 
     */
    private String username;
    /**
     * 
     * The confirmation code sent by a user's request to retrieve a forgotten
     * password.
     * 
     */
    private String confirmationCode;
    /**
     * 
     * The password sent by sent by a user's request to retrieve a forgotten
     * password.
     * 
     */
    private String password;
    /**
     * 
     * The ID of the client associated with the user pool.
     * 
     * 
     * @param clientId
     *        The ID of the client associated with the user pool.
     */
    public void setClientId(String clientId) {
        this.clientId = clientId;
    }
    /**
     * 
     * The ID of the client associated with the user pool.
     * 
     * 
     * @return The ID of the client associated with the user pool.
     */
    public String getClientId() {
        return this.clientId;
    }
    /**
     * 
     * The ID of the client associated with the user pool.
     * 
     * 
     * @param clientId
     *        The ID of the client associated with the user pool.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ConfirmForgotPasswordRequest withClientId(String clientId) {
        setClientId(clientId);
        return this;
    }
    /**
     * 
     * 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.
     * 
     * 
     * @param 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 setSecretHash(String secretHash) {
        this.secretHash = 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.
     * 
     * 
     * @return 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 String getSecretHash() {
        return this.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.
     * 
     * 
     * @param 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.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ConfirmForgotPasswordRequest withSecretHash(String secretHash) {
        setSecretHash(secretHash);
        return this;
    }
    /**
     * 
     * The user name of the user for whom you want to enter a code to retrieve a
     * forgotten password.
     * 
     * 
     * @param username
     *        The user name of the user for whom you want to enter a code to
     *        retrieve a forgotten password.
     */
    public void setUsername(String username) {
        this.username = username;
    }
    /**
     * 
     * The user name of the user for whom you want to enter a code to retrieve a
     * forgotten password.
     * 
     * 
     * @return The user name of the user for whom you want to enter a code to
     *         retrieve a forgotten password.
     */
    public String getUsername() {
        return this.username;
    }
    /**
     * 
     * The user name of the user for whom you want to enter a code to retrieve a
     * forgotten password.
     * 
     * 
     * @param username
     *        The user name of the user for whom you want to enter a code to
     *        retrieve a forgotten password.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ConfirmForgotPasswordRequest withUsername(String username) {
        setUsername(username);
        return this;
    }
    /**
     * 
     * The confirmation code sent by a user's request to retrieve a forgotten
     * password.
     * 
     * 
     * @param confirmationCode
     *        The confirmation code sent by a user's request to retrieve a
     *        forgotten password.
     */
    public void setConfirmationCode(String confirmationCode) {
        this.confirmationCode = confirmationCode;
    }
    /**
     * 
     * The confirmation code sent by a user's request to retrieve a forgotten
     * password.
     * 
     * 
     * @return The confirmation code sent by a user's request to retrieve a
     *         forgotten password.
     */
    public String getConfirmationCode() {
        return this.confirmationCode;
    }
    /**
     * 
     * The confirmation code sent by a user's request to retrieve a forgotten
     * password.
     * 
     * 
     * @param confirmationCode
     *        The confirmation code sent by a user's request to retrieve a
     *        forgotten password.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ConfirmForgotPasswordRequest withConfirmationCode(
            String confirmationCode) {
        setConfirmationCode(confirmationCode);
        return this;
    }
    /**
     * 
     * The password sent by sent by a user's request to retrieve a forgotten
     * password.
     * 
     * 
     * @param password
     *        The password sent by sent by a user's request to retrieve a
     *        forgotten password.
     */
    public void setPassword(String password) {
        this.password = password;
    }
    /**
     * 
     * The password sent by sent by a user's request to retrieve a forgotten
     * password.
     * 
     * 
     * @return The password sent by sent by a user's request to retrieve a
     *         forgotten password.
     */
    public String getPassword() {
        return this.password;
    }
    /**
     * 
     * The password sent by sent by a user's request to retrieve a forgotten
     * password.
     * 
     * 
     * @param password
     *        The password sent by sent by a user's request to retrieve a
     *        forgotten password.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ConfirmForgotPasswordRequest withPassword(String password) {
        setPassword(password);
        return this;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getClientId() != null)
            sb.append("ClientId: " + getClientId() + ",");
        if (getSecretHash() != null)
            sb.append("SecretHash: " + getSecretHash() + ",");
        if (getUsername() != null)
            sb.append("Username: " + getUsername() + ",");
        if (getConfirmationCode() != null)
            sb.append("ConfirmationCode: " + getConfirmationCode() + ",");
        if (getPassword() != null)
            sb.append("Password: " + getPassword());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof ConfirmForgotPasswordRequest == false)
            return false;
        ConfirmForgotPasswordRequest other = (ConfirmForgotPasswordRequest) obj;
        if (other.getClientId() == null ^ this.getClientId() == null)
            return false;
        if (other.getClientId() != null
                && other.getClientId().equals(this.getClientId()) == false)
            return false;
        if (other.getSecretHash() == null ^ this.getSecretHash() == null)
            return false;
        if (other.getSecretHash() != null
                && other.getSecretHash().equals(this.getSecretHash()) == false)
            return false;
        if (other.getUsername() == null ^ this.getUsername() == null)
            return false;
        if (other.getUsername() != null
                && other.getUsername().equals(this.getUsername()) == false)
            return false;
        if (other.getConfirmationCode() == null
                ^ this.getConfirmationCode() == null)
            return false;
        if (other.getConfirmationCode() != null
                && other.getConfirmationCode().equals(
                        this.getConfirmationCode()) == false)
            return false;
        if (other.getPassword() == null ^ this.getPassword() == null)
            return false;
        if (other.getPassword() != null
                && other.getPassword().equals(this.getPassword()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getClientId() == null) ? 0 : getClientId().hashCode());
        hashCode = prime * hashCode
                + ((getSecretHash() == null) ? 0 : getSecretHash().hashCode());
        hashCode = prime * hashCode
                + ((getUsername() == null) ? 0 : getUsername().hashCode());
        hashCode = prime
                * hashCode
                + ((getConfirmationCode() == null) ? 0 : getConfirmationCode()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getPassword() == null) ? 0 : getPassword().hashCode());
        return hashCode;
    }
    @Override
    public ConfirmForgotPasswordRequest clone() {
        return (ConfirmForgotPasswordRequest) super.clone();
    }
}