Package software.amazon.awssdk.services.kinesis.model

Interface SubscribeToShardEvent.Builder

    • Method Detail

      • records

        SubscribeToShardEvent.Builder records​(Record... records)

        Parameters:
        records -
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • continuationSequenceNumber

        SubscribeToShardEvent.Builder continuationSequenceNumber​(String continuationSequenceNumber)

        Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

        Parameters:
        continuationSequenceNumber - Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber 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

        SubscribeToShardEvent.Builder 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. 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

        SubscribeToShardEvent.Builder childShards​(Collection<ChildShard> 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

        SubscribeToShardEvent.Builder childShards​(ChildShard... 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

        SubscribeToShardEvent.Builder childShards​(Consumer<ChildShard.Builder>... 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 the 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).

        Parameters:
        childShards - a consumer that will call methods on ChildShard.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #childShards(java.util.Collection)