com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesRequest 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;
/**
 * 
 * Represents the request to update the user's attributes as an administrator.
 * 
 */
public class AdminUpdateUserAttributesRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {
    /**
     * 
     * The user pool ID for the user pool where you want to update user
     * attributes.
     * 
     */
    private String userPoolId;
    /**
     * 
     * The user name of the user for whom you want to update user attributes.
     * 
     */
    private String username;
    /**
     * 
     * An array of name-value pairs representing user attributes.
     * 
     */
    private java.util.List userAttributes;
    /**
     * 
     * The user pool ID for the user pool where you want to update user
     * attributes.
     * 
     * 
     * @param userPoolId
     *        The user pool ID for the user pool where you want to update user
     *        attributes.
     */
    public void setUserPoolId(String userPoolId) {
        this.userPoolId = userPoolId;
    }
    /**
     * 
     * The user pool ID for the user pool where you want to update user
     * attributes.
     * 
     * 
     * @return The user pool ID for the user pool where you want to update user
     *         attributes.
     */
    public String getUserPoolId() {
        return this.userPoolId;
    }
    /**
     * 
     * The user pool ID for the user pool where you want to update user
     * attributes.
     * 
     * 
     * @param userPoolId
     *        The user pool ID for the user pool where you want to update user
     *        attributes.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public AdminUpdateUserAttributesRequest withUserPoolId(String userPoolId) {
        setUserPoolId(userPoolId);
        return this;
    }
    /**
     * 
     * The user name of the user for whom you want to update user attributes.
     * 
     * 
     * @param username
     *        The user name of the user for whom you want to update user
     *        attributes.
     */
    public void setUsername(String username) {
        this.username = username;
    }
    /**
     * 
     * The user name of the user for whom you want to update user attributes.
     * 
     * 
     * @return The user name of the user for whom you want to update user
     *         attributes.
     */
    public String getUsername() {
        return this.username;
    }
    /**
     * 
     * The user name of the user for whom you want to update user attributes.
     * 
     * 
     * @param username
     *        The user name of the user for whom you want to update user
     *        attributes.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public AdminUpdateUserAttributesRequest withUsername(String username) {
        setUsername(username);
        return this;
    }
    /**
     * 
     * An array of name-value pairs representing user attributes.
     * 
     * 
     * @return An array of name-value pairs representing user attributes.
     */
    public java.util.List getUserAttributes() {
        return userAttributes;
    }
    /**
     * 
     * An array of name-value pairs representing user attributes.
     * 
     * 
     * @param userAttributes
     *        An array of name-value pairs representing user attributes.
     */
    public void setUserAttributes(
            java.util.Collection userAttributes) {
        if (userAttributes == null) {
            this.userAttributes = null;
            return;
        }
        this.userAttributes = new java.util.ArrayList(
                userAttributes);
    }
    /**
     * 
     * An array of name-value pairs representing user attributes.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setUserAttributes(java.util.Collection)} or
     * {@link #withUserAttributes(java.util.Collection)} if you want to override
     * the existing values.
     * 
     * 
     * @param userAttributes
     *        An array of name-value pairs representing user attributes.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public AdminUpdateUserAttributesRequest withUserAttributes(
            AttributeType... userAttributes) {
        if (this.userAttributes == null) {
            setUserAttributes(new java.util.ArrayList(
                    userAttributes.length));
        }
        for (AttributeType ele : userAttributes) {
            this.userAttributes.add(ele);
        }
        return this;
    }
    /**
     * 
     * An array of name-value pairs representing user attributes.
     * 
     * 
     * @param userAttributes
     *        An array of name-value pairs representing user attributes.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public AdminUpdateUserAttributesRequest withUserAttributes(
            java.util.Collection userAttributes) {
        setUserAttributes(userAttributes);
        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() + ",");
        if (getUserAttributes() != null)
            sb.append("UserAttributes: " + getUserAttributes());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof AdminUpdateUserAttributesRequest == false)
            return false;
        AdminUpdateUserAttributesRequest other = (AdminUpdateUserAttributesRequest) 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;
        if (other.getUserAttributes() == null
                ^ this.getUserAttributes() == null)
            return false;
        if (other.getUserAttributes() != null
                && other.getUserAttributes().equals(this.getUserAttributes()) == 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());
        hashCode = prime
                * hashCode
                + ((getUserAttributes() == null) ? 0 : getUserAttributes()
                        .hashCode());
        return hashCode;
    }
    @Override
    public AdminUpdateUserAttributesRequest clone() {
        return (AdminUpdateUserAttributesRequest) super.clone();
    }
}