Interface GetRecordsResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>
,KinesisResponse.Builder
,SdkBuilder<GetRecordsResponse.Builder,GetRecordsResponse>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- GetRecordsResponse
public static interface GetRecordsResponse.Builder extends KinesisResponse.Builder, SdkPojo, CopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetRecordsResponse.Builder
childShards(Collection<ChildShard> childShards)
The list of the current shard's child shards, returned in theGetRecords
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 theGetRecords
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 theGetRecords
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.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.kinesis.model.KinesisResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
records
GetRecordsResponse.Builder records(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.
-
records
GetRecordsResponse.Builder records(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.
-
records
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 viaRecord.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#records(List
.) - Parameters:
records
- a consumer that will call methods onRecord.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#records(java.util.Collection
)
-
nextShardIterator
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.- Parameters:
nextShardIterator
- The next position in the shard from which to start sequentially reading data records. If set tonull
, the shard has been closed and the requested iterator does not return any more data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
millisBehindLatest
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.
- 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 that 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.
-
childShards
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.- Parameters:
childShards
- The list of the current shard's child shards, returned in theGetRecords
API's response only when the end of the current shard is reached.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childShards
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.- Parameters:
childShards
- The list of the current shard's child shards, returned in theGetRecords
API's response only when the end of the current shard is reached.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childShards
GetRecordsResponse.Builder childShards(Consumer<ChildShard.Builder>... childShards)
The list of the current shard's child shards, returned in the
This is a convenience method that creates an instance of theGetRecords
API's response only when the end of the current shard is reached.ChildShard.Builder
avoiding the need to create one manually viaChildShard.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#childShards(List
.) - Parameters:
childShards
- a consumer that will call methods onChildShard.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#childShards(java.util.Collection
)
-
-