Struct aws_sdk_dynamodbstreams::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder

#[non_exhaustive]
pub struct GetShardIteratorInputBuilder { /* private fields */ }

A builder for GetShardIteratorInput.

Implementations

impl GetShardIteratorInputBuilder

pub fn stream_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the stream.

This field is required.

pub fn set_stream_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the stream.

pub fn get_stream_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the stream.

pub fn shard_id(self, input: impl Into<String>) -> Self

The identifier of the shard. The iterator will be returned for this shard ID.

This field is required.

pub fn set_shard_id(self, input: Option<String>) -> Self

The identifier of the shard. The iterator will be returned for this shard ID.

pub fn get_shard_id(&self) -> &Option<String>

The identifier of the shard. The iterator will be returned for this shard ID.

pub fn shard_iterator_type(self, input: ShardIteratorType) -> Self

Determines how the shard iterator is used to start reading stream records from the shard:

• AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

• TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

This field is required.

pub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self

Determines how the shard iterator is used to start reading stream records from the shard:

• AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

• TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

pub fn get_shard_iterator_type(&self) -> &Option<ShardIteratorType>

Determines how the shard iterator is used to start reading stream records from the shard:

• AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

• TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

pub fn sequence_number(self, input: impl Into<String>) -> Self

The sequence number of a stream record in the shard from which to start reading.

pub fn set_sequence_number(self, input: Option<String>) -> Self

The sequence number of a stream record in the shard from which to start reading.

pub fn get_sequence_number(&self) -> &Option<String>

The sequence number of a stream record in the shard from which to start reading.

pub fn build(self) -> Result<GetShardIteratorInput, BuildError>

Consumes the builder and constructs a GetShardIteratorInput.

impl GetShardIteratorInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetShardIteratorOutput, SdkError<GetShardIteratorError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetShardIteratorInputBuilder

fn clone(&self) -> GetShardIteratorInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetShardIteratorInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetShardIteratorInputBuilder

fn default() -> GetShardIteratorInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetShardIteratorInputBuilder

fn eq(&self, other: &GetShardIteratorInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetShardIteratorInputBuilder