com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidentity Show documentation
/*
* Copyright 2011-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 GetCredentialsForIdentity action.
*
*/
public class GetCredentialsForIdentityRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* A unique identifier in the format REGION:GUID.
*
*/
private String identityId;
/**
*
* A set of optional name-value pairs that map provider names to provider
* tokens.
*
*/
private java.util.Map logins;
/**
*
* The Amazon Resource Name (ARN) of the role to be assumed when multiple
* roles were received in the token from the identity provider. For example,
* a SAML-based identity provider. This parameter is optional for identity
* providers that do not support role customization.
*
*/
private String customRoleArn;
/**
*
* A unique identifier in the format REGION:GUID.
*
*
* @param identityId
* A unique identifier in the format REGION:GUID.
*/
public void setIdentityId(String identityId) {
this.identityId = identityId;
}
/**
*
* A unique identifier in the format REGION:GUID.
*
*
* @return A unique identifier in the format REGION:GUID.
*/
public String getIdentityId() {
return this.identityId;
}
/**
*
* A unique identifier in the format REGION:GUID.
*
*
* @param identityId
* A unique identifier in the format REGION:GUID.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GetCredentialsForIdentityRequest withIdentityId(String identityId) {
setIdentityId(identityId);
return this;
}
/**
*
* A set of optional name-value pairs that map provider names to provider
* tokens.
*
*
* @return A set of optional name-value pairs that map provider names to
* provider tokens.
*/
public java.util.Map getLogins() {
return logins;
}
/**
*
* A set of optional name-value pairs that map provider names to provider
* tokens.
*
*
* @param logins
* A set of optional name-value pairs that map provider names to
* provider tokens.
*/
public void setLogins(java.util.Map logins) {
this.logins = logins;
}
/**
*
* A set of optional name-value pairs that map provider names to provider
* tokens.
*
*
* @param logins
* A set of optional name-value pairs that map provider names to
* provider tokens.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GetCredentialsForIdentityRequest withLogins(
java.util.Map logins) {
setLogins(logins);
return this;
}
public GetCredentialsForIdentityRequest 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 GetCredentialsForIdentityRequest clearLoginsEntries() {
this.logins = null;
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the role to be assumed when multiple
* roles were received in the token from the identity provider. For example,
* a SAML-based identity provider. This parameter is optional for identity
* providers that do not support role customization.
*
*
* @param customRoleArn
* The Amazon Resource Name (ARN) of the role to be assumed when
* multiple roles were received in the token from the identity
* provider. For example, a SAML-based identity provider. This
* parameter is optional for identity providers that do not support
* role customization.
*/
public void setCustomRoleArn(String customRoleArn) {
this.customRoleArn = customRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the role to be assumed when multiple
* roles were received in the token from the identity provider. For example,
* a SAML-based identity provider. This parameter is optional for identity
* providers that do not support role customization.
*
*
* @return The Amazon Resource Name (ARN) of the role to be assumed when
* multiple roles were received in the token from the identity
* provider. For example, a SAML-based identity provider. This
* parameter is optional for identity providers that do not support
* role customization.
*/
public String getCustomRoleArn() {
return this.customRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the role to be assumed when multiple
* roles were received in the token from the identity provider. For example,
* a SAML-based identity provider. This parameter is optional for identity
* providers that do not support role customization.
*
*
* @param customRoleArn
* The Amazon Resource Name (ARN) of the role to be assumed when
* multiple roles were received in the token from the identity
* provider. For example, a SAML-based identity provider. This
* parameter is optional for identity providers that do not support
* role customization.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GetCredentialsForIdentityRequest withCustomRoleArn(
String customRoleArn) {
setCustomRoleArn(customRoleArn);
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 (getIdentityId() != null)
sb.append("IdentityId: " + getIdentityId() + ",");
if (getLogins() != null)
sb.append("Logins: " + getLogins() + ",");
if (getCustomRoleArn() != null)
sb.append("CustomRoleArn: " + getCustomRoleArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetCredentialsForIdentityRequest == false)
return false;
GetCredentialsForIdentityRequest other = (GetCredentialsForIdentityRequest) obj;
if (other.getIdentityId() == null ^ this.getIdentityId() == null)
return false;
if (other.getIdentityId() != null
&& other.getIdentityId().equals(this.getIdentityId()) == false)
return false;
if (other.getLogins() == null ^ this.getLogins() == null)
return false;
if (other.getLogins() != null
&& other.getLogins().equals(this.getLogins()) == false)
return false;
if (other.getCustomRoleArn() == null ^ this.getCustomRoleArn() == null)
return false;
if (other.getCustomRoleArn() != null
&& other.getCustomRoleArn().equals(this.getCustomRoleArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getIdentityId() == null) ? 0 : getIdentityId().hashCode());
hashCode = prime * hashCode
+ ((getLogins() == null) ? 0 : getLogins().hashCode());
hashCode = prime
* hashCode
+ ((getCustomRoleArn() == null) ? 0 : getCustomRoleArn()
.hashCode());
return hashCode;
}
@Override
public GetCredentialsForIdentityRequest clone() {
return (GetCredentialsForIdentityRequest) super.clone();
}
}