com.amazonaws.services.cognitoidentity.model.GetIdRequest Maven / Gradle / Ivy

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

import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;

/**
 * Input to the GetId action.
 */
public class GetIdRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {

    /** A standard AWS account ID (9+ digits). */
    private String accountId;
    /** An identity pool ID in the format REGION:GUID. */
    private String identityPoolId;
    /**
     * 
     * A set of optional name-value pairs that map provider names to provider
     * tokens.
     * 
     * 
     * The available provider names for Logins are as follows:
     * 

     * Facebook: graph.facebook.com
     * Google: accounts.google.com
     * Amazon: www.amazon.com
     * Twitter: api.twitter.com
     * Digits: www.digits.com
     * 
     * 
     */
    private java.util.Map logins;

    /**
     * A standard AWS account ID (9+ digits).
     * 
     * @param accountId
     *        A standard AWS account ID (9+ digits).
     */

    public void setAccountId(String accountId) {
        this.accountId = accountId;
    }

    /**
     * A standard AWS account ID (9+ digits).
     * 
     * @return A standard AWS account ID (9+ digits).
     */

    public String getAccountId() {
        return this.accountId;
    }

    /**
     * A standard AWS account ID (9+ digits).
     * 
     * @param accountId
     *        A standard AWS account ID (9+ digits).
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public GetIdRequest withAccountId(String accountId) {
        setAccountId(accountId);
        return this;
    }

    /**
     * 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 GetIdRequest withIdentityPoolId(String identityPoolId) {
        setIdentityPoolId(identityPoolId);
        return this;
    }

    /**
     * 
     * A set of optional name-value pairs that map provider names to provider
     * tokens.
     * 
     * 
     * The available provider names for Logins are as follows:
     * 

     * Facebook: graph.facebook.com
     * Google: accounts.google.com
     * Amazon: www.amazon.com
     * Twitter: api.twitter.com
     * Digits: www.digits.com
     * 
     * 
     * 
     * @return A set of optional name-value pairs that map provider names to
     *         provider tokens.
     *         
     *         The available provider names for Logins are as
     *         follows:
     *         

     *         Facebook: graph.facebook.com
     *         Google: accounts.google.com
     *         Amazon: www.amazon.com
     *         Twitter: api.twitter.com
     *         Digits: www.digits.com
     *         
     */

    public java.util.Map getLogins() {
        return logins;
    }

    /**
     * 
     * A set of optional name-value pairs that map provider names to provider
     * tokens.
     * 
     * 
     * The available provider names for Logins are as follows:
     * 

     * Facebook: graph.facebook.com
     * Google: accounts.google.com
     * Amazon: www.amazon.com
     * Twitter: api.twitter.com
     * Digits: www.digits.com
     * 
     * 
     * 
     * @param logins
     *        A set of optional name-value pairs that map provider names to
     *        provider tokens.
     *        
     *        The available provider names for Logins are as
     *        follows:
     *        

     *        Facebook: graph.facebook.com
     *        Google: accounts.google.com
     *        Amazon: www.amazon.com
     *        Twitter: api.twitter.com
     *        Digits: www.digits.com
     *        
     */

    public void setLogins(java.util.Map logins) {
        this.logins = logins;
    }

    /**
     * 
     * A set of optional name-value pairs that map provider names to provider
     * tokens.
     * 
     * 
     * The available provider names for Logins are as follows:
     * 

     * Facebook: graph.facebook.com
     * Google: accounts.google.com
     * Amazon: www.amazon.com
     * Twitter: api.twitter.com
     * Digits: www.digits.com
     * 
     * 
     * 
     * @param logins
     *        A set of optional name-value pairs that map provider names to
     *        provider tokens.
     *        
     *        The available provider names for Logins are as
     *        follows:
     *        

     *        Facebook: graph.facebook.com
     *        Google: accounts.google.com
     *        Amazon: www.amazon.com
     *        Twitter: api.twitter.com
     *        Digits: www.digits.com
     *        
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public GetIdRequest withLogins(java.util.Map logins) {
        setLogins(logins);
        return this;
    }

    public GetIdRequest addLoginsEntry(String key, String value) {
        if (null == this.logins) {
            this.logins = new java.util.HashMap();
        }
        if (this.logins.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys ("
                    + key.toString() + ") are provided.");
        this.logins.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Logins. <p> Returns a reference to
     * this object so that method calls can be chained together.
     */

    public GetIdRequest clearLoginsEntries() {
        this.logins = null;
        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 (getAccountId() != null)
            sb.append("AccountId: " + getAccountId() + ",");
        if (getIdentityPoolId() != null)
            sb.append("IdentityPoolId: " + getIdentityPoolId() + ",");
        if (getLogins() != null)
            sb.append("Logins: " + getLogins());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof GetIdRequest == false)
            return false;
        GetIdRequest other = (GetIdRequest) obj;
        if (other.getAccountId() == null ^ this.getAccountId() == null)
            return false;
        if (other.getAccountId() != null
                && other.getAccountId().equals(this.getAccountId()) == false)
            return false;
        if (other.getIdentityPoolId() == null
                ^ this.getIdentityPoolId() == null)
            return false;
        if (other.getIdentityPoolId() != null
                && other.getIdentityPoolId().equals(this.getIdentityPoolId()) == false)
            return false;
        if (other.getLogins() == null ^ this.getLogins() == null)
            return false;
        if (other.getLogins() != null
                && other.getLogins().equals(this.getLogins()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode
                + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
        hashCode = prime
                * hashCode
                + ((getIdentityPoolId() == null) ? 0 : getIdentityPoolId()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getLogins() == null) ? 0 : getLogins().hashCode());
        return hashCode;
    }

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