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

Interface GetShardIteratorRequest.Builder

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

  • Method Details

    • streamName

      GetShardIteratorRequest.Builder streamName(String streamName)

      The name of the Amazon Kinesis data stream.

      Parameters:
      streamName - The name of the Amazon Kinesis data stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shardId

      GetShardIteratorRequest.Builder shardId(String shardId)

      The shard ID of the Kinesis Data Streams shard to get the iterator for.

      Parameters:
      shardId - The shard ID of the Kinesis Data Streams shard to get the iterator for.
      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 data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

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

      • LATEST - Start reading just after the most recent 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 data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

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

      • LATEST - Start reading just after the most recent 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

      GetShardIteratorRequest.Builder shardIteratorType(ShardIteratorType shardIteratorType)

      Determines how the shard iterator is used to start reading data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

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

      • LATEST - Start reading just after the most recent 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 data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

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

      • LATEST - Start reading just after the most recent 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:

    • startingSequenceNumber

      GetShardIteratorRequest.Builder startingSequenceNumber(String startingSequenceNumber)

      The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

      Parameters:
      startingSequenceNumber - The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timestamp

      GetShardIteratorRequest.Builder timestamp(Instant timestamp)

      The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

      Parameters:
      timestamp - The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamARN

      GetShardIteratorRequest.Builder streamARN(String streamARN)

      The ARN of the stream.

      Parameters:
      streamARN - The ARN of the stream.
      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.