aws_sdk_opensearch/operation/start_service_software_update/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_service_software_update::_start_service_software_update_output::StartServiceSoftwareUpdateOutputBuilder;
3
4pub use crate::operation::start_service_software_update::_start_service_software_update_input::StartServiceSoftwareUpdateInputBuilder;
5
6impl crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateInputBuilder {
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::start_service_software_update::StartServiceSoftwareUpdateOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_service_software_update::StartServiceSoftwareUpdateError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_service_software_update();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartServiceSoftwareUpdate`.
24///
25/// <p>Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">Service software updates in Amazon OpenSearch Service</a>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct StartServiceSoftwareUpdateFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::start_service_software_update::StartServiceSoftwareUpdateOutput,
35        crate::operation::start_service_software_update::StartServiceSoftwareUpdateError,
36    > for StartServiceSoftwareUpdateFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::start_service_software_update::StartServiceSoftwareUpdateOutput,
44            crate::operation::start_service_software_update::StartServiceSoftwareUpdateError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl StartServiceSoftwareUpdateFluentBuilder {
51    /// Creates a new `StartServiceSoftwareUpdateFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the StartServiceSoftwareUpdate as a reference.
60    pub fn as_input(&self) -> &crate::operation::start_service_software_update::builders::StartServiceSoftwareUpdateInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::start_service_software_update::StartServiceSoftwareUpdateOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::start_service_software_update::StartServiceSoftwareUpdateError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::start_service_software_update::StartServiceSoftwareUpdate::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::start_service_software_update::StartServiceSoftwareUpdate::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::start_service_software_update::StartServiceSoftwareUpdateOutput,
97        crate::operation::start_service_software_update::StartServiceSoftwareUpdateError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The name of the domain that you want to update to the latest service software.</p>
112    pub fn domain_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.domain_name(input.into());
114        self
115    }
116    /// <p>The name of the domain that you want to update to the latest service software.</p>
117    pub fn set_domain_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_domain_name(input);
119        self
120    }
121    /// <p>The name of the domain that you want to update to the latest service software.</p>
122    pub fn get_domain_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_domain_name()
124    }
125    /// <p>When to start the service software update.</p>
126    /// <ul>
127    /// <li>
128    /// <p><code>NOW</code> - Immediately schedules the update to happen in the current hour if there's capacity available.</p></li>
129    /// <li>
130    /// <p><code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for <code>DesiredStartTime</code>.</p></li>
131    /// <li>
132    /// <p><code>OFF_PEAK_WINDOW</code> - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.</p></li>
133    /// </ul>
134    /// <p>Default: <code>NOW</code> if you don't specify a value for <code>DesiredStartTime</code>, and <code>TIMESTAMP</code> if you do.</p>
135    pub fn schedule_at(mut self, input: crate::types::ScheduleAt) -> Self {
136        self.inner = self.inner.schedule_at(input);
137        self
138    }
139    /// <p>When to start the service software update.</p>
140    /// <ul>
141    /// <li>
142    /// <p><code>NOW</code> - Immediately schedules the update to happen in the current hour if there's capacity available.</p></li>
143    /// <li>
144    /// <p><code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for <code>DesiredStartTime</code>.</p></li>
145    /// <li>
146    /// <p><code>OFF_PEAK_WINDOW</code> - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.</p></li>
147    /// </ul>
148    /// <p>Default: <code>NOW</code> if you don't specify a value for <code>DesiredStartTime</code>, and <code>TIMESTAMP</code> if you do.</p>
149    pub fn set_schedule_at(mut self, input: ::std::option::Option<crate::types::ScheduleAt>) -> Self {
150        self.inner = self.inner.set_schedule_at(input);
151        self
152    }
153    /// <p>When to start the service software update.</p>
154    /// <ul>
155    /// <li>
156    /// <p><code>NOW</code> - Immediately schedules the update to happen in the current hour if there's capacity available.</p></li>
157    /// <li>
158    /// <p><code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for <code>DesiredStartTime</code>.</p></li>
159    /// <li>
160    /// <p><code>OFF_PEAK_WINDOW</code> - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.</p></li>
161    /// </ul>
162    /// <p>Default: <code>NOW</code> if you don't specify a value for <code>DesiredStartTime</code>, and <code>TIMESTAMP</code> if you do.</p>
163    pub fn get_schedule_at(&self) -> &::std::option::Option<crate::types::ScheduleAt> {
164        self.inner.get_schedule_at()
165    }
166    /// <p>The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
167    pub fn desired_start_time(mut self, input: i64) -> Self {
168        self.inner = self.inner.desired_start_time(input);
169        self
170    }
171    /// <p>The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
172    pub fn set_desired_start_time(mut self, input: ::std::option::Option<i64>) -> Self {
173        self.inner = self.inner.set_desired_start_time(input);
174        self
175    }
176    /// <p>The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
177    pub fn get_desired_start_time(&self) -> &::std::option::Option<i64> {
178        self.inner.get_desired_start_time()
179    }
180}