software.amazon.awssdk.services.cognitoidentity.model

Class ListIdentitiesRequest

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.ListIdentitiesRequest

All Implemented Interfaces:

ToCopyableBuilder<ListIdentitiesRequest.Builder,ListIdentitiesRequest>

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

Input to the ListIdentities action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListIdentitiesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListIdentitiesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Boolean	hideDisabled() An optional boolean parameter that allows you to hide disabled identities.
String	identityPoolId() An identity pool ID in the format REGION:GUID.
Integer	maxResults() The maximum number of identities to return.
String	nextToken() A pagination token.
static Class<? extends ListIdentitiesRequest.Builder>	serializableBuilderClass()
ListIdentitiesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

identityPoolId

public String identityPoolId()

An identity pool ID in the format REGION:GUID.

Returns:

An identity pool ID in the format REGION:GUID.

maxResults

public Integer maxResults()

The maximum number of identities to return.

Returns:

The maximum number of identities to return.

nextToken

public String nextToken()

A pagination token.

Returns:

A pagination token.

hideDisabled

public Boolean hideDisabled()

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Returns:

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

toBuilder

public ListIdentitiesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListIdentitiesRequest.Builder,ListIdentitiesRequest>

Specified by:

toBuilder in class CognitoIdentityRequest

Returns:

a builder for type T

builder

public static ListIdentitiesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value