aws_sdk_opensearch/operation/update_scheduled_action/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_scheduled_action::_update_scheduled_action_output::UpdateScheduledActionOutputBuilder;
3
4pub use crate::operation::update_scheduled_action::_update_scheduled_action_input::UpdateScheduledActionInputBuilder;
5
6impl crate::operation::update_scheduled_action::builders::UpdateScheduledActionInputBuilder {
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_scheduled_action::UpdateScheduledActionOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::update_scheduled_action::UpdateScheduledActionError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.update_scheduled_action();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `UpdateScheduledAction`.
24///
25/// <p>Reschedules a planned domain configuration change for a later time. This change can be a scheduled <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">service software update</a> or a <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types">blue/green Auto-Tune enhancement</a>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateScheduledActionFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::update_scheduled_action::builders::UpdateScheduledActionInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::update_scheduled_action::UpdateScheduledActionOutput,
35 crate::operation::update_scheduled_action::UpdateScheduledActionError,
36 > for UpdateScheduledActionFluentBuilder
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::update_scheduled_action::UpdateScheduledActionOutput,
44 crate::operation::update_scheduled_action::UpdateScheduledActionError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl UpdateScheduledActionFluentBuilder {
51 /// Creates a new `UpdateScheduledActionFluentBuilder`.
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 UpdateScheduledAction as a reference.
60 pub fn as_input(&self) -> &crate::operation::update_scheduled_action::builders::UpdateScheduledActionInputBuilder {
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::update_scheduled_action::UpdateScheduledActionOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::update_scheduled_action::UpdateScheduledActionError,
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::update_scheduled_action::UpdateScheduledAction::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::update_scheduled_action::UpdateScheduledAction::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::update_scheduled_action::UpdateScheduledActionOutput,
97 crate::operation::update_scheduled_action::UpdateScheduledActionError,
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 to reschedule an action for.</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 to reschedule an action for.</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 to reschedule an action for.</p>
122 pub fn get_domain_name(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_domain_name()
124 }
125 /// <p>The unique identifier of the action to reschedule. To retrieve this ID, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
126 pub fn action_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.action_id(input.into());
128 self
129 }
130 /// <p>The unique identifier of the action to reschedule. To retrieve this ID, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
131 pub fn set_action_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_action_id(input);
133 self
134 }
135 /// <p>The unique identifier of the action to reschedule. To retrieve this ID, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
136 pub fn get_action_id(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_action_id()
138 }
139 /// <p>The type of action to reschedule. Can be one of <code>SERVICE_SOFTWARE_UPDATE</code>, <code>JVM_HEAP_SIZE_TUNING</code>, or <code>JVM_YOUNG_GEN_TUNING</code>. To retrieve this value, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
140 pub fn action_type(mut self, input: crate::types::ActionType) -> Self {
141 self.inner = self.inner.action_type(input);
142 self
143 }
144 /// <p>The type of action to reschedule. Can be one of <code>SERVICE_SOFTWARE_UPDATE</code>, <code>JVM_HEAP_SIZE_TUNING</code>, or <code>JVM_YOUNG_GEN_TUNING</code>. To retrieve this value, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
145 pub fn set_action_type(mut self, input: ::std::option::Option<crate::types::ActionType>) -> Self {
146 self.inner = self.inner.set_action_type(input);
147 self
148 }
149 /// <p>The type of action to reschedule. Can be one of <code>SERVICE_SOFTWARE_UPDATE</code>, <code>JVM_HEAP_SIZE_TUNING</code>, or <code>JVM_YOUNG_GEN_TUNING</code>. To retrieve this value, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
150 pub fn get_action_type(&self) -> &::std::option::Option<crate::types::ActionType> {
151 self.inner.get_action_type()
152 }
153 /// <p>When to schedule the action.</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 action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.</p></li>
161 /// </ul>
162 pub fn schedule_at(mut self, input: crate::types::ScheduleAt) -> Self {
163 self.inner = self.inner.schedule_at(input);
164 self
165 }
166 /// <p>When to schedule the action.</p>
167 /// <ul>
168 /// <li>
169 /// <p><code>NOW</code> - Immediately schedules the update to happen in the current hour if there's capacity available.</p></li>
170 /// <li>
171 /// <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>
172 /// <li>
173 /// <p><code>OFF_PEAK_WINDOW</code> - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.</p></li>
174 /// </ul>
175 pub fn set_schedule_at(mut self, input: ::std::option::Option<crate::types::ScheduleAt>) -> Self {
176 self.inner = self.inner.set_schedule_at(input);
177 self
178 }
179 /// <p>When to schedule the action.</p>
180 /// <ul>
181 /// <li>
182 /// <p><code>NOW</code> - Immediately schedules the update to happen in the current hour if there's capacity available.</p></li>
183 /// <li>
184 /// <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>
185 /// <li>
186 /// <p><code>OFF_PEAK_WINDOW</code> - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.</p></li>
187 /// </ul>
188 pub fn get_schedule_at(&self) -> &::std::option::Option<crate::types::ScheduleAt> {
189 self.inner.get_schedule_at()
190 }
191 /// <p>The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
192 pub fn desired_start_time(mut self, input: i64) -> Self {
193 self.inner = self.inner.desired_start_time(input);
194 self
195 }
196 /// <p>The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
197 pub fn set_desired_start_time(mut self, input: ::std::option::Option<i64>) -> Self {
198 self.inner = self.inner.set_desired_start_time(input);
199 self
200 }
201 /// <p>The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
202 pub fn get_desired_start_time(&self) -> &::std::option::Option<i64> {
203 self.inner.get_desired_start_time()
204 }
205}