aws_sdk_s3/operation/list_object_versions/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_object_versions::_list_object_versions_output::ListObjectVersionsOutputBuilder;
3
4pub use crate::operation::list_object_versions::_list_object_versions_input::ListObjectVersionsInputBuilder;
5
6impl crate::operation::list_object_versions::builders::ListObjectVersionsInputBuilder {
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::list_object_versions::ListObjectVersionsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_object_versions::ListObjectVersionsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_object_versions();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListObjectVersions`.
24///
25/// <note>
26/// <p>This operation is not supported for directory buckets.</p>
27/// </note>
28/// <p>Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.</p><important>
29/// <p>To use this operation, you must have permission to perform the <code>s3:ListBucketVersions</code> action. Be aware of the name difference.</p>
30/// </important> <note>
31/// <p>A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.</p>
32/// </note>
33/// <p>To use this operation, you must have READ access to the bucket.</p>
34/// <p>The following operations are related to <code>ListObjectVersions</code>:</p>
35/// <ul>
36/// <li>
37/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a></p></li>
38/// <li>
39/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a></p></li>
40/// <li>
41/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a></p></li>
42/// <li>
43/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></p></li>
44/// </ul>
45#[derive(::std::clone::Clone, ::std::fmt::Debug)]
46pub struct ListObjectVersionsFluentBuilder {
47 handle: ::std::sync::Arc<crate::client::Handle>,
48 inner: crate::operation::list_object_versions::builders::ListObjectVersionsInputBuilder,
49 config_override: ::std::option::Option<crate::config::Builder>,
50}
51impl
52 crate::client::customize::internal::CustomizableSend<
53 crate::operation::list_object_versions::ListObjectVersionsOutput,
54 crate::operation::list_object_versions::ListObjectVersionsError,
55 > for ListObjectVersionsFluentBuilder
56{
57 fn send(
58 self,
59 config_override: crate::config::Builder,
60 ) -> crate::client::customize::internal::BoxFuture<
61 crate::client::customize::internal::SendResult<
62 crate::operation::list_object_versions::ListObjectVersionsOutput,
63 crate::operation::list_object_versions::ListObjectVersionsError,
64 >,
65 > {
66 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
67 }
68}
69impl ListObjectVersionsFluentBuilder {
70 /// Creates a new `ListObjectVersionsFluentBuilder`.
71 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
72 Self {
73 handle,
74 inner: ::std::default::Default::default(),
75 config_override: ::std::option::Option::None,
76 }
77 }
78 /// Access the ListObjectVersions as a reference.
79 pub fn as_input(&self) -> &crate::operation::list_object_versions::builders::ListObjectVersionsInputBuilder {
80 &self.inner
81 }
82 /// Sends the request and returns the response.
83 ///
84 /// If an error occurs, an `SdkError` will be returned with additional details that
85 /// can be matched against.
86 ///
87 /// By default, any retryable failures will be retried twice. Retry behavior
88 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
89 /// set when configuring the client.
90 pub async fn send(
91 self,
92 ) -> ::std::result::Result<
93 crate::operation::list_object_versions::ListObjectVersionsOutput,
94 ::aws_smithy_runtime_api::client::result::SdkError<
95 crate::operation::list_object_versions::ListObjectVersionsError,
96 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
97 >,
98 > {
99 let input = self
100 .inner
101 .build()
102 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
103 let runtime_plugins = crate::operation::list_object_versions::ListObjectVersions::operation_runtime_plugins(
104 self.handle.runtime_plugins.clone(),
105 &self.handle.conf,
106 self.config_override,
107 );
108 crate::operation::list_object_versions::ListObjectVersions::orchestrate(&runtime_plugins, input).await
109 }
110
111 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
112 pub fn customize(
113 self,
114 ) -> crate::client::customize::CustomizableOperation<
115 crate::operation::list_object_versions::ListObjectVersionsOutput,
116 crate::operation::list_object_versions::ListObjectVersionsError,
117 Self,
118 > {
119 crate::client::customize::CustomizableOperation::new(self)
120 }
121 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
122 self.set_config_override(::std::option::Option::Some(config_override.into()));
123 self
124 }
125
126 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
127 self.config_override = config_override;
128 self
129 }
130 /// <p>The bucket name that contains the objects.</p>
131 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132 self.inner = self.inner.bucket(input.into());
133 self
134 }
135 /// <p>The bucket name that contains the objects.</p>
136 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
137 self.inner = self.inner.set_bucket(input);
138 self
139 }
140 /// <p>The bucket name that contains the objects.</p>
141 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
142 self.inner.get_bucket()
143 }
144 /// <p>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</p>
145 pub fn delimiter(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
146 self.inner = self.inner.delimiter(input.into());
147 self
148 }
149 /// <p>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</p>
150 pub fn set_delimiter(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
151 self.inner = self.inner.set_delimiter(input);
152 self
153 }
154 /// <p>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</p>
155 pub fn get_delimiter(&self) -> &::std::option::Option<::std::string::String> {
156 self.inner.get_delimiter()
157 }
158 /// <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key naming guidelines</a>.</p><note>
159 /// <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
160 /// </note>
161 pub fn encoding_type(mut self, input: crate::types::EncodingType) -> Self {
162 self.inner = self.inner.encoding_type(input);
163 self
164 }
165 /// <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key naming guidelines</a>.</p><note>
166 /// <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
167 /// </note>
168 pub fn set_encoding_type(mut self, input: ::std::option::Option<crate::types::EncodingType>) -> Self {
169 self.inner = self.inner.set_encoding_type(input);
170 self
171 }
172 /// <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key naming guidelines</a>.</p><note>
173 /// <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
174 /// </note>
175 pub fn get_encoding_type(&self) -> &::std::option::Option<crate::types::EncodingType> {
176 self.inner.get_encoding_type()
177 }
178 /// <p>Specifies the key to start with when listing objects in a bucket.</p>
179 pub fn key_marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
180 self.inner = self.inner.key_marker(input.into());
181 self
182 }
183 /// <p>Specifies the key to start with when listing objects in a bucket.</p>
184 pub fn set_key_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
185 self.inner = self.inner.set_key_marker(input);
186 self
187 }
188 /// <p>Specifies the key to start with when listing objects in a bucket.</p>
189 pub fn get_key_marker(&self) -> &::std::option::Option<::std::string::String> {
190 self.inner.get_key_marker()
191 }
192 /// <p>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response contains <code><istruncated>
193 /// true
194 /// </istruncated></code>. To return the additional keys, see <code>key-marker</code> and <code>version-id-marker</code>.</p>
195 pub fn max_keys(mut self, input: i32) -> Self {
196 self.inner = self.inner.max_keys(input);
197 self
198 }
199 /// <p>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response contains <code><istruncated>
200 /// true
201 /// </istruncated></code>. To return the additional keys, see <code>key-marker</code> and <code>version-id-marker</code>.</p>
202 pub fn set_max_keys(mut self, input: ::std::option::Option<i32>) -> Self {
203 self.inner = self.inner.set_max_keys(input);
204 self
205 }
206 /// <p>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response contains <code><istruncated>
207 /// true
208 /// </istruncated></code>. To return the additional keys, see <code>key-marker</code> and <code>version-id-marker</code>.</p>
209 pub fn get_max_keys(&self) -> &::std::option::Option<i32> {
210 self.inner.get_max_keys()
211 }
212 /// <p>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>.</p>
213 pub fn prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
214 self.inner = self.inner.prefix(input.into());
215 self
216 }
217 /// <p>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>.</p>
218 pub fn set_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
219 self.inner = self.inner.set_prefix(input);
220 self
221 }
222 /// <p>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>.</p>
223 pub fn get_prefix(&self) -> &::std::option::Option<::std::string::String> {
224 self.inner.get_prefix()
225 }
226 /// <p>Specifies the object version you want to start listing from.</p>
227 pub fn version_id_marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
228 self.inner = self.inner.version_id_marker(input.into());
229 self
230 }
231 /// <p>Specifies the object version you want to start listing from.</p>
232 pub fn set_version_id_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
233 self.inner = self.inner.set_version_id_marker(input);
234 self
235 }
236 /// <p>Specifies the object version you want to start listing from.</p>
237 pub fn get_version_id_marker(&self) -> &::std::option::Option<::std::string::String> {
238 self.inner.get_version_id_marker()
239 }
240 /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
241 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
242 self.inner = self.inner.expected_bucket_owner(input.into());
243 self
244 }
245 /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
246 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
247 self.inner = self.inner.set_expected_bucket_owner(input);
248 self
249 }
250 /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
251 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
252 self.inner.get_expected_bucket_owner()
253 }
254 /// <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p><note>
255 /// <p>This functionality is not supported for directory buckets.</p>
256 /// </note>
257 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
258 self.inner = self.inner.request_payer(input);
259 self
260 }
261 /// <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p><note>
262 /// <p>This functionality is not supported for directory buckets.</p>
263 /// </note>
264 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
265 self.inner = self.inner.set_request_payer(input);
266 self
267 }
268 /// <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p><note>
269 /// <p>This functionality is not supported for directory buckets.</p>
270 /// </note>
271 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
272 self.inner.get_request_payer()
273 }
274 ///
275 /// Appends an item to `OptionalObjectAttributes`.
276 ///
277 /// To override the contents of this collection use [`set_optional_object_attributes`](Self::set_optional_object_attributes).
278 ///
279 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p>
280 pub fn optional_object_attributes(mut self, input: crate::types::OptionalObjectAttributes) -> Self {
281 self.inner = self.inner.optional_object_attributes(input);
282 self
283 }
284 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p>
285 pub fn set_optional_object_attributes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>>) -> Self {
286 self.inner = self.inner.set_optional_object_attributes(input);
287 self
288 }
289 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p>
290 pub fn get_optional_object_attributes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>> {
291 self.inner.get_optional_object_attributes()
292 }
293}