com.amazonaws.services.cognitosync.model

Class ListRecordsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitosync.model.ListRecordsRequest

All Implemented Interfaces:

Serializable

public class ListRecordsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListRecords operation.

Gets paginated records, optionally changed after a particular sync count for a dataset and identity.

See Also:

AmazonCognitoSync.listRecords(ListRecordsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListRecordsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDatasetName() A string of up to 128 characters.
String	getIdentityId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
String	getIdentityPoolId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
Long	getLastSyncCount() The last server sync count for this record.
Integer	getMaxResults() The maximum number of results to be returned.
String	getNextToken() A pagination token for obtaining the next page of results.
String	getSyncSessionToken() A token containing a session ID, identity ID, and expiration.
int	hashCode()
void	setDatasetName(String datasetName) A string of up to 128 characters.
void	setIdentityId(String identityId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
void	setIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
void	setLastSyncCount(Long lastSyncCount) The last server sync count for this record.
void	setMaxResults(Integer maxResults) The maximum number of results to be returned.
void	setNextToken(String nextToken) A pagination token for obtaining the next page of results.
void	setSyncSessionToken(String syncSessionToken) A token containing a session ID, identity ID, and expiration.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListRecordsRequest	withDatasetName(String datasetName) A string of up to 128 characters.
ListRecordsRequest	withIdentityId(String identityId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
ListRecordsRequest	withIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
ListRecordsRequest	withLastSyncCount(Long lastSyncCount) The last server sync count for this record.
ListRecordsRequest	withMaxResults(Integer maxResults) The maximum number of results to be returned.
ListRecordsRequest	withNextToken(String nextToken) A pagination token for obtaining the next page of results.
ListRecordsRequest	withSyncSessionToken(String syncSessionToken) A token containing a session ID, identity ID, and expiration.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListRecordsRequest

public ListRecordsRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

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.

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

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.

setIdentityPoolId

public void setIdentityPoolId(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.

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

Parameters:

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.

withIdentityPoolId

public ListRecordsRequest withIdentityPoolId(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 reference to this object so that method calls can be chained together.

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

Parameters:

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 reference to this updated object so that method calls can be chained together.

getIdentityId

public String getIdentityId()

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.

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

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.

setIdentityId

public void setIdentityId(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.

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

Parameters:

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.

withIdentityId

public ListRecordsRequest withIdentityId(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 reference to this object so that method calls can be chained together.

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

Parameters:

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 reference to this updated object so that method calls can be chained together.

getDatasetName

public String getDatasetName()

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+

Returns:

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

setDatasetName

public void setDatasetName(String datasetName)

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+

Parameters:

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

withDatasetName

public ListRecordsRequest withDatasetName(String datasetName)

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

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+

Parameters:

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

Returns:

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

getLastSyncCount

public Long getLastSyncCount()

The last server sync count for this record.

Constraints:
Length: 0 - 19
Pattern: \d+

Returns:

The last server sync count for this record.

setLastSyncCount

public void setLastSyncCount(Long lastSyncCount)

The last server sync count for this record.

Constraints:
Length: 0 - 19
Pattern: \d+

Parameters:

lastSyncCount - The last server sync count for this record.

withLastSyncCount

public ListRecordsRequest withLastSyncCount(Long lastSyncCount)

The last server sync count for this record.

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

Constraints:
Length: 0 - 19
Pattern: \d+

Parameters:

lastSyncCount - The last server sync count for this record.

Returns:

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

getNextToken

public String getNextToken()

A pagination token for obtaining the next page of results.

Returns:

A pagination token for obtaining the next page of results.

setNextToken

public void setNextToken(String nextToken)

A pagination token for obtaining the next page of results.

Parameters:

nextToken - A pagination token for obtaining the next page of results.

withNextToken

public ListRecordsRequest withNextToken(String nextToken)

A pagination token for obtaining the next page of results.

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

Parameters:

nextToken - A pagination token for obtaining the next page of results.

Returns:

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

getMaxResults

public Integer getMaxResults()

The maximum number of results to be returned.

Constraints:
Length: 0 - 19
Pattern: \d+

Returns:

The maximum number of results to be returned.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to be returned.

Constraints:
Length: 0 - 19
Pattern: \d+

Parameters:

maxResults - The maximum number of results to be returned.

withMaxResults

public ListRecordsRequest withMaxResults(Integer maxResults)

The maximum number of results to be returned.

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

Constraints:
Length: 0 - 19
Pattern: \d+

Parameters:

maxResults - The maximum number of results to be returned.

Returns:

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

getSyncSessionToken

public String getSyncSessionToken()

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

Returns:

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

setSyncSessionToken

public void setSyncSessionToken(String syncSessionToken)

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

Parameters:

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

withSyncSessionToken

public ListRecordsRequest withSyncSessionToken(String syncSessionToken)

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

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

Parameters:

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

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