public static interface GetRecordsResponse.Builder extends KinesisResponse.Builder, SdkPojo, CopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>
Modifier and Type | Method and Description |
---|---|
GetRecordsResponse.Builder |
childShards(ChildShard... childShards)
The list of the current shard's child shards, returned in the
GetRecords API's response only
when the end of the current shard is reached. |
GetRecordsResponse.Builder |
childShards(Collection<ChildShard> childShards)
The list of the current shard's child shards, returned in the
GetRecords API's response only
when the end of the current shard is reached. |
GetRecordsResponse.Builder |
childShards(Consumer<ChildShard.Builder>... childShards)
The list of the current shard's child shards, returned in the
GetRecords API's response only
when the end of the current shard is reached. |
GetRecordsResponse.Builder |
millisBehindLatest(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.
|
GetRecordsResponse.Builder |
nextShardIterator(String nextShardIterator)
The next position in the shard from which to start sequentially reading data records.
|
GetRecordsResponse.Builder |
records(Collection<Record> records)
The data records retrieved from the shard.
|
GetRecordsResponse.Builder |
records(Consumer<Record.Builder>... records)
The data records retrieved from the shard.
|
GetRecordsResponse.Builder |
records(Record... records)
The data records retrieved from the shard.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
GetRecordsResponse.Builder records(Collection<Record> records)
The data records retrieved from the shard.
records
- The data records retrieved from the shard.GetRecordsResponse.Builder records(Record... records)
The data records retrieved from the shard.
records
- The data records retrieved from the shard.GetRecordsResponse.Builder records(Consumer<Record.Builder>... records)
The data records retrieved from the shard.
This is a convenience method that creates an instance of theRecord.Builder
avoiding the need to create one manually
via Record.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately and its
result is passed to #records(List
.
records
- a consumer that will call methods on
Record.Builder
#records(java.util.Collection)
GetRecordsResponse.Builder nextShardIterator(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 does not return any more data.
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 does not return any more data.GetRecordsResponse.Builder millisBehindLatest(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 that record processing is caught up, and there are no new records to process at this moment.
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 that record processing is
caught up, and there are no new records to process at this moment.GetRecordsResponse.Builder childShards(Collection<ChildShard> childShards)
The list of the current shard's child shards, returned in the GetRecords
API's response only
when the end of the current shard is reached.
childShards
- The list of the current shard's child shards, returned in the GetRecords
API's response
only when the end of the current shard is reached.GetRecordsResponse.Builder childShards(ChildShard... childShards)
The list of the current shard's child shards, returned in the GetRecords
API's response only
when the end of the current shard is reached.
childShards
- The list of the current shard's child shards, returned in the GetRecords
API's response
only when the end of the current shard is reached.GetRecordsResponse.Builder childShards(Consumer<ChildShard.Builder>... childShards)
The list of the current shard's child shards, returned in the GetRecords
API's response only
when the end of the current shard is reached.
ChildShard.Builder
avoiding the need to create one
manually via ChildShard.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately and
its result is passed to #childShards(List
.
childShards
- a consumer that will call methods on
ChildShard.Builder
#childShards(java.util.Collection)
Copyright © 2023. All rights reserved.