Struct aws_sdk_dynamodbstreams::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder
source · #[non_exhaustive]pub struct GetShardIteratorInputBuilder { /* private fields */ }
Expand description
A builder for GetShardIteratorInput
.
Implementations§
source§impl GetShardIteratorInputBuilder
impl GetShardIteratorInputBuilder
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
This field is required.sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the stream.
sourcepub fn shard_id(self, input: impl Into<String>) -> Self
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.sourcepub fn set_shard_id(self, input: Option<String>) -> Self
pub fn set_shard_id(self, input: Option<String>) -> Self
The identifier of the shard. The iterator will be returned for this shard ID.
sourcepub fn get_shard_id(&self) -> &Option<String>
pub fn get_shard_id(&self) -> &Option<String>
The identifier of the shard. The iterator will be returned for this shard ID.
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 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.
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 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.
sourcepub fn get_shard_iterator_type(&self) -> &Option<ShardIteratorType>
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.
sourcepub fn sequence_number(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_sequence_number(self, input: Option<String>) -> Self
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.
sourcepub fn get_sequence_number(&self) -> &Option<String>
pub fn get_sequence_number(&self) -> &Option<String>
The sequence number of a stream record in the shard from which to start reading.
sourcepub fn build(self) -> Result<GetShardIteratorInput, BuildError>
pub fn build(self) -> Result<GetShardIteratorInput, BuildError>
Consumes the builder and constructs a GetShardIteratorInput
.
source§impl GetShardIteratorInputBuilder
impl GetShardIteratorInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<GetShardIteratorOutput, SdkError<GetShardIteratorError, HttpResponse>>
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§
source§impl Clone for GetShardIteratorInputBuilder
impl Clone for GetShardIteratorInputBuilder
source§fn clone(&self) -> GetShardIteratorInputBuilder
fn clone(&self) -> GetShardIteratorInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GetShardIteratorInputBuilder
impl Debug for GetShardIteratorInputBuilder
source§impl Default for GetShardIteratorInputBuilder
impl Default for GetShardIteratorInputBuilder
source§fn default() -> GetShardIteratorInputBuilder
fn default() -> GetShardIteratorInputBuilder
source§impl PartialEq for GetShardIteratorInputBuilder
impl PartialEq for GetShardIteratorInputBuilder
source§fn eq(&self, other: &GetShardIteratorInputBuilder) -> bool
fn eq(&self, other: &GetShardIteratorInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for GetShardIteratorInputBuilder
Auto Trait Implementations§
impl Freeze for GetShardIteratorInputBuilder
impl RefUnwindSafe for GetShardIteratorInputBuilder
impl Send for GetShardIteratorInputBuilder
impl Sync for GetShardIteratorInputBuilder
impl Unpin for GetShardIteratorInputBuilder
impl UnwindSafe for GetShardIteratorInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more