aws_sdk_storagegateway/operation/update_gateway_software_now/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_gateway_software_now::_update_gateway_software_now_output::UpdateGatewaySoftwareNowOutputBuilder;
3
4pub use crate::operation::update_gateway_software_now::_update_gateway_software_now_input::UpdateGatewaySoftwareNowInputBuilder;
5
6impl crate::operation::update_gateway_software_now::builders::UpdateGatewaySoftwareNowInputBuilder {
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_gateway_software_now::UpdateGatewaySoftwareNowOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_gateway_software_now();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateGatewaySoftwareNow`.
24///
25/// <p>Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.</p><note>
26/// <p>When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. You can call <code>DescribeGatewayInformation</code> to verify the gateway is in the <code>STATE_RUNNING</code> state.</p>
27/// </note> <important>
28/// <p>A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings">Customizing your Windows iSCSI settings</a> and <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings">Customizing your Linux iSCSI settings</a>, respectively.</p>
29/// </important>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct UpdateGatewaySoftwareNowFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::update_gateway_software_now::builders::UpdateGatewaySoftwareNowInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowOutput,
39        crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowError,
40    > for UpdateGatewaySoftwareNowFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowOutput,
48            crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl UpdateGatewaySoftwareNowFluentBuilder {
55    /// Creates a new `UpdateGatewaySoftwareNowFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the UpdateGatewaySoftwareNow as a reference.
64    pub fn as_input(&self) -> &crate::operation::update_gateway_software_now::builders::UpdateGatewaySoftwareNowInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNow::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNow::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowOutput,
101        crate::operation::update_gateway_software_now::UpdateGatewaySoftwareNowError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <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>
116    pub fn gateway_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.gateway_arn(input.into());
118        self
119    }
120    /// <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>
121    pub fn set_gateway_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_gateway_arn(input);
123        self
124    }
125    /// <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>
126    pub fn get_gateway_arn(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_gateway_arn()
128    }
129}