Interface SubscribeToShardEvent.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SubscribeToShardEvent.Builder,
,SubscribeToShardEvent> SdkBuilder<SubscribeToShardEvent.Builder,
,SubscribeToShardEvent> SdkPojo
- Enclosing class:
SubscribeToShardEvent
-
Method Summary
Modifier and TypeMethodDescriptionchildShards
(Collection<ChildShard> childShards) The list of the child shards of the current shard, returned only at the end of the current shard.childShards
(Consumer<ChildShard.Builder>... childShards) The list of the child shards of the current shard, returned only at the end of the current shard.childShards
(ChildShard... childShards) The list of the child shards of the current shard, returned only at the end of the current shard.continuationSequenceNumber
(String continuationSequenceNumber) Use this asSequenceNumber
in the next call to SubscribeToShard, withStartingPosition
set toAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
.millisBehindLatest
(Long millisBehindLatest) The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is.records
(Collection<Record> records) records
(Consumer<Record.Builder>... records) This is a convenience method that creates an instance of theRecord.Builder
avoiding the need to create one manually viaRecord.builder()
.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
records
- Parameters:
records
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
records
- Parameters:
records
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
records
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 torecords(List<Record>)
.- 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:
-
continuationSequenceNumber
Use this as
SequenceNumber
in the next call to SubscribeToShard, withStartingPosition
set toAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
. UseContinuationSequenceNumber
for checkpointing because it captures your shard progress even when no data is written to the shard.- Parameters:
continuationSequenceNumber
- Use this asSequenceNumber
in the next call to SubscribeToShard, withStartingPosition
set toAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
. UseContinuationSequenceNumber
for checkpointing because it captures your shard progress even when no data is written to the shard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
millisBehindLatest
The number of milliseconds the read records are 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 read records are 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
The list of the child shards of the current shard, returned only at the end of the current shard.
- Parameters:
childShards
- The list of the child shards of the current shard, returned only at the end of the current shard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childShards
The list of the child shards of the current shard, returned only at the end of the current shard.
- Parameters:
childShards
- The list of the child shards of the current shard, returned only at the end of the current shard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childShards
The list of the child shards of the current shard, returned only at the end of the current shard.
This is a convenience method that creates an instance of theChildShard.Builder
avoiding the need to create one manually viaChildShard.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochildShards(List<ChildShard>)
.- 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:
-