Class ListRecordsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.cognitosync.model.ListRecordsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ListRecordsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
A request for a list of records.
See Also:
  • Constructor Details

    • ListRecordsRequest

      public ListRecordsRequest()
  • Method Details

    • 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.
      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.
    • 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.
      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.
    • 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.
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
      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.
    • 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.
      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.
    • 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.
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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).
      Parameters:
      datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
    • getDatasetName

      public String getDatasetName()
      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).
    • 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).
      Parameters:
      datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLastSyncCount

      public void setLastSyncCount(Long lastSyncCount)
      The last server sync count for this record.
      Parameters:
      lastSyncCount - The last server sync count for this record.
    • getLastSyncCount

      public Long getLastSyncCount()
      The last server sync count for this record.
      Returns:
      The last server sync count for this record.
    • withLastSyncCount

      public ListRecordsRequest withLastSyncCount(Long lastSyncCount)
      The last server sync count for this record.
      Parameters:
      lastSyncCount - The last server sync count for this record.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • withNextToken

      public ListRecordsRequest withNextToken(String nextToken)
      A pagination token for obtaining the next page of results.
      Parameters:
      nextToken - A pagination token for obtaining the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMaxResults

      public void setMaxResults(Integer maxResults)
      The maximum number of results to be returned.
      Parameters:
      maxResults - The maximum number of results to be returned.
    • getMaxResults

      public Integer getMaxResults()
      The maximum number of results to be returned.
      Returns:
      The maximum number of results to be returned.
    • withMaxResults

      public ListRecordsRequest withMaxResults(Integer maxResults)
      The maximum number of results to be returned.
      Parameters:
      maxResults - The maximum number of results to be returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • withSyncSessionToken

      public ListRecordsRequest withSyncSessionToken(String syncSessionToken)
      A token containing a session ID, identity ID, and expiration.
      Parameters:
      syncSessionToken - A token containing a session ID, identity ID, and expiration.
      Returns:
      Returns a reference to this 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ListRecordsRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: