aws-sdk-storagegateway 1.100.0

AWS SDK for AWS Storage Gateway
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_bandwidth_rate_limit::_update_bandwidth_rate_limit_output::UpdateBandwidthRateLimitOutputBuilder;

pub use crate::operation::update_bandwidth_rate_limit::_update_bandwidth_rate_limit_input::UpdateBandwidthRateLimitInputBuilder;

impl crate::operation::update_bandwidth_rate_limit::builders::UpdateBandwidthRateLimitInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.update_bandwidth_rate_limit();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `UpdateBandwidthRateLimit`.
///
/// <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>
/// <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>
/// <p>To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateBandwidthRateLimitFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::update_bandwidth_rate_limit::builders::UpdateBandwidthRateLimitInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
    > for UpdateBandwidthRateLimitFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
            crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl UpdateBandwidthRateLimitFluentBuilder {
    /// Creates a new `UpdateBandwidthRateLimitFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the UpdateBandwidthRateLimit as a reference.
    pub fn as_input(&self) -> &crate::operation::update_bandwidth_rate_limit::builders::UpdateBandwidthRateLimitInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimit::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimit::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitOutput,
        crate::operation::update_bandwidth_rate_limit::UpdateBandwidthRateLimitError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <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>
    pub fn gateway_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.gateway_arn(input.into());
        self
    }
    /// <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>
    pub fn set_gateway_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_gateway_arn(input);
        self
    }
    /// <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>
    pub fn get_gateway_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_gateway_arn()
    }
    /// <p>The average upload bandwidth rate limit in bits per second.</p>
    pub fn average_upload_rate_limit_in_bits_per_sec(mut self, input: i64) -> Self {
        self.inner = self.inner.average_upload_rate_limit_in_bits_per_sec(input);
        self
    }
    /// <p>The average upload bandwidth rate limit in bits per second.</p>
    pub fn set_average_upload_rate_limit_in_bits_per_sec(mut self, input: ::std::option::Option<i64>) -> Self {
        self.inner = self.inner.set_average_upload_rate_limit_in_bits_per_sec(input);
        self
    }
    /// <p>The average upload bandwidth rate limit in bits per second.</p>
    pub fn get_average_upload_rate_limit_in_bits_per_sec(&self) -> &::std::option::Option<i64> {
        self.inner.get_average_upload_rate_limit_in_bits_per_sec()
    }
    /// <p>The average download bandwidth rate limit in bits per second.</p>
    pub fn average_download_rate_limit_in_bits_per_sec(mut self, input: i64) -> Self {
        self.inner = self.inner.average_download_rate_limit_in_bits_per_sec(input);
        self
    }
    /// <p>The average download bandwidth rate limit in bits per second.</p>
    pub fn set_average_download_rate_limit_in_bits_per_sec(mut self, input: ::std::option::Option<i64>) -> Self {
        self.inner = self.inner.set_average_download_rate_limit_in_bits_per_sec(input);
        self
    }
    /// <p>The average download bandwidth rate limit in bits per second.</p>
    pub fn get_average_download_rate_limit_in_bits_per_sec(&self) -> &::std::option::Option<i64> {
        self.inner.get_average_download_rate_limit_in_bits_per_sec()
    }
}