com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolResult 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.cognitoidentity.model;
import java.io.Serializable;
/**
 * An object representing a Cognito identity pool.
 */
public class CreateIdentityPoolResult implements Serializable, Cloneable {
    /** An identity pool ID in the format REGION:GUID. */
    private String identityPoolId;
    /**
     * 
     * A string that you provide.
     * 
     */
    private String identityPoolName;
    /** TRUE if the identity pool supports unauthenticated logins. */
    private Boolean allowUnauthenticatedIdentities;
    /**
     * 
     * Optional key:value pairs mapping provider names to provider app IDs.
     * 
     */
    private java.util.Map supportedLoginProviders;
    /**
     * 
     * The "domain" by which Cognito will refer to your users.
     * 
     */
    private String developerProviderName;
    /**
     * 
     * A list of OpendID Connect provider ARNs.
     * 
     */
    private java.util.List openIdConnectProviderARNs;
    /**
     * 
     * A list representing a Cognito User Identity Pool and its client ID.
     * 
     */
    private java.util.List cognitoIdentityProviders;
    /**
     * An identity pool ID in the format REGION:GUID.
     * 
     * @param identityPoolId
     *        An identity pool ID in the format REGION:GUID.
     */
    public void setIdentityPoolId(String identityPoolId) {
        this.identityPoolId = identityPoolId;
    }
    /**
     * An identity pool ID in the format REGION:GUID.
     * 
     * @return An identity pool ID in the format REGION:GUID.
     */
    public String getIdentityPoolId() {
        return this.identityPoolId;
    }
    /**
     * An identity pool ID in the format REGION:GUID.
     * 
     * @param identityPoolId
     *        An identity pool ID in the format REGION:GUID.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withIdentityPoolId(String identityPoolId) {
        setIdentityPoolId(identityPoolId);
        return this;
    }
    /**
     * 
     * A string that you provide.
     * 
     * 
     * @param identityPoolName
     *        A string that you provide.
     */
    public void setIdentityPoolName(String identityPoolName) {
        this.identityPoolName = identityPoolName;
    }
    /**
     * 
     * A string that you provide.
     * 
     * 
     * @return A string that you provide.
     */
    public String getIdentityPoolName() {
        return this.identityPoolName;
    }
    /**
     * 
     * A string that you provide.
     * 
     * 
     * @param identityPoolName
     *        A string that you provide.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withIdentityPoolName(String identityPoolName) {
        setIdentityPoolName(identityPoolName);
        return this;
    }
    /**
     * TRUE if the identity pool supports unauthenticated logins.
     * 
     * @param allowUnauthenticatedIdentities
     *        TRUE if the identity pool supports unauthenticated logins.
     */
    public void setAllowUnauthenticatedIdentities(
            Boolean allowUnauthenticatedIdentities) {
        this.allowUnauthenticatedIdentities = allowUnauthenticatedIdentities;
    }
    /**
     * TRUE if the identity pool supports unauthenticated logins.
     * 
     * @return TRUE if the identity pool supports unauthenticated logins.
     */
    public Boolean getAllowUnauthenticatedIdentities() {
        return this.allowUnauthenticatedIdentities;
    }
    /**
     * TRUE if the identity pool supports unauthenticated logins.
     * 
     * @param allowUnauthenticatedIdentities
     *        TRUE if the identity pool supports unauthenticated logins.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withAllowUnauthenticatedIdentities(
            Boolean allowUnauthenticatedIdentities) {
        setAllowUnauthenticatedIdentities(allowUnauthenticatedIdentities);
        return this;
    }
    /**
     * TRUE if the identity pool supports unauthenticated logins.
     * 
     * @return TRUE if the identity pool supports unauthenticated logins.
     */
    public Boolean isAllowUnauthenticatedIdentities() {
        return this.allowUnauthenticatedIdentities;
    }
    /**
     * 
     * Optional key:value pairs mapping provider names to provider app IDs.
     * 
     * 
     * @return Optional key:value pairs mapping provider names to provider app
     *         IDs.
     */
    public java.util.Map getSupportedLoginProviders() {
        return supportedLoginProviders;
    }
    /**
     * 
     * Optional key:value pairs mapping provider names to provider app IDs.
     * 
     * 
     * @param supportedLoginProviders
     *        Optional key:value pairs mapping provider names to provider app
     *        IDs.
     */
    public void setSupportedLoginProviders(
            java.util.Map supportedLoginProviders) {
        this.supportedLoginProviders = supportedLoginProviders;
    }
    /**
     * 
     * Optional key:value pairs mapping provider names to provider app IDs.
     * 
     * 
     * @param supportedLoginProviders
     *        Optional key:value pairs mapping provider names to provider app
     *        IDs.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withSupportedLoginProviders(
            java.util.Map supportedLoginProviders) {
        setSupportedLoginProviders(supportedLoginProviders);
        return this;
    }
    public CreateIdentityPoolResult addSupportedLoginProvidersEntry(String key,
            String value) {
        if (null == this.supportedLoginProviders) {
            this.supportedLoginProviders = new java.util.HashMap();
        }
        if (this.supportedLoginProviders.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys ("
                    + key.toString() + ") are provided.");
        this.supportedLoginProviders.put(key, value);
        return this;
    }
    /**
     * Removes all the entries added into SupportedLoginProviders. <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     */
    public CreateIdentityPoolResult clearSupportedLoginProvidersEntries() {
        this.supportedLoginProviders = null;
        return this;
    }
    /**
     * 
     * The "domain" by which Cognito will refer to your users.
     * 
     * 
     * @param developerProviderName
     *        The "domain" by which Cognito will refer to your users.
     */
    public void setDeveloperProviderName(String developerProviderName) {
        this.developerProviderName = developerProviderName;
    }
    /**
     * 
     * The "domain" by which Cognito will refer to your users.
     * 
     * 
     * @return The "domain" by which Cognito will refer to your users.
     */
    public String getDeveloperProviderName() {
        return this.developerProviderName;
    }
    /**
     * 
     * The "domain" by which Cognito will refer to your users.
     * 
     * 
     * @param developerProviderName
     *        The "domain" by which Cognito will refer to your users.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withDeveloperProviderName(
            String developerProviderName) {
        setDeveloperProviderName(developerProviderName);
        return this;
    }
    /**
     * 
     * A list of OpendID Connect provider ARNs.
     * 
     * 
     * @return A list of OpendID Connect provider ARNs.
     */
    public java.util.List getOpenIdConnectProviderARNs() {
        return openIdConnectProviderARNs;
    }
    /**
     * 
     * A list of OpendID Connect provider ARNs.
     * 
     * 
     * @param openIdConnectProviderARNs
     *        A list of OpendID Connect provider ARNs.
     */
    public void setOpenIdConnectProviderARNs(
            java.util.Collection openIdConnectProviderARNs) {
        if (openIdConnectProviderARNs == null) {
            this.openIdConnectProviderARNs = null;
            return;
        }
        this.openIdConnectProviderARNs = new java.util.ArrayList(
                openIdConnectProviderARNs);
    }
    /**
     * 
     * A list of OpendID Connect provider ARNs.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setOpenIdConnectProviderARNs(java.util.Collection)} or
     * {@link #withOpenIdConnectProviderARNs(java.util.Collection)} if you want
     * to override the existing values.
     * 
     * 
     * @param openIdConnectProviderARNs
     *        A list of OpendID Connect provider ARNs.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withOpenIdConnectProviderARNs(
            String... openIdConnectProviderARNs) {
        if (this.openIdConnectProviderARNs == null) {
            setOpenIdConnectProviderARNs(new java.util.ArrayList(
                    openIdConnectProviderARNs.length));
        }
        for (String ele : openIdConnectProviderARNs) {
            this.openIdConnectProviderARNs.add(ele);
        }
        return this;
    }
    /**
     * 
     * A list of OpendID Connect provider ARNs.
     * 
     * 
     * @param openIdConnectProviderARNs
     *        A list of OpendID Connect provider ARNs.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withOpenIdConnectProviderARNs(
            java.util.Collection openIdConnectProviderARNs) {
        setOpenIdConnectProviderARNs(openIdConnectProviderARNs);
        return this;
    }
    /**
     * 
     * A list representing a Cognito User Identity Pool and its client ID.
     * 
     * 
     * @return A list representing a Cognito User Identity Pool and its client
     *         ID.
     */
    public java.util.List getCognitoIdentityProviders() {
        return cognitoIdentityProviders;
    }
    /**
     * 
     * A list representing a Cognito User Identity Pool and its client ID.
     * 
     * 
     * @param cognitoIdentityProviders
     *        A list representing a Cognito User Identity Pool and its client
     *        ID.
     */
    public void setCognitoIdentityProviders(
            java.util.Collection cognitoIdentityProviders) {
        if (cognitoIdentityProviders == null) {
            this.cognitoIdentityProviders = null;
            return;
        }
        this.cognitoIdentityProviders = new java.util.ArrayList(
                cognitoIdentityProviders);
    }
    /**
     * 
     * A list representing a Cognito User Identity Pool and its client ID.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setCognitoIdentityProviders(java.util.Collection)} or
     * {@link #withCognitoIdentityProviders(java.util.Collection)} if you want
     * to override the existing values.
     * 
     * 
     * @param cognitoIdentityProviders
     *        A list representing a Cognito User Identity Pool and its client
     *        ID.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withCognitoIdentityProviders(
            CognitoIdentityProvider... cognitoIdentityProviders) {
        if (this.cognitoIdentityProviders == null) {
            setCognitoIdentityProviders(new java.util.ArrayList(
                    cognitoIdentityProviders.length));
        }
        for (CognitoIdentityProvider ele : cognitoIdentityProviders) {
            this.cognitoIdentityProviders.add(ele);
        }
        return this;
    }
    /**
     * 
     * A list representing a Cognito User Identity Pool and its client ID.
     * 
     * 
     * @param cognitoIdentityProviders
     *        A list representing a Cognito User Identity Pool and its client
     *        ID.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateIdentityPoolResult withCognitoIdentityProviders(
            java.util.Collection cognitoIdentityProviders) {
        setCognitoIdentityProviders(cognitoIdentityProviders);
        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 (getIdentityPoolId() != null)
            sb.append("IdentityPoolId: " + getIdentityPoolId() + ",");
        if (getIdentityPoolName() != null)
            sb.append("IdentityPoolName: " + getIdentityPoolName() + ",");
        if (getAllowUnauthenticatedIdentities() != null)
            sb.append("AllowUnauthenticatedIdentities: "
                    + getAllowUnauthenticatedIdentities() + ",");
        if (getSupportedLoginProviders() != null)
            sb.append("SupportedLoginProviders: "
                    + getSupportedLoginProviders() + ",");
        if (getDeveloperProviderName() != null)
            sb.append("DeveloperProviderName: " + getDeveloperProviderName()
                    + ",");
        if (getOpenIdConnectProviderARNs() != null)
            sb.append("OpenIdConnectProviderARNs: "
                    + getOpenIdConnectProviderARNs() + ",");
        if (getCognitoIdentityProviders() != null)
            sb.append("CognitoIdentityProviders: "
                    + getCognitoIdentityProviders());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof CreateIdentityPoolResult == false)
            return false;
        CreateIdentityPoolResult other = (CreateIdentityPoolResult) obj;
        if (other.getIdentityPoolId() == null
                ^ this.getIdentityPoolId() == null)
            return false;
        if (other.getIdentityPoolId() != null
                && other.getIdentityPoolId().equals(this.getIdentityPoolId()) == false)
            return false;
        if (other.getIdentityPoolName() == null
                ^ this.getIdentityPoolName() == null)
            return false;
        if (other.getIdentityPoolName() != null
                && other.getIdentityPoolName().equals(
                        this.getIdentityPoolName()) == false)
            return false;
        if (other.getAllowUnauthenticatedIdentities() == null
                ^ this.getAllowUnauthenticatedIdentities() == null)
            return false;
        if (other.getAllowUnauthenticatedIdentities() != null
                && other.getAllowUnauthenticatedIdentities().equals(
                        this.getAllowUnauthenticatedIdentities()) == false)
            return false;
        if (other.getSupportedLoginProviders() == null
                ^ this.getSupportedLoginProviders() == null)
            return false;
        if (other.getSupportedLoginProviders() != null
                && other.getSupportedLoginProviders().equals(
                        this.getSupportedLoginProviders()) == false)
            return false;
        if (other.getDeveloperProviderName() == null
                ^ this.getDeveloperProviderName() == null)
            return false;
        if (other.getDeveloperProviderName() != null
                && other.getDeveloperProviderName().equals(
                        this.getDeveloperProviderName()) == false)
            return false;
        if (other.getOpenIdConnectProviderARNs() == null
                ^ this.getOpenIdConnectProviderARNs() == null)
            return false;
        if (other.getOpenIdConnectProviderARNs() != null
                && other.getOpenIdConnectProviderARNs().equals(
                        this.getOpenIdConnectProviderARNs()) == false)
            return false;
        if (other.getCognitoIdentityProviders() == null
                ^ this.getCognitoIdentityProviders() == null)
            return false;
        if (other.getCognitoIdentityProviders() != null
                && other.getCognitoIdentityProviders().equals(
                        this.getCognitoIdentityProviders()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getIdentityPoolId() == null) ? 0 : getIdentityPoolId()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getIdentityPoolName() == null) ? 0 : getIdentityPoolName()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getAllowUnauthenticatedIdentities() == null) ? 0
                        : getAllowUnauthenticatedIdentities().hashCode());
        hashCode = prime
                * hashCode
                + ((getSupportedLoginProviders() == null) ? 0
                        : getSupportedLoginProviders().hashCode());
        hashCode = prime
                * hashCode
                + ((getDeveloperProviderName() == null) ? 0
                        : getDeveloperProviderName().hashCode());
        hashCode = prime
                * hashCode
                + ((getOpenIdConnectProviderARNs() == null) ? 0
                        : getOpenIdConnectProviderARNs().hashCode());
        hashCode = prime
                * hashCode
                + ((getCognitoIdentityProviders() == null) ? 0
                        : getCognitoIdentityProviders().hashCode());
        return hashCode;
    }
    @Override
    public CreateIdentityPoolResult clone() {
        try {
            return (CreateIdentityPoolResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}