pub struct GetRecordsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetRecords
.
Retrieves the stream records from a given shard.
Specify a shard iterator using the ShardIterator
parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords
returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.
GetRecords
can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.
Implementations§
source§impl GetRecordsFluentBuilder
impl GetRecordsFluentBuilder
sourcepub fn as_input(&self) -> &GetRecordsInputBuilder
pub fn as_input(&self) -> &GetRecordsInputBuilder
Access the GetRecords as a reference.
sourcepub async fn send(
self
) -> Result<GetRecordsOutput, SdkError<GetRecordsError, HttpResponse>>
pub async fn send( self ) -> Result<GetRecordsOutput, SdkError<GetRecordsError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<GetRecordsOutput, GetRecordsError, Self>, SdkError<GetRecordsError>>
pub async fn customize( self ) -> Result<CustomizableOperation<GetRecordsOutput, GetRecordsError, Self>, SdkError<GetRecordsError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn shard_iterator(self, input: impl Into<String>) -> Self
pub fn shard_iterator(self, input: impl Into<String>) -> Self
A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
sourcepub fn set_shard_iterator(self, input: Option<String>) -> Self
pub fn set_shard_iterator(self, input: Option<String>) -> Self
A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
sourcepub fn get_shard_iterator(&self) -> &Option<String>
pub fn get_shard_iterator(&self) -> &Option<String>
A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of records to return from the shard. The upper limit is 1000.
Trait Implementations§
source§impl Clone for GetRecordsFluentBuilder
impl Clone for GetRecordsFluentBuilder
source§fn clone(&self) -> GetRecordsFluentBuilder
fn clone(&self) -> GetRecordsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more