Interface GetShardIteratorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>, KeyspacesStreamsRequest.Builder, SdkBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetShardIteratorRequest
@Mutable @NotThreadSafe public static interface GetShardIteratorRequest.Builder extends KeyspacesStreamsRequest.Builder, SdkPojo, CopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>

  • Method Details

    • streamArn

      GetShardIteratorRequest.Builder streamArn(String streamArn)

      The Amazon Resource Name (ARN) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.

      Parameters:
      streamArn - The Amazon Resource Name (ARN) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.
      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 within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access.

      Parameters:
      shardId - The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access.
      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 positioned. Must be one of the following:

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

      • AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

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

      Parameters:
      shardIteratorType - Determines how the shard iterator is positioned. Must be one of the following:

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

      • AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

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

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

    • shardIteratorType

      GetShardIteratorRequest.Builder shardIteratorType(ShardIteratorType shardIteratorType)

      Determines how the shard iterator is positioned. Must be one of the following:

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

      • AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

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

      Parameters:
      shardIteratorType - Determines how the shard iterator is positioned. Must be one of the following:

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

      • AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

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

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

    • sequenceNumber

      GetShardIteratorRequest.Builder sequenceNumber(String sequenceNumber)

      The sequence number of the data record in the shard from which to start reading. Required if ShardIteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. This parameter is ignored for other iterator types.

      Parameters:
      sequenceNumber - The sequence number of the data record in the shard from which to start reading. Required if ShardIteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. This parameter is ignored for other iterator types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetShardIteratorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetShardIteratorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.