ListRecordsRequest (AWS SDK for Android - Amazon Cognito Sync 2.2.16 API)

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. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

See Also:

AmazonCognitoSync.listRecords(ListRecordsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListRecordsRequest()

Constructors
Constructor and Description
`ListRecordsRequest()`

Method Summary

All Methods Instance Methods Concrete 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.
`String`	`getLastSyncCount()` The last server sync count for this record.
`String`	`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(String lastSyncCount)` The last server sync count for this record.
`void`	`setMaxResults(String 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(String lastSyncCount)` The last server sync count for this record.
`ListRecordsRequest`	`withMaxResults(String 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
getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, 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 - 55
    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 - 55
    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 - 55
    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 - 55
    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 - 55
    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 - 55
    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 String 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(String 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(String 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 String 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(String 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(String 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

Class ListRecordsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListRecordsRequest

Method Detail

getIdentityPoolId

setIdentityPoolId

withIdentityPoolId

getIdentityId

setIdentityId

withIdentityId

getDatasetName

setDatasetName

withDatasetName

getLastSyncCount

setLastSyncCount

withLastSyncCount

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

getSyncSessionToken

setSyncSessionToken

withSyncSessionToken

toString

hashCode

equals