public static interface GetShardIteratorRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
Modifier and Type | Method and Description |
---|---|
GetShardIteratorRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GetShardIteratorRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
GetShardIteratorRequest.Builder |
shardId(String shardId)
The shard ID of the Kinesis Data Streams shard to get the iterator for.
|
GetShardIteratorRequest.Builder |
shardIteratorType(ShardIteratorType shardIteratorType)
Determines how the shard iterator is used to start reading data records from the shard.
|
GetShardIteratorRequest.Builder |
shardIteratorType(String shardIteratorType)
Determines how the shard iterator is used to start reading data records from the shard.
|
GetShardIteratorRequest.Builder |
startingSequenceNumber(String startingSequenceNumber)
The sequence number of the data record in the shard from which to start reading.
|
GetShardIteratorRequest.Builder |
streamName(String streamName)
The name of the Amazon Kinesis data stream.
|
GetShardIteratorRequest.Builder |
timestamp(Instant timestamp)
The time stamp of the data record from which to start reading.
|
build
overrideConfiguration
copy
applyMutation, build
GetShardIteratorRequest.Builder streamName(String streamName)
The name of the Amazon Kinesis data stream.
streamName
- The name of the Amazon Kinesis data stream.GetShardIteratorRequest.Builder shardId(String shardId)
The shard ID of the Kinesis Data Streams shard to get the iterator for.
shardId
- The shard ID of the Kinesis Data Streams shard to get the iterator for.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.
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.
ShardIteratorType
,
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.
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.
ShardIteratorType
,
ShardIteratorType
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.
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.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).
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).GetShardIteratorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
GetShardIteratorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2019. All rights reserved.