aws_sdk_dynamodbstreams/operation/get_shard_iterator/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_shard_iterator::_get_shard_iterator_output::GetShardIteratorOutputBuilder;
3
4pub use crate::operation::get_shard_iterator::_get_shard_iterator_input::GetShardIteratorInputBuilder;
5
6impl crate::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder {
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_shard_iterator::GetShardIteratorOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_shard_iterator::GetShardIteratorError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_shard_iterator();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetShardIterator`.
24///
25/// <p>Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent <code>GetRecords</code> request to read the stream records from the shard.</p><note>
26/// <p>A shard iterator expires 15 minutes after it is returned to the requester.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct GetShardIteratorFluentBuilder {
30 handle: ::std::sync::Arc<crate::client::Handle>,
31 inner: crate::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder,
32 config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35 crate::client::customize::internal::CustomizableSend<
36 crate::operation::get_shard_iterator::GetShardIteratorOutput,
37 crate::operation::get_shard_iterator::GetShardIteratorError,
38 > for GetShardIteratorFluentBuilder
39{
40 fn send(
41 self,
42 config_override: crate::config::Builder,
43 ) -> crate::client::customize::internal::BoxFuture<
44 crate::client::customize::internal::SendResult<
45 crate::operation::get_shard_iterator::GetShardIteratorOutput,
46 crate::operation::get_shard_iterator::GetShardIteratorError,
47 >,
48 > {
49 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50 }
51}
52impl GetShardIteratorFluentBuilder {
53 /// Creates a new `GetShardIteratorFluentBuilder`.
54 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55 Self {
56 handle,
57 inner: ::std::default::Default::default(),
58 config_override: ::std::option::Option::None,
59 }
60 }
61 /// Access the GetShardIterator as a reference.
62 pub fn as_input(&self) -> &crate::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder {
63 &self.inner
64 }
65 /// Sends the request and returns the response.
66 ///
67 /// If an error occurs, an `SdkError` will be returned with additional details that
68 /// can be matched against.
69 ///
70 /// By default, any retryable failures will be retried twice. Retry behavior
71 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72 /// set when configuring the client.
73 pub async fn send(
74 self,
75 ) -> ::std::result::Result<
76 crate::operation::get_shard_iterator::GetShardIteratorOutput,
77 ::aws_smithy_runtime_api::client::result::SdkError<
78 crate::operation::get_shard_iterator::GetShardIteratorError,
79 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80 >,
81 > {
82 let input = self
83 .inner
84 .build()
85 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86 let runtime_plugins = crate::operation::get_shard_iterator::GetShardIterator::operation_runtime_plugins(
87 self.handle.runtime_plugins.clone(),
88 &self.handle.conf,
89 self.config_override,
90 );
91 crate::operation::get_shard_iterator::GetShardIterator::orchestrate(&runtime_plugins, input).await
92 }
93
94 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95 pub fn customize(
96 self,
97 ) -> crate::client::customize::CustomizableOperation<
98 crate::operation::get_shard_iterator::GetShardIteratorOutput,
99 crate::operation::get_shard_iterator::GetShardIteratorError,
100 Self,
101 > {
102 crate::client::customize::CustomizableOperation::new(self)
103 }
104 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105 self.set_config_override(::std::option::Option::Some(config_override.into()));
106 self
107 }
108
109 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110 self.config_override = config_override;
111 self
112 }
113 /// <p>The Amazon Resource Name (ARN) for the stream.</p>
114 pub fn stream_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115 self.inner = self.inner.stream_arn(input.into());
116 self
117 }
118 /// <p>The Amazon Resource Name (ARN) for the stream.</p>
119 pub fn set_stream_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120 self.inner = self.inner.set_stream_arn(input);
121 self
122 }
123 /// <p>The Amazon Resource Name (ARN) for the stream.</p>
124 pub fn get_stream_arn(&self) -> &::std::option::Option<::std::string::String> {
125 self.inner.get_stream_arn()
126 }
127 /// <p>The identifier of the shard. The iterator will be returned for this shard ID.</p>
128 pub fn shard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129 self.inner = self.inner.shard_id(input.into());
130 self
131 }
132 /// <p>The identifier of the shard. The iterator will be returned for this shard ID.</p>
133 pub fn set_shard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134 self.inner = self.inner.set_shard_id(input);
135 self
136 }
137 /// <p>The identifier of the shard. The iterator will be returned for this shard ID.</p>
138 pub fn get_shard_id(&self) -> &::std::option::Option<::std::string::String> {
139 self.inner.get_shard_id()
140 }
141 /// <p>Determines how the shard iterator is used to start reading stream records from the shard:</p>
142 /// <ul>
143 /// <li>
144 /// <p><code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number.</p></li>
145 /// <li>
146 /// <p><code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number.</p></li>
147 /// <li>
148 /// <p><code>TRIM_HORIZON</code> - 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.</p></li>
149 /// <li>
150 /// <p><code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.</p></li>
151 /// </ul>
152 pub fn shard_iterator_type(mut self, input: crate::types::ShardIteratorType) -> Self {
153 self.inner = self.inner.shard_iterator_type(input);
154 self
155 }
156 /// <p>Determines how the shard iterator is used to start reading stream records from the shard:</p>
157 /// <ul>
158 /// <li>
159 /// <p><code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number.</p></li>
160 /// <li>
161 /// <p><code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number.</p></li>
162 /// <li>
163 /// <p><code>TRIM_HORIZON</code> - 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.</p></li>
164 /// <li>
165 /// <p><code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.</p></li>
166 /// </ul>
167 pub fn set_shard_iterator_type(mut self, input: ::std::option::Option<crate::types::ShardIteratorType>) -> Self {
168 self.inner = self.inner.set_shard_iterator_type(input);
169 self
170 }
171 /// <p>Determines how the shard iterator is used to start reading stream records from the shard:</p>
172 /// <ul>
173 /// <li>
174 /// <p><code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number.</p></li>
175 /// <li>
176 /// <p><code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number.</p></li>
177 /// <li>
178 /// <p><code>TRIM_HORIZON</code> - 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.</p></li>
179 /// <li>
180 /// <p><code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.</p></li>
181 /// </ul>
182 pub fn get_shard_iterator_type(&self) -> &::std::option::Option<crate::types::ShardIteratorType> {
183 self.inner.get_shard_iterator_type()
184 }
185 /// <p>The sequence number of a stream record in the shard from which to start reading.</p>
186 pub fn sequence_number(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
187 self.inner = self.inner.sequence_number(input.into());
188 self
189 }
190 /// <p>The sequence number of a stream record in the shard from which to start reading.</p>
191 pub fn set_sequence_number(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
192 self.inner = self.inner.set_sequence_number(input);
193 self
194 }
195 /// <p>The sequence number of a stream record in the shard from which to start reading.</p>
196 pub fn get_sequence_number(&self) -> &::std::option::Option<::std::string::String> {
197 self.inner.get_sequence_number()
198 }
199}