software.amazon.awssdk.services.cognitosync.model

Class ListRecordsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitosync.model.CognitoSyncRequest

software.amazon.awssdk.services.cognitosync.model.ListRecordsRequest

All Implemented Interfaces:

ToCopyableBuilder<ListRecordsRequest.Builder,ListRecordsRequest>

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

A request for a list of records.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListRecordsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListRecordsRequest.Builder	builder()
String	datasetName() A string of up to 128 characters.
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()
String	identityId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
String	identityPoolId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
Long	lastSyncCount() The last server sync count for this record.
Integer	maxResults() The maximum number of results to be returned.
String	nextToken() A pagination token for obtaining the next page of results.
static Class<? extends ListRecordsRequest.Builder>	serializableBuilderClass()
String	syncSessionToken() A token containing a session ID, identity ID, and expiration.
ListRecordsRequest.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

requestOverrideConfig

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()

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

identityId

public String identityId()

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

datasetName

public String datasetName()

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Returns:

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

lastSyncCount

public Long lastSyncCount()

The last server sync count for this record.

Returns:

The last server sync count for this record.

nextToken

public String nextToken()

A pagination token for obtaining the next page of results.

Returns:

A pagination token for obtaining the next page of results.

maxResults

public Integer maxResults()

The maximum number of results to be returned.

Returns:

The maximum number of results to be returned.

syncSessionToken

public String syncSessionToken()

A token containing a session ID, identity ID, and expiration.

Returns:

A token containing a session ID, identity ID, and expiration.

toBuilder

public ListRecordsRequest.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<ListRecordsRequest.Builder,ListRecordsRequest>

Specified by:

toBuilder in class CognitoSyncRequest

Returns:

a builder for type T

builder

public static ListRecordsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListRecordsRequest.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