com.amazonaws.services.cognitoidp.model.AddCustomAttributesRequest 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 add custom attributes.
 * 
 */
public class AddCustomAttributesRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {

    /**
     * 
     * The user pool ID for the user pool where you want to add custom
     * attributes.
     * 
     */
    private String userPoolId;
    /**
     * 
     * An array of custom attributes, such as Mutable and Name.
     * 
     */
    private java.util.List customAttributes;

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

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

    /**
     * 
     * The user pool ID for the user pool where you want to add custom
     * attributes.
     * 
     * 
     * @return The user pool ID for the user pool where you want to add custom
     *         attributes.
     */

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

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

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

    /**
     * 
     * An array of custom attributes, such as Mutable and Name.
     * 
     * 
     * @return An array of custom attributes, such as Mutable and Name.
     */

    public java.util.List getCustomAttributes() {
        return customAttributes;
    }

    /**
     * 
     * An array of custom attributes, such as Mutable and Name.
     * 
     * 
     * @param customAttributes
     *        An array of custom attributes, such as Mutable and Name.
     */

    public void setCustomAttributes(
            java.util.Collection customAttributes) {
        if (customAttributes == null) {
            this.customAttributes = null;
            return;
        }

        this.customAttributes = new java.util.ArrayList(
                customAttributes);
    }

    /**
     * 
     * An array of custom attributes, such as Mutable and Name.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setCustomAttributes(java.util.Collection)} or
     * {@link #withCustomAttributes(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param customAttributes
     *        An array of custom attributes, such as Mutable and Name.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public AddCustomAttributesRequest withCustomAttributes(
            SchemaAttributeType... customAttributes) {
        if (this.customAttributes == null) {
            setCustomAttributes(new java.util.ArrayList(
                    customAttributes.length));
        }
        for (SchemaAttributeType ele : customAttributes) {
            this.customAttributes.add(ele);
        }
        return this;
    }

    /**
     * 
     * An array of custom attributes, such as Mutable and Name.
     * 
     * 
     * @param customAttributes
     *        An array of custom attributes, such as Mutable and Name.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public AddCustomAttributesRequest withCustomAttributes(
            java.util.Collection customAttributes) {
        setCustomAttributes(customAttributes);
        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 (getCustomAttributes() != null)
            sb.append("CustomAttributes: " + getCustomAttributes());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof AddCustomAttributesRequest == false)
            return false;
        AddCustomAttributesRequest other = (AddCustomAttributesRequest) obj;
        if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
            return false;
        if (other.getUserPoolId() != null
                && other.getUserPoolId().equals(this.getUserPoolId()) == false)
            return false;
        if (other.getCustomAttributes() == null
                ^ this.getCustomAttributes() == null)
            return false;
        if (other.getCustomAttributes() != null
                && other.getCustomAttributes().equals(
                        this.getCustomAttributes()) == 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
                + ((getCustomAttributes() == null) ? 0 : getCustomAttributes()
                        .hashCode());
        return hashCode;
    }

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