Class GetRecordsResult

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

public class GetRecordsResult extends Object implements Serializable, Cloneable

Represents the output for GetRecords.

See Also:
  • Constructor Details

    • GetRecordsResult

      public GetRecordsResult()
  • Method Details

    • getRecords

      public List<Record> getRecords()

      The data records retrieved from the shard.

      Returns:
      The data records retrieved from the shard.
    • setRecords

      public void setRecords(Collection<Record> records)

      The data records retrieved from the shard.

      Parameters:
      records - The data records retrieved from the shard.
    • withRecords

      public GetRecordsResult withRecords(Record... records)

      The data records retrieved from the shard.

      NOTE: This method appends the values to the existing list (if any). Use setRecords(java.util.Collection) or withRecords(java.util.Collection) if you want to override the existing values.

      Parameters:
      records - The data records retrieved from the shard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withRecords

      public GetRecordsResult withRecords(Collection<Record> records)

      The data records retrieved from the shard.

      Parameters:
      records - The data records retrieved from the shard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNextShardIterator

      public void setNextShardIterator(String nextShardIterator)

      The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

      Parameters:
      nextShardIterator - The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.
    • getNextShardIterator

      public String getNextShardIterator()

      The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

      Returns:
      The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.
    • withNextShardIterator

      public GetRecordsResult withNextShardIterator(String nextShardIterator)

      The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

      Parameters:
      nextShardIterator - The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMillisBehindLatest

      public void setMillisBehindLatest(Long millisBehindLatest)

      The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

      Parameters:
      millisBehindLatest - The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
    • getMillisBehindLatest

      public Long getMillisBehindLatest()

      The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

      Returns:
      The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
    • withMillisBehindLatest

      public GetRecordsResult withMillisBehindLatest(Long millisBehindLatest)

      The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

      Parameters:
      millisBehindLatest - The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
      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 GetRecordsResult clone()
      Overrides:
      clone in class Object