com.amazonaws.services.cognitoidp.model.AdminDisableUserRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cognitoidp Show documentation
The AWS Java SDK for Amazon Cognito Identity Provider Service module holds the client classes that are used for communicating with Amazon Cognito Identity Provider Service.
There is a newer version: 1.12.788
Show newest version
/*
 * 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;

/**
 * 
 * Represents the request to disable any user as an administrator.
 * 
 */
public class AdminDisableUserRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {

    /**
     * 
     * The user pool ID for the user pool where you want to disable the user.
     * 
     */
    private String userPoolId;
    /**
     * 
     * The user name of the user you wish to disable.
     * 
     */
    private String username;

    /**
     * 
     * The user pool ID for the user pool where you want to disable the user.
     * 
     * 
     * @param userPoolId
     *        The user pool ID for the user pool where you want to disable the
     *        user.
     */

    public void setUserPoolId(String userPoolId) {
        this.userPoolId = userPoolId;
    }

    /**
     * 
     * The user pool ID for the user pool where you want to disable the user.
     * 
     * 
     * @return The user pool ID for the user pool where you want to disable the
     *         user.
     */

    public String getUserPoolId() {
        return this.userPoolId;
    }

    /**
     * 
     * The user pool ID for the user pool where you want to disable the user.
     * 
     * 
     * @param userPoolId
     *        The user pool ID for the user pool where you want to disable the
     *        user.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public AdminDisableUserRequest withUserPoolId(String userPoolId) {
        setUserPoolId(userPoolId);
        return this;
    }

    /**
     * 
     * The user name of the user you wish to disable.
     * 
     * 
     * @param username
     *        The user name of the user you wish to disable.
     */

    public void setUsername(String username) {
        this.username = username;
    }

    /**
     * 
     * The user name of the user you wish to disable.
     * 
     * 
     * @return The user name of the user you wish to disable.
     */

    public String getUsername() {
        return this.username;
    }

    /**
     * 
     * The user name of the user you wish to disable.
     * 
     * 
     * @param username
     *        The user name of the user you wish to disable.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public AdminDisableUserRequest withUsername(String username) {
        setUsername(username);
        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 (getUserPoolId() != null)
            sb.append("UserPoolId: " + getUserPoolId() + ",");
        if (getUsername() != null)
            sb.append("Username: " + getUsername());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof AdminDisableUserRequest == false)
            return false;
        AdminDisableUserRequest other = (AdminDisableUserRequest) obj;
        if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
            return false;
        if (other.getUserPoolId() != null
                && other.getUserPoolId().equals(this.getUserPoolId()) == false)
            return false;
        if (other.getUsername() == null ^ this.getUsername() == null)
            return false;
        if (other.getUsername() != null
                && other.getUsername().equals(this.getUsername()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode
                + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
        hashCode = prime * hashCode
                + ((getUsername() == null) ? 0 : getUsername().hashCode());
        return hashCode;
    }

    @Override
    public AdminDisableUserRequest clone() {
        return (AdminDisableUserRequest) super.clone();
    }
}