com.amazonaws.services.cognitoidentity.model.GetIdRequest Maven / Gradle / Ivy
Show all versions of aws-android-sdk-core 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.cognitoidentity.AmazonCognitoIdentity#getId(GetIdRequest) GetId operation}.
*
* Generates (or retrieves) a Cognito ID. Supplying multiple logins will
* create an implicit linked account.
*
*
* This is a public API. You do not need any credentials to call this
* API.
*
*
* @see com.amazonaws.services.cognitoidentity.AmazonCognitoIdentity#getId(GetIdRequest)
*/
public class GetIdRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A standard AWS account ID (9+ digits).
*
* Constraints:
* Length: 1 - 15
* Pattern: \d+
*/
private String accountId;
/**
* An identity pool ID in the format REGION:GUID.
*
* Constraints:
* Length: 1 - 55
* Pattern: [\w-]+:[0-9a-f-]+
*/
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
*
* Constraints:
* Length: 0 - 10
*/
private java.util.Map logins;
/**
* A standard AWS account ID (9+ digits).
*
* Constraints:
* Length: 1 - 15
* Pattern: \d+
*
* @return A standard AWS account ID (9+ digits).
*/
public String getAccountId() {
return accountId;
}
/**
* A standard AWS account ID (9+ digits).
*
* Constraints:
* Length: 1 - 15
* Pattern: \d+
*
* @param accountId A standard AWS account ID (9+ digits).
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
* A standard AWS account ID (9+ digits).
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 15
* Pattern: \d+
*
* @param accountId A standard AWS account ID (9+ digits).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetIdRequest withAccountId(String accountId) {
this.accountId = accountId;
return this;
}
/**
* An identity pool ID in the format REGION:GUID.
*
* Constraints:
* Length: 1 - 55
* Pattern: [\w-]+:[0-9a-f-]+
*
* @return An identity pool ID in the format REGION:GUID.
*/
public String getIdentityPoolId() {
return identityPoolId;
}
/**
* An identity pool ID in the format REGION:GUID.
*
* Constraints:
* Length: 1 - 55
* Pattern: [\w-]+:[0-9a-f-]+
*
* @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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 55
* Pattern: [\w-]+:[0-9a-f-]+
*
* @param identityPoolId An identity pool ID in the format REGION:GUID.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetIdRequest withIdentityPoolId(String identityPoolId) {
this.identityPoolId = 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
*
* Constraints:
* Length: 0 - 10
*
* @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() {
if (logins == null) {
logins = new java.util.HashMap();
}
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
*
* Constraints:
* Length: 0 - 10
*
* @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
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 10
*
* @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 A reference to this updated object so that method calls can be chained
* together.
*/
public GetIdRequest withLogins(java.util.Map logins) {
setLogins(logins);
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
*
* The method adds a new key-value pair into Logins parameter, and
* returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* Length: 0 - 10
*
* @param key The key of the entry to be added into Logins.
* @param value The corresponding value of the entry to be added into Logins.
*/
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.
*
* 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 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 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;
}
}