com.amazonaws.services.cognitoidentity.model

Class UnlinkIdentityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.UnlinkIdentityRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UnlinkIdentityRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UnlinkIdentity operation.

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

See Also:

AmazonCognitoIdentity.unlinkIdentity(UnlinkIdentityRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UnlinkIdentityRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UnlinkIdentityRequest	addLoginsEntry(String key, String value) A set of optional name-value pairs that map provider names to provider tokens.
UnlinkIdentityRequest	clearLoginsEntries() Removes all the entries added into Logins.
UnlinkIdentityRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getIdentityId() A unique identifier in the format REGION:GUID.
Map<String,String>	getLogins() A set of optional name-value pairs that map provider names to provider tokens.
List<String>	getLoginsToRemove() Provider names to unlink from this identity.
int	hashCode()
void	setIdentityId(String identityId) A unique identifier in the format REGION:GUID.
void	setLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.
void	setLoginsToRemove(Collection<String> loginsToRemove) Provider names to unlink from this identity.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UnlinkIdentityRequest	withIdentityId(String identityId) A unique identifier in the format REGION:GUID.
UnlinkIdentityRequest	withLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.
UnlinkIdentityRequest	withLoginsToRemove(Collection<String> loginsToRemove) Provider names to unlink from this identity.
UnlinkIdentityRequest	withLoginsToRemove(String... loginsToRemove) Provider names to unlink from this identity.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnlinkIdentityRequest

public UnlinkIdentityRequest()

Method Detail

getIdentityId

public String getIdentityId()

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

A unique identifier in the format REGION:GUID.

setIdentityId

public void setIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId - A unique identifier in the format REGION:GUID.

withIdentityId

public UnlinkIdentityRequest withIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId - A unique identifier in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogins

public Map<String,String> getLogins()

A set of optional name-value pairs that map provider names to provider tokens.

Constraints:
Length: 0 - 10

Returns:

A set of optional name-value pairs that map provider names to provider tokens.

setLogins

public void setLogins(Map<String,String> logins)

A set of optional name-value pairs that map provider names to provider tokens.

Constraints:
Length: 0 - 10

Parameters:

logins - A set of optional name-value pairs that map provider names to provider tokens.

withLogins

public UnlinkIdentityRequest withLogins(Map<String,String> logins)

A set of optional name-value pairs that map provider names to provider tokens.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

logins - A set of optional name-value pairs that map provider names to provider tokens.

Returns:

A reference to this updated object so that method calls can be chained together.

addLoginsEntry

public UnlinkIdentityRequest addLoginsEntry(String key,
                                   String value)

A set of optional name-value pairs that map provider names to provider tokens.

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

Parameters:

key - The key of the entry to be added into Logins.

value - The corresponding value of the entry to be added into Logins.

clearLoginsEntries

public UnlinkIdentityRequest clearLoginsEntries()

Removes all the entries added into Logins.

Returns a reference to this object so that method calls can be chained together.

getLoginsToRemove

public List<String> getLoginsToRemove()

Provider names to unlink from this identity.

Returns:

Provider names to unlink from this identity.

setLoginsToRemove

public void setLoginsToRemove(Collection<String> loginsToRemove)

Provider names to unlink from this identity.

Parameters:

loginsToRemove - Provider names to unlink from this identity.

withLoginsToRemove

public UnlinkIdentityRequest withLoginsToRemove(String... loginsToRemove)

Provider names to unlink from this identity.

NOTE: This method appends the values to the existing list (if any). Use setLoginsToRemove(java.util.Collection) or withLoginsToRemove(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loginsToRemove - Provider names to unlink from this identity.

Returns:

A reference to this updated object so that method calls can be chained together.

withLoginsToRemove

public UnlinkIdentityRequest withLoginsToRemove(Collection<String> loginsToRemove)

Provider names to unlink from this identity.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loginsToRemove - Provider names to unlink from this identity.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public UnlinkIdentityRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()