Class GetRecordsRequest

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

public class GetRecordsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the input for GetRecords.

See Also:
  • Constructor Details

    • GetRecordsRequest

      public GetRecordsRequest()
  • Method Details

    • setShardIterator

      public void setShardIterator(String shardIterator)

      The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

      Parameters:
      shardIterator - The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
    • getShardIterator

      public String getShardIterator()

      The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

      Returns:
      The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
    • withShardIterator

      public GetRecordsRequest withShardIterator(String shardIterator)

      The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

      Parameters:
      shardIterator - The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLimit

      public void setLimit(Integer limit)

      The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

      Parameters:
      limit - The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
    • getLimit

      public Integer getLimit()

      The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

      Returns:
      The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
    • withLimit

      public GetRecordsRequest withLimit(Integer limit)

      The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

      Parameters:
      limit - The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
      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 GetRecordsRequest 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: