Package software.amazon.awssdk.services.cognitoidentity.model

Class GetIdRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityRequest

software.amazon.awssdk.services.cognitoidentity.model.GetIdRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetIdRequest.Builder,GetIdRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetIdRequest
extends CognitoIdentityRequest
implements ToCopyableBuilder<GetIdRequest.Builder,GetIdRequest>

Input to the GetId action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetIdRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	A standard AWS account ID (9+ digits).
static GetIdRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLogins()	For responses, this returns true if the service returned a value for the Logins property.
String	identityPoolId()	An identity pool ID in the format REGION:GUID.
Map<String,String>	logins()	A set of optional name-value pairs that map provider names to provider tokens.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetIdRequest.Builder>	serializableBuilderClass()
GetIdRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accountId

public final String accountId()

A standard AWS account ID (9+ digits).

Returns:

A standard AWS account ID (9+ digits).

identityPoolId

public final String identityPoolId()

An identity pool ID in the format REGION:GUID.

Returns:

An identity pool ID in the format REGION:GUID.

hasLogins

public final boolean hasLogins()

For responses, this returns true if the service returned a value for the Logins property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

logins

public final Map<String,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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogins() method.

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

toBuilder

public GetIdRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetIdRequest.Builder,GetIdRequest>

Specified by:

toBuilder in class CognitoIdentityRequest

builder

public static GetIdRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetIdRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo