Package software.amazon.awssdk.services.dynamodb.model

Interface GetShardIteratorRequest.Builder

    • Method Detail

      • streamArn

        GetShardIteratorRequest.Builder streamArn​(String streamArn)

        The Amazon Resource Name (ARN) for the stream.

        Parameters:
        streamArn - The Amazon Resource Name (ARN) for the stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shardId

        GetShardIteratorRequest.Builder shardId​(String shardId)

        The identifier of the shard. The iterator will be returned for this shard ID.

        Parameters:
        shardId - The identifier of the shard. The iterator will be returned for this shard ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shardIteratorType

        GetShardIteratorRequest.Builder shardIteratorType​(String shardIteratorType)

        Determines how the shard iterator is used to start reading stream records from the shard:

        • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

        • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

        • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

        • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

        Parameters:
        shardIteratorType - Determines how the shard iterator is used to start reading stream records from the shard:

        • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

        • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

        • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

        • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShardIteratorType, ShardIteratorType

      • shardIteratorType

        GetShardIteratorRequest.Builder shardIteratorType​(ShardIteratorType shardIteratorType)

        Determines how the shard iterator is used to start reading stream records from the shard:

        • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

        • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

        • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

        • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

        Parameters:
        shardIteratorType - Determines how the shard iterator is used to start reading stream records from the shard:

        • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

        • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

        • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

        • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShardIteratorType, ShardIteratorType

      • sequenceNumber

        GetShardIteratorRequest.Builder sequenceNumber​(String sequenceNumber)

        The sequence number of a stream record in the shard from which to start reading.

        Parameters:
        sequenceNumber - The sequence number of a stream record in the shard from which to start reading.
        Returns:
        Returns a reference to this object so that method calls can be chained together.