aws_sdk_s3/operation/get_object_torrent/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_object_torrent::_get_object_torrent_output::GetObjectTorrentOutputBuilder;
3
4pub use crate::operation::get_object_torrent::_get_object_torrent_input::GetObjectTorrentInputBuilder;
5
6impl crate::operation::get_object_torrent::builders::GetObjectTorrentInputBuilder {
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_object_torrent::GetObjectTorrentOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_object_torrent::GetObjectTorrentError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_object_torrent();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetObjectTorrent`.
24///
25/// <note>
26/// <p>This operation is not supported for directory buckets.</p>
27/// </note>
28/// <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.</p><note>
29/// <p>You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.</p>
30/// </note>
31/// <p>To use GET, you must have READ access to the object.</p>
32/// <p>This functionality is not supported for Amazon S3 on Outposts.</p>
33/// <p>The following action is related to <code>GetObjectTorrent</code>:</p>
34/// <ul>
35/// <li>
36/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a></p></li>
37/// </ul><important>
38/// <p>You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>.</p>
39/// </important>
40#[derive(::std::clone::Clone, ::std::fmt::Debug)]
41pub struct GetObjectTorrentFluentBuilder {
42 handle: ::std::sync::Arc<crate::client::Handle>,
43 inner: crate::operation::get_object_torrent::builders::GetObjectTorrentInputBuilder,
44 config_override: ::std::option::Option<crate::config::Builder>,
45}
46impl
47 crate::client::customize::internal::CustomizableSend<
48 crate::operation::get_object_torrent::GetObjectTorrentOutput,
49 crate::operation::get_object_torrent::GetObjectTorrentError,
50 > for GetObjectTorrentFluentBuilder
51{
52 fn send(
53 self,
54 config_override: crate::config::Builder,
55 ) -> crate::client::customize::internal::BoxFuture<
56 crate::client::customize::internal::SendResult<
57 crate::operation::get_object_torrent::GetObjectTorrentOutput,
58 crate::operation::get_object_torrent::GetObjectTorrentError,
59 >,
60 > {
61 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
62 }
63}
64impl GetObjectTorrentFluentBuilder {
65 /// Creates a new `GetObjectTorrentFluentBuilder`.
66 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
67 Self {
68 handle,
69 inner: ::std::default::Default::default(),
70 config_override: ::std::option::Option::None,
71 }
72 }
73 /// Access the GetObjectTorrent as a reference.
74 pub fn as_input(&self) -> &crate::operation::get_object_torrent::builders::GetObjectTorrentInputBuilder {
75 &self.inner
76 }
77 /// Sends the request and returns the response.
78 ///
79 /// If an error occurs, an `SdkError` will be returned with additional details that
80 /// can be matched against.
81 ///
82 /// By default, any retryable failures will be retried twice. Retry behavior
83 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
84 /// set when configuring the client.
85 pub async fn send(
86 self,
87 ) -> ::std::result::Result<
88 crate::operation::get_object_torrent::GetObjectTorrentOutput,
89 ::aws_smithy_runtime_api::client::result::SdkError<
90 crate::operation::get_object_torrent::GetObjectTorrentError,
91 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
92 >,
93 > {
94 let input = self
95 .inner
96 .build()
97 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
98 let runtime_plugins = crate::operation::get_object_torrent::GetObjectTorrent::operation_runtime_plugins(
99 self.handle.runtime_plugins.clone(),
100 &self.handle.conf,
101 self.config_override,
102 );
103 crate::operation::get_object_torrent::GetObjectTorrent::orchestrate(&runtime_plugins, input).await
104 }
105
106 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
107 pub fn customize(
108 self,
109 ) -> crate::client::customize::CustomizableOperation<
110 crate::operation::get_object_torrent::GetObjectTorrentOutput,
111 crate::operation::get_object_torrent::GetObjectTorrentError,
112 Self,
113 > {
114 crate::client::customize::CustomizableOperation::new(self)
115 }
116 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
117 self.set_config_override(::std::option::Option::Some(config_override.into()));
118 self
119 }
120
121 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
122 self.config_override = config_override;
123 self
124 }
125 /// <p>The name of the bucket containing the object for which to get the torrent files.</p>
126 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.bucket(input.into());
128 self
129 }
130 /// <p>The name of the bucket containing the object for which to get the torrent files.</p>
131 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_bucket(input);
133 self
134 }
135 /// <p>The name of the bucket containing the object for which to get the torrent files.</p>
136 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_bucket()
138 }
139 /// <p>The object key for which to get the information.</p>
140 pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141 self.inner = self.inner.key(input.into());
142 self
143 }
144 /// <p>The object key for which to get the information.</p>
145 pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146 self.inner = self.inner.set_key(input);
147 self
148 }
149 /// <p>The object key for which to get the information.</p>
150 pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
151 self.inner.get_key()
152 }
153 /// <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>
154 /// <p>This functionality is not supported for directory buckets.</p>
155 /// </note>
156 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
157 self.inner = self.inner.request_payer(input);
158 self
159 }
160 /// <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>
161 /// <p>This functionality is not supported for directory buckets.</p>
162 /// </note>
163 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
164 self.inner = self.inner.set_request_payer(input);
165 self
166 }
167 /// <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>
168 /// <p>This functionality is not supported for directory buckets.</p>
169 /// </note>
170 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
171 self.inner.get_request_payer()
172 }
173 /// <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>
174 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175 self.inner = self.inner.expected_bucket_owner(input.into());
176 self
177 }
178 /// <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>
179 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180 self.inner = self.inner.set_expected_bucket_owner(input);
181 self
182 }
183 /// <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>
184 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
185 self.inner.get_expected_bucket_owner()
186 }
187}