aws_sdk_deadline/operation/update_queue/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_queue::_update_queue_output::UpdateQueueOutputBuilder;
3
4pub use crate::operation::update_queue::_update_queue_input::UpdateQueueInputBuilder;
5
6impl crate::operation::update_queue::builders::UpdateQueueInputBuilder {
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_queue::UpdateQueueOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_queue::UpdateQueueError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_queue();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateQueue`.
24///
25/// <p>Updates a queue.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateQueueFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::update_queue::builders::UpdateQueueInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::update_queue::UpdateQueueOutput,
35        crate::operation::update_queue::UpdateQueueError,
36    > for UpdateQueueFluentBuilder
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_queue::UpdateQueueOutput,
44            crate::operation::update_queue::UpdateQueueError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl UpdateQueueFluentBuilder {
51    /// Creates a new `UpdateQueueFluentBuilder`.
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 UpdateQueue as a reference.
60    pub fn as_input(&self) -> &crate::operation::update_queue::builders::UpdateQueueInputBuilder {
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_queue::UpdateQueueOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::update_queue::UpdateQueueError,
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_queue::UpdateQueue::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::update_queue::UpdateQueue::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_queue::UpdateQueueOutput,
97        crate::operation::update_queue::UpdateQueueError,
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 idempotency token to update in the queue.</p>
112    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.client_token(input.into());
114        self
115    }
116    /// <p>The idempotency token to update in the queue.</p>
117    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_client_token(input);
119        self
120    }
121    /// <p>The idempotency token to update in the queue.</p>
122    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_client_token()
124    }
125    /// <p>The farm ID to update in the queue.</p>
126    pub fn farm_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.farm_id(input.into());
128        self
129    }
130    /// <p>The farm ID to update in the queue.</p>
131    pub fn set_farm_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_farm_id(input);
133        self
134    }
135    /// <p>The farm ID to update in the queue.</p>
136    pub fn get_farm_id(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_farm_id()
138    }
139    /// <p>The queue ID to update.</p>
140    pub fn queue_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.queue_id(input.into());
142        self
143    }
144    /// <p>The queue ID to update.</p>
145    pub fn set_queue_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_queue_id(input);
147        self
148    }
149    /// <p>The queue ID to update.</p>
150    pub fn get_queue_id(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_queue_id()
152    }
153    /// <p>The display name of the queue to update.</p><important>
154    /// <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
155    /// </important>
156    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157        self.inner = self.inner.display_name(input.into());
158        self
159    }
160    /// <p>The display name of the queue to update.</p><important>
161    /// <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
162    /// </important>
163    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
164        self.inner = self.inner.set_display_name(input);
165        self
166    }
167    /// <p>The display name of the queue to update.</p><important>
168    /// <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
169    /// </important>
170    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
171        self.inner.get_display_name()
172    }
173    /// <p>The description of the queue to update.</p><important>
174    /// <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
175    /// </important>
176    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
177        self.inner = self.inner.description(input.into());
178        self
179    }
180    /// <p>The description of the queue to update.</p><important>
181    /// <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
182    /// </important>
183    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
184        self.inner = self.inner.set_description(input);
185        self
186    }
187    /// <p>The description of the queue to update.</p><important>
188    /// <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
189    /// </important>
190    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
191        self.inner.get_description()
192    }
193    /// <p>The default action to take for a queue update if a budget isn't configured.</p>
194    pub fn default_budget_action(mut self, input: crate::types::DefaultQueueBudgetAction) -> Self {
195        self.inner = self.inner.default_budget_action(input);
196        self
197    }
198    /// <p>The default action to take for a queue update if a budget isn't configured.</p>
199    pub fn set_default_budget_action(mut self, input: ::std::option::Option<crate::types::DefaultQueueBudgetAction>) -> Self {
200        self.inner = self.inner.set_default_budget_action(input);
201        self
202    }
203    /// <p>The default action to take for a queue update if a budget isn't configured.</p>
204    pub fn get_default_budget_action(&self) -> &::std::option::Option<crate::types::DefaultQueueBudgetAction> {
205        self.inner.get_default_budget_action()
206    }
207    /// <p>The job attachment settings to update for the queue.</p>
208    pub fn job_attachment_settings(mut self, input: crate::types::JobAttachmentSettings) -> Self {
209        self.inner = self.inner.job_attachment_settings(input);
210        self
211    }
212    /// <p>The job attachment settings to update for the queue.</p>
213    pub fn set_job_attachment_settings(mut self, input: ::std::option::Option<crate::types::JobAttachmentSettings>) -> Self {
214        self.inner = self.inner.set_job_attachment_settings(input);
215        self
216    }
217    /// <p>The job attachment settings to update for the queue.</p>
218    pub fn get_job_attachment_settings(&self) -> &::std::option::Option<crate::types::JobAttachmentSettings> {
219        self.inner.get_job_attachment_settings()
220    }
221    /// <p>The IAM role ARN that's used to run jobs from this queue.</p>
222    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
223        self.inner = self.inner.role_arn(input.into());
224        self
225    }
226    /// <p>The IAM role ARN that's used to run jobs from this queue.</p>
227    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
228        self.inner = self.inner.set_role_arn(input);
229        self
230    }
231    /// <p>The IAM role ARN that's used to run jobs from this queue.</p>
232    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
233        self.inner.get_role_arn()
234    }
235    /// <p>Update the jobs in the queue to run as a specified POSIX user.</p>
236    pub fn job_run_as_user(mut self, input: crate::types::JobRunAsUser) -> Self {
237        self.inner = self.inner.job_run_as_user(input);
238        self
239    }
240    /// <p>Update the jobs in the queue to run as a specified POSIX user.</p>
241    pub fn set_job_run_as_user(mut self, input: ::std::option::Option<crate::types::JobRunAsUser>) -> Self {
242        self.inner = self.inner.set_job_run_as_user(input);
243        self
244    }
245    /// <p>Update the jobs in the queue to run as a specified POSIX user.</p>
246    pub fn get_job_run_as_user(&self) -> &::std::option::Option<crate::types::JobRunAsUser> {
247        self.inner.get_job_run_as_user()
248    }
249    ///
250    /// Appends an item to `requiredFileSystemLocationNamesToAdd`.
251    ///
252    /// To override the contents of this collection use [`set_required_file_system_location_names_to_add`](Self::set_required_file_system_location_names_to_add).
253    ///
254    /// <p>The required file system location names to add to the queue.</p>
255    pub fn required_file_system_location_names_to_add(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
256        self.inner = self.inner.required_file_system_location_names_to_add(input.into());
257        self
258    }
259    /// <p>The required file system location names to add to the queue.</p>
260    pub fn set_required_file_system_location_names_to_add(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
261        self.inner = self.inner.set_required_file_system_location_names_to_add(input);
262        self
263    }
264    /// <p>The required file system location names to add to the queue.</p>
265    pub fn get_required_file_system_location_names_to_add(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
266        self.inner.get_required_file_system_location_names_to_add()
267    }
268    ///
269    /// Appends an item to `requiredFileSystemLocationNamesToRemove`.
270    ///
271    /// To override the contents of this collection use [`set_required_file_system_location_names_to_remove`](Self::set_required_file_system_location_names_to_remove).
272    ///
273    /// <p>The required file system location names to remove from the queue.</p>
274    pub fn required_file_system_location_names_to_remove(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
275        self.inner = self.inner.required_file_system_location_names_to_remove(input.into());
276        self
277    }
278    /// <p>The required file system location names to remove from the queue.</p>
279    pub fn set_required_file_system_location_names_to_remove(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
280        self.inner = self.inner.set_required_file_system_location_names_to_remove(input);
281        self
282    }
283    /// <p>The required file system location names to remove from the queue.</p>
284    pub fn get_required_file_system_location_names_to_remove(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
285        self.inner.get_required_file_system_location_names_to_remove()
286    }
287    ///
288    /// Appends an item to `allowedStorageProfileIdsToAdd`.
289    ///
290    /// To override the contents of this collection use [`set_allowed_storage_profile_ids_to_add`](Self::set_allowed_storage_profile_ids_to_add).
291    ///
292    /// <p>The storage profile IDs to add.</p>
293    pub fn allowed_storage_profile_ids_to_add(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
294        self.inner = self.inner.allowed_storage_profile_ids_to_add(input.into());
295        self
296    }
297    /// <p>The storage profile IDs to add.</p>
298    pub fn set_allowed_storage_profile_ids_to_add(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
299        self.inner = self.inner.set_allowed_storage_profile_ids_to_add(input);
300        self
301    }
302    /// <p>The storage profile IDs to add.</p>
303    pub fn get_allowed_storage_profile_ids_to_add(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
304        self.inner.get_allowed_storage_profile_ids_to_add()
305    }
306    ///
307    /// Appends an item to `allowedStorageProfileIdsToRemove`.
308    ///
309    /// To override the contents of this collection use [`set_allowed_storage_profile_ids_to_remove`](Self::set_allowed_storage_profile_ids_to_remove).
310    ///
311    /// <p>The storage profile ID to remove.</p>
312    pub fn allowed_storage_profile_ids_to_remove(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
313        self.inner = self.inner.allowed_storage_profile_ids_to_remove(input.into());
314        self
315    }
316    /// <p>The storage profile ID to remove.</p>
317    pub fn set_allowed_storage_profile_ids_to_remove(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
318        self.inner = self.inner.set_allowed_storage_profile_ids_to_remove(input);
319        self
320    }
321    /// <p>The storage profile ID to remove.</p>
322    pub fn get_allowed_storage_profile_ids_to_remove(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
323        self.inner.get_allowed_storage_profile_ids_to_remove()
324    }
325}