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>
38#[derive(::std::clone::Clone, ::std::fmt::Debug)]
39pub struct GetObjectTorrentFluentBuilder {
40 handle: ::std::sync::Arc<crate::client::Handle>,
41 inner: crate::operation::get_object_torrent::builders::GetObjectTorrentInputBuilder,
42 config_override: ::std::option::Option<crate::config::Builder>,
43}
44impl
45 crate::client::customize::internal::CustomizableSend<
46 crate::operation::get_object_torrent::GetObjectTorrentOutput,
47 crate::operation::get_object_torrent::GetObjectTorrentError,
48 > for GetObjectTorrentFluentBuilder
49{
50 fn send(
51 self,
52 config_override: crate::config::Builder,
53 ) -> crate::client::customize::internal::BoxFuture<
54 crate::client::customize::internal::SendResult<
55 crate::operation::get_object_torrent::GetObjectTorrentOutput,
56 crate::operation::get_object_torrent::GetObjectTorrentError,
57 >,
58 > {
59 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
60 }
61}
62impl GetObjectTorrentFluentBuilder {
63 /// Creates a new `GetObjectTorrentFluentBuilder`.
64 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
65 Self {
66 handle,
67 inner: ::std::default::Default::default(),
68 config_override: ::std::option::Option::None,
69 }
70 }
71 /// Access the GetObjectTorrent as a reference.
72 pub fn as_input(&self) -> &crate::operation::get_object_torrent::builders::GetObjectTorrentInputBuilder {
73 &self.inner
74 }
75 /// Sends the request and returns the response.
76 ///
77 /// If an error occurs, an `SdkError` will be returned with additional details that
78 /// can be matched against.
79 ///
80 /// By default, any retryable failures will be retried twice. Retry behavior
81 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
82 /// set when configuring the client.
83 pub async fn send(
84 self,
85 ) -> ::std::result::Result<
86 crate::operation::get_object_torrent::GetObjectTorrentOutput,
87 ::aws_smithy_runtime_api::client::result::SdkError<
88 crate::operation::get_object_torrent::GetObjectTorrentError,
89 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
90 >,
91 > {
92 let input = self
93 .inner
94 .build()
95 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
96 let runtime_plugins = crate::operation::get_object_torrent::GetObjectTorrent::operation_runtime_plugins(
97 self.handle.runtime_plugins.clone(),
98 &self.handle.conf,
99 self.config_override,
100 );
101 crate::operation::get_object_torrent::GetObjectTorrent::orchestrate(&runtime_plugins, input).await
102 }
103
104 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
105 pub fn customize(
106 self,
107 ) -> crate::client::customize::CustomizableOperation<
108 crate::operation::get_object_torrent::GetObjectTorrentOutput,
109 crate::operation::get_object_torrent::GetObjectTorrentError,
110 Self,
111 > {
112 crate::client::customize::CustomizableOperation::new(self)
113 }
114 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
115 self.set_config_override(::std::option::Option::Some(config_override.into()));
116 self
117 }
118
119 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
120 self.config_override = config_override;
121 self
122 }
123 /// <p>The name of the bucket containing the object for which to get the torrent files.</p>
124 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
125 self.inner = self.inner.bucket(input.into());
126 self
127 }
128 /// <p>The name of the bucket containing the object for which to get the torrent files.</p>
129 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
130 self.inner = self.inner.set_bucket(input);
131 self
132 }
133 /// <p>The name of the bucket containing the object for which to get the torrent files.</p>
134 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
135 self.inner.get_bucket()
136 }
137 /// <p>The object key for which to get the information.</p>
138 pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
139 self.inner = self.inner.key(input.into());
140 self
141 }
142 /// <p>The object key for which to get the information.</p>
143 pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
144 self.inner = self.inner.set_key(input);
145 self
146 }
147 /// <p>The object key for which to get the information.</p>
148 pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
149 self.inner.get_key()
150 }
151 /// <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>
152 /// <p>This functionality is not supported for directory buckets.</p>
153 /// </note>
154 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
155 self.inner = self.inner.request_payer(input);
156 self
157 }
158 /// <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>
159 /// <p>This functionality is not supported for directory buckets.</p>
160 /// </note>
161 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
162 self.inner = self.inner.set_request_payer(input);
163 self
164 }
165 /// <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>
166 /// <p>This functionality is not supported for directory buckets.</p>
167 /// </note>
168 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
169 self.inner.get_request_payer()
170 }
171 /// <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>
172 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
173 self.inner = self.inner.expected_bucket_owner(input.into());
174 self
175 }
176 /// <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>
177 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
178 self.inner = self.inner.set_expected_bucket_owner(input);
179 self
180 }
181 /// <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>
182 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
183 self.inner.get_expected_bucket_owner()
184 }
185}