public class GetRecordsResult extends Object implements Serializable, Cloneable
Represents the output for GetRecords.
Constructor and Description |
---|
GetRecordsResult() |
Modifier and Type | Method and Description |
---|---|
GetRecordsResult |
clone() |
boolean |
equals(Object obj) |
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.
|
String |
getNextShardIterator()
The next position in the shard from which to start sequentially
reading data records.
|
List<Record> |
getRecords()
The data records retrieved from the shard.
|
int |
hashCode() |
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.
|
void |
setNextShardIterator(String nextShardIterator)
The next position in the shard from which to start sequentially
reading data records.
|
void |
setRecords(Collection<Record> records)
The data records retrieved from the shard.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
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.
|
GetRecordsResult |
withNextShardIterator(String nextShardIterator)
The next position in the shard from which to start sequentially
reading data records.
|
GetRecordsResult |
withRecords(Collection<Record> records)
The data records retrieved from the shard.
|
GetRecordsResult |
withRecords(Record... records)
The data records retrieved from the shard.
|
public List<Record> getRecords()
The data records retrieved from the shard.
The data records retrieved from the shard.
public void setRecords(Collection<Record> records)
The data records retrieved from the shard.
records
- The data records retrieved from the shard.
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.
Returns a reference to this object so that method calls can be chained together.
records
- The data records retrieved from the shard.
public GetRecordsResult withRecords(Collection<Record> records)
The data records retrieved from the shard.
Returns a reference to this object so that method calls can be chained together.
records
- The data records retrieved from the shard.
public String getNextShardIterator()
null
, the shard has been
closed and the requested iterator will not return any more data.
Constraints:
Length: 1 - 512
null
, the shard has been
closed and the requested iterator will not return any more data.public void setNextShardIterator(String nextShardIterator)
null
, the shard has been
closed and the requested iterator will not return any more data.
Constraints:
Length: 1 - 512
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.public GetRecordsResult withNextShardIterator(String nextShardIterator)
null
, the shard has been
closed and the requested iterator will not return any more data.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 512
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.public Long getMillisBehindLatest()
Constraints:
Range: 0 -
public void setMillisBehindLatest(Long millisBehindLatest)
Constraints:
Range: 0 -
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.public GetRecordsResult withMillisBehindLatest(Long millisBehindLatest)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 -
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.public String toString()
toString
in class Object
Object.toString()
public GetRecordsResult clone()
Copyright © 2015. All rights reserved.