aws_sdk_dynamodbstreams/operation/get_records/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_records::_get_records_output::GetRecordsOutputBuilder;
3
4pub use crate::operation::get_records::_get_records_input::GetRecordsInputBuilder;
5
6impl crate::operation::get_records::builders::GetRecordsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::get_records::GetRecordsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_records::GetRecordsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_records();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetRecords`.
24///
25/// <p>Retrieves the stream records from a given shard.</p>
26/// <p>Specify a shard iterator using the <code>ShardIterator</code> 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, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.</p><note>
27/// <p><code>GetRecords</code> can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.</p>
28/// </note>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct GetRecordsFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::get_records::builders::GetRecordsInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::get_records::GetRecordsOutput,
38        crate::operation::get_records::GetRecordsError,
39    > for GetRecordsFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::get_records::GetRecordsOutput,
47            crate::operation::get_records::GetRecordsError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl GetRecordsFluentBuilder {
54    /// Creates a new `GetRecordsFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the GetRecords as a reference.
63    pub fn as_input(&self) -> &crate::operation::get_records::builders::GetRecordsInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::get_records::GetRecordsOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::get_records::GetRecordsError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::get_records::GetRecords::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::get_records::GetRecords::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::get_records::GetRecordsOutput,
100        crate::operation::get_records::GetRecordsError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</p>
115    pub fn shard_iterator(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.shard_iterator(input.into());
117        self
118    }
119    /// <p>A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</p>
120    pub fn set_shard_iterator(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.inner = self.inner.set_shard_iterator(input);
122        self
123    }
124    /// <p>A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</p>
125    pub fn get_shard_iterator(&self) -> &::std::option::Option<::std::string::String> {
126        self.inner.get_shard_iterator()
127    }
128    /// <p>The maximum number of records to return from the shard. The upper limit is 1000.</p>
129    pub fn limit(mut self, input: i32) -> Self {
130        self.inner = self.inner.limit(input);
131        self
132    }
133    /// <p>The maximum number of records to return from the shard. The upper limit is 1000.</p>
134    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
135        self.inner = self.inner.set_limit(input);
136        self
137    }
138    /// <p>The maximum number of records to return from the shard. The upper limit is 1000.</p>
139    pub fn get_limit(&self) -> &::std::option::Option<i32> {
140        self.inner.get_limit()
141    }
142}
aws_sdk_dynamodbstreams/operation/get_records/builders.rs

aws_sdk_dynamodbstreams/operation/get_records/
builders.rs
