GetIdRequest (aws-android-sdk-core 2.80.0 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentity.model.GetIdRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GetIdRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
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 Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetIdRequest()

Constructors
Constructor and Description
`GetIdRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetIdRequest`	`addLoginsEntry(java.lang.String key, java.lang.String value)` A set of optional name-value pairs that map provider names to provider tokens.
`GetIdRequest`	`clearLoginsEntries()` Removes all the entries added into Logins.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAccountId()` A standard AWS account ID (9+ digits).
`java.lang.String`	`getIdentityPoolId()` An identity pool ID in the format REGION:GUID.
`java.util.Map<java.lang.String,java.lang.String>`	`getLogins()` A set of optional name-value pairs that map provider names to provider tokens.
`int`	`hashCode()`
`void`	`setAccountId(java.lang.String accountId)` A standard AWS account ID (9+ digits).
`void`	`setIdentityPoolId(java.lang.String identityPoolId)` An identity pool ID in the format REGION:GUID.
`void`	`setLogins(java.util.Map<java.lang.String,java.lang.String> logins)` A set of optional name-value pairs that map provider names to provider tokens.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetIdRequest`	`withAccountId(java.lang.String accountId)` A standard AWS account ID (9+ digits).
`GetIdRequest`	`withIdentityPoolId(java.lang.String identityPoolId)` An identity pool ID in the format REGION:GUID.
`GetIdRequest`	`withLogins(java.util.Map<java.lang.String,java.lang.String> logins)` A set of optional name-value pairs that map provider names to provider tokens.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetIdRequest
```
public GetIdRequest()
```
- Method Detail
  - getAccountId
```
public java.lang.String getAccountId()
```
    A standard AWS account ID (9+ digits).
    
    Constraints:
    Length: 1 - 15
    Pattern: \d+
    
    Returns:
    
    A standard AWS account ID (9+ digits).
  - setAccountId
```
public void setAccountId(java.lang.String accountId)
```
    A standard AWS account ID (9+ digits).
    
    Constraints:
    Length: 1 - 15
    Pattern: \d+
    
    Parameters:
    
    accountId -
    A standard AWS account ID (9+ digits).
  - withAccountId
```
public GetIdRequest withAccountId(java.lang.String 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+
    
    Parameters:
    
    accountId -
    A standard AWS account ID (9+ digits).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIdentityPoolId
```
public java.lang.String getIdentityPoolId()
```
    An identity pool ID in the format REGION:GUID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+:[0-9a-f-]+
    
    Returns:
    
    An identity pool ID in the format REGION:GUID.
  - setIdentityPoolId
```
public void setIdentityPoolId(java.lang.String identityPoolId)
```
    An identity pool ID in the format REGION:GUID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+:[0-9a-f-]+
    
    Parameters:
    
    identityPoolId -
    An identity pool ID in the format REGION:GUID.
  - withIdentityPoolId
```
public GetIdRequest withIdentityPoolId(java.lang.String 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-]+
    
    Parameters:
    
    identityPoolId -
    An identity pool ID in the format REGION:GUID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLogins
```
public java.util.Map<java.lang.String,java.lang.String> getLogins()
```
    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
    - Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
    - Google: accounts.google.com
    - Amazon: www.amazon.com
    - Twitter: api.twitter.com
    - Digits: www.digits.com
    Returns:
    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
    
    Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
    
    Google: accounts.google.com
    
    Amazon: www.amazon.com
    
    Twitter: api.twitter.com
    
    Digits: www.digits.com
  - setLogins
```
public void setLogins(java.util.Map<java.lang.String,java.lang.String> 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
    - Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
    - Google: accounts.google.com
    - Amazon: www.amazon.com
    - Twitter: api.twitter.com
    - Digits: www.digits.com
    Parameters:
    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
    
    Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
    
    Google: accounts.google.com
    
    Amazon: www.amazon.com
    
    Twitter: api.twitter.com
    
    Digits: www.digits.com
  - withLogins
```
public GetIdRequest withLogins(java.util.Map<java.lang.String,java.lang.String> 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
    - Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
    - 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.
    Parameters:
    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
    
    Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .
    
    Google: accounts.google.com
    
    Amazon: www.amazon.com
    
    Twitter: api.twitter.com
    
    Digits: www.digits.com
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addLoginsEntry
```
public GetIdRequest addLoginsEntry(java.lang.String key,
                                   java.lang.String value)
```
    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
    - Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
    - 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.
    Parameters:
    
    key - The key of the entry to be added into Logins.
    
    value - The corresponding value of the entry to be added into Logins.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearLoginsEntries
```
public GetIdRequest clearLoginsEntries()
```
    Removes all the entries added into Logins.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class GetIdRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetIdRequest

Method Detail

getAccountId

setAccountId

withAccountId

getIdentityPoolId

setIdentityPoolId

withIdentityPoolId

getLogins

setLogins

withLogins

addLoginsEntry

clearLoginsEntries

toString

hashCode

equals