Struct aws_sdk_kinesis::input::get_shard_iterator_input::Builder
source · pub struct Builder { /* private fields */ }
Expand description
A builder for GetShardIteratorInput
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The name of the Amazon Kinesis data stream.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the Amazon Kinesis data stream.
sourcepub fn shard_id(self, input: impl Into<String>) -> Self
pub fn shard_id(self, input: impl Into<String>) -> Self
The shard ID of the Kinesis Data Streams shard to get the iterator for.
sourcepub fn set_shard_id(self, input: Option<String>) -> Self
pub fn set_shard_id(self, input: Option<String>) -> Self
The shard ID of the Kinesis Data Streams shard to get the iterator for.
sourcepub fn shard_iterator_type(self, input: ShardIteratorType) -> Self
pub fn shard_iterator_type(self, input: ShardIteratorType) -> Self
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.
sourcepub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self
pub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self
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.
sourcepub fn starting_sequence_number(self, input: impl Into<String>) -> Self
pub fn starting_sequence_number(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_starting_sequence_number(self, input: Option<String>) -> Self
pub fn set_starting_sequence_number(self, input: Option<String>) -> Self
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.
sourcepub fn timestamp(self, input: DateTime) -> Self
pub fn timestamp(self, input: DateTime) -> Self
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).
sourcepub fn set_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_timestamp(self, input: Option<DateTime>) -> Self
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).
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The ARN of the stream.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The ARN of the stream.
sourcepub fn build(self) -> Result<GetShardIteratorInput, BuildError>
pub fn build(self) -> Result<GetShardIteratorInput, BuildError>
Consumes the builder and constructs a GetShardIteratorInput
.