Struct aws_sdk_kinesis::input::GetShardIteratorInput
source · #[non_exhaustive]pub struct GetShardIteratorInput { /* private fields */ }
Expand description
Represents the input for GetShardIterator
.
Implementations§
source§impl GetShardIteratorInput
impl GetShardIteratorInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetShardIterator, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetShardIterator, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<GetShardIterator
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture GetShardIteratorInput
.
source§impl GetShardIteratorInput
impl GetShardIteratorInput
sourcepub fn stream_name(&self) -> Option<&str>
pub fn stream_name(&self) -> Option<&str>
The name of the Amazon Kinesis data stream.
sourcepub fn shard_id(&self) -> Option<&str>
pub fn shard_id(&self) -> Option<&str>
The shard ID of the Kinesis Data Streams shard to get the iterator for.
sourcepub fn shard_iterator_type(&self) -> Option<&ShardIteratorType>
pub fn shard_iterator_type(&self) -> Option<&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.
sourcepub fn starting_sequence_number(&self) -> Option<&str>
pub fn starting_sequence_number(&self) -> Option<&str>
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) -> Option<&DateTime>
pub fn timestamp(&self) -> Option<&DateTime>
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) -> Option<&str>
pub fn stream_arn(&self) -> Option<&str>
The ARN of the stream.
Trait Implementations§
source§impl Clone for GetShardIteratorInput
impl Clone for GetShardIteratorInput
source§fn clone(&self) -> GetShardIteratorInput
fn clone(&self) -> GetShardIteratorInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GetShardIteratorInput
impl Debug for GetShardIteratorInput
source§impl PartialEq<GetShardIteratorInput> for GetShardIteratorInput
impl PartialEq<GetShardIteratorInput> for GetShardIteratorInput
source§fn eq(&self, other: &GetShardIteratorInput) -> bool
fn eq(&self, other: &GetShardIteratorInput) -> bool
self
and other
values to be equal, and is used
by ==
.