com.amazonaws.services.cognitoidp.model.GetCSVHeaderResult 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.
The newest version!
/*
 * Copyright 2019-2024 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 javax.annotation.Generated;

/**
 * 
 * Represents the response from the server to the request to get the header information of the CSV file for the user
 * import job.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetCSVHeaderResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {

    /**
     * 
     * The user pool ID for the user pool that the users are to be imported into.
     * 
     */
    private String userPoolId;
    /**
     * 
     * The header information of the CSV file for the user import job.
     * 
     */
    private java.util.List cSVHeader;

    /**
     * 
     * The user pool ID for the user pool that the users are to be imported into.
     * 
     * 
     * @param userPoolId
     *        The user pool ID for the user pool that the users are to be imported into.
     */

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

    /**
     * 
     * The user pool ID for the user pool that the users are to be imported into.
     * 
     * 
     * @return The user pool ID for the user pool that the users are to be imported into.
     */

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

    /**
     * 
     * The user pool ID for the user pool that the users are to be imported into.
     * 
     * 
     * @param userPoolId
     *        The user pool ID for the user pool that the users are to be imported into.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

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

    /**
     * 
     * The header information of the CSV file for the user import job.
     * 
     * 
     * @return The header information of the CSV file for the user import job.
     */

    public java.util.List getCSVHeader() {
        return cSVHeader;
    }

    /**
     * 
     * The header information of the CSV file for the user import job.
     * 
     * 
     * @param cSVHeader
     *        The header information of the CSV file for the user import job.
     */

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

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

    /**
     * 
     * The header information of the CSV file for the user import job.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setCSVHeader(java.util.Collection)} or {@link #withCSVHeader(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param cSVHeader
     *        The header information of the CSV file for the user import job.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetCSVHeaderResult withCSVHeader(String... cSVHeader) {
        if (this.cSVHeader == null) {
            setCSVHeader(new java.util.ArrayList(cSVHeader.length));
        }
        for (String ele : cSVHeader) {
            this.cSVHeader.add(ele);
        }
        return this;
    }

    /**
     * 
     * The header information of the CSV file for the user import job.
     * 
     * 
     * @param cSVHeader
     *        The header information of the CSV file for the user import job.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetCSVHeaderResult withCSVHeader(java.util.Collection cSVHeader) {
        setCSVHeader(cSVHeader);
        return this;
    }

    /**
     * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
     * redacted from this string using a placeholder value.
     *
     * @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: ").append(getUserPoolId()).append(",");
        if (getCSVHeader() != null)
            sb.append("CSVHeader: ").append(getCSVHeader());
        sb.append("}");
        return sb.toString();
    }

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

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

    @Override
    public GetCSVHeaderResult clone() {
        try {
            return (GetCSVHeaderResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

}