aws_sdk_storagegateway/operation/update_bandwidth_rate_limit/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_bandwidth_rate_limit::_update_bandwidth_rate_limit_output::UpdateBandwidthRateLimitOutputBuilder;
3
4pub use crate::operation::update_bandwidth_rate_limit::_update_bandwidth_rate_limit_input::UpdateBandwidthRateLimitInputBuilder;
5
6impl crate::operation::update_bandwidth_rate_limit::builders::UpdateBandwidthRateLimitInputBuilder {
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::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_bandwidth_rate_limit();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateBandwidthRateLimit`.
24///
25/// <p>Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use <code>UpdateBandwidthRateLimitSchedule</code>.</p>
26/// <p>By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.</p>
27/// <p>To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct UpdateBandwidthRateLimitFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::update_bandwidth_rate_limit::builders::UpdateBandwidthRateLimitInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
37        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
38    > for UpdateBandwidthRateLimitFluentBuilder
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::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
46            crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl UpdateBandwidthRateLimitFluentBuilder {
53    /// Creates a new `UpdateBandwidthRateLimitFluentBuilder`.
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 UpdateBandwidthRateLimit as a reference.
62    pub fn as_input(&self) -> &crate::operation::update_bandwidth_rate_limit::builders::UpdateBandwidthRateLimitInputBuilder {
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::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
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::update_bandwidth_rate_limit::UpdateBandwidthRateLimit::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimit::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::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
99        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
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) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>
114    pub fn gateway_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.gateway_arn(input.into());
116        self
117    }
118    /// <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>
119    pub fn set_gateway_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_gateway_arn(input);
121        self
122    }
123    /// <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>
124    pub fn get_gateway_arn(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_gateway_arn()
126    }
127    /// <p>The average upload bandwidth rate limit in bits per second.</p>
128    pub fn average_upload_rate_limit_in_bits_per_sec(mut self, input: i64) -> Self {
129        self.inner = self.inner.average_upload_rate_limit_in_bits_per_sec(input);
130        self
131    }
132    /// <p>The average upload bandwidth rate limit in bits per second.</p>
133    pub fn set_average_upload_rate_limit_in_bits_per_sec(mut self, input: ::std::option::Option<i64>) -> Self {
134        self.inner = self.inner.set_average_upload_rate_limit_in_bits_per_sec(input);
135        self
136    }
137    /// <p>The average upload bandwidth rate limit in bits per second.</p>
138    pub fn get_average_upload_rate_limit_in_bits_per_sec(&self) -> &::std::option::Option<i64> {
139        self.inner.get_average_upload_rate_limit_in_bits_per_sec()
140    }
141    /// <p>The average download bandwidth rate limit in bits per second.</p>
142    pub fn average_download_rate_limit_in_bits_per_sec(mut self, input: i64) -> Self {
143        self.inner = self.inner.average_download_rate_limit_in_bits_per_sec(input);
144        self
145    }
146    /// <p>The average download bandwidth rate limit in bits per second.</p>
147    pub fn set_average_download_rate_limit_in_bits_per_sec(mut self, input: ::std::option::Option<i64>) -> Self {
148        self.inner = self.inner.set_average_download_rate_limit_in_bits_per_sec(input);
149        self
150    }
151    /// <p>The average download bandwidth rate limit in bits per second.</p>
152    pub fn get_average_download_rate_limit_in_bits_per_sec(&self) -> &::std::option::Option<i64> {
153        self.inner.get_average_download_rate_limit_in_bits_per_sec()
154    }
155}