aws_sdk_deadline/operation/create_queue/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_queue::_create_queue_output::CreateQueueOutputBuilder;
3
4pub use crate::operation::create_queue::_create_queue_input::CreateQueueInputBuilder;
5
6impl crate::operation::create_queue::builders::CreateQueueInputBuilder {
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::create_queue::CreateQueueOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_queue::CreateQueueError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_queue();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateQueue`.
24///
25/// <p>Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateQueueFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_queue::builders::CreateQueueInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_queue::CreateQueueOutput,
35        crate::operation::create_queue::CreateQueueError,
36    > for CreateQueueFluentBuilder
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::create_queue::CreateQueueOutput,
44            crate::operation::create_queue::CreateQueueError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateQueueFluentBuilder {
51    /// Creates a new `CreateQueueFluentBuilder`.
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 CreateQueue as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_queue::builders::CreateQueueInputBuilder {
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::create_queue::CreateQueueOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_queue::CreateQueueError,
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::create_queue::CreateQueue::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_queue::CreateQueue::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::create_queue::CreateQueueOutput,
97        crate::operation::create_queue::CreateQueueError,
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 unique token which the server uses to recognize retries of the same request.</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 unique token which the server uses to recognize retries of the same request.</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 unique token which the server uses to recognize retries of the same request.</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 of the farm to connect to 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 of the farm to connect to 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 of the farm to connect to 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 display name of the queue.</p><important>
140    /// <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>
141    /// </important>
142    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.display_name(input.into());
144        self
145    }
146    /// <p>The display name of the queue.</p><important>
147    /// <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>
148    /// </important>
149    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
150        self.inner = self.inner.set_display_name(input);
151        self
152    }
153    /// <p>The display name of the queue.</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 get_display_name(&self) -> &::std::option::Option<::std::string::String> {
157        self.inner.get_display_name()
158    }
159    /// <p>The description of the queue.</p><important>
160    /// <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>
161    /// </important>
162    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
163        self.inner = self.inner.description(input.into());
164        self
165    }
166    /// <p>The description of the queue.</p><important>
167    /// <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>
168    /// </important>
169    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
170        self.inner = self.inner.set_description(input);
171        self
172    }
173    /// <p>The description of the queue.</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 get_description(&self) -> &::std::option::Option<::std::string::String> {
177        self.inner.get_description()
178    }
179    /// <p>The default action to take on a queue if a budget isn't configured.</p>
180    pub fn default_budget_action(mut self, input: crate::types::DefaultQueueBudgetAction) -> Self {
181        self.inner = self.inner.default_budget_action(input);
182        self
183    }
184    /// <p>The default action to take on a queue if a budget isn't configured.</p>
185    pub fn set_default_budget_action(mut self, input: ::std::option::Option<crate::types::DefaultQueueBudgetAction>) -> Self {
186        self.inner = self.inner.set_default_budget_action(input);
187        self
188    }
189    /// <p>The default action to take on a queue if a budget isn't configured.</p>
190    pub fn get_default_budget_action(&self) -> &::std::option::Option<crate::types::DefaultQueueBudgetAction> {
191        self.inner.get_default_budget_action()
192    }
193    /// <p>The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.</p>
194    pub fn job_attachment_settings(mut self, input: crate::types::JobAttachmentSettings) -> Self {
195        self.inner = self.inner.job_attachment_settings(input);
196        self
197    }
198    /// <p>The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.</p>
199    pub fn set_job_attachment_settings(mut self, input: ::std::option::Option<crate::types::JobAttachmentSettings>) -> Self {
200        self.inner = self.inner.set_job_attachment_settings(input);
201        self
202    }
203    /// <p>The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.</p>
204    pub fn get_job_attachment_settings(&self) -> &::std::option::Option<crate::types::JobAttachmentSettings> {
205        self.inner.get_job_attachment_settings()
206    }
207    /// <p>The IAM role ARN that workers will use while running jobs for this queue.</p>
208    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
209        self.inner = self.inner.role_arn(input.into());
210        self
211    }
212    /// <p>The IAM role ARN that workers will use while running jobs for this queue.</p>
213    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
214        self.inner = self.inner.set_role_arn(input);
215        self
216    }
217    /// <p>The IAM role ARN that workers will use while running jobs for this queue.</p>
218    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
219        self.inner.get_role_arn()
220    }
221    /// <p>The jobs in the queue run as the specified POSIX user.</p>
222    pub fn job_run_as_user(mut self, input: crate::types::JobRunAsUser) -> Self {
223        self.inner = self.inner.job_run_as_user(input);
224        self
225    }
226    /// <p>The jobs in the queue run as the specified POSIX user.</p>
227    pub fn set_job_run_as_user(mut self, input: ::std::option::Option<crate::types::JobRunAsUser>) -> Self {
228        self.inner = self.inner.set_job_run_as_user(input);
229        self
230    }
231    /// <p>The jobs in the queue run as the specified POSIX user.</p>
232    pub fn get_job_run_as_user(&self) -> &::std::option::Option<crate::types::JobRunAsUser> {
233        self.inner.get_job_run_as_user()
234    }
235    ///
236    /// Appends an item to `requiredFileSystemLocationNames`.
237    ///
238    /// To override the contents of this collection use [`set_required_file_system_location_names`](Self::set_required_file_system_location_names).
239    ///
240    /// <p>The file system location name to include in the queue.</p>
241    pub fn required_file_system_location_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
242        self.inner = self.inner.required_file_system_location_names(input.into());
243        self
244    }
245    /// <p>The file system location name to include in the queue.</p>
246    pub fn set_required_file_system_location_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
247        self.inner = self.inner.set_required_file_system_location_names(input);
248        self
249    }
250    /// <p>The file system location name to include in the queue.</p>
251    pub fn get_required_file_system_location_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
252        self.inner.get_required_file_system_location_names()
253    }
254    ///
255    /// Appends an item to `allowedStorageProfileIds`.
256    ///
257    /// To override the contents of this collection use [`set_allowed_storage_profile_ids`](Self::set_allowed_storage_profile_ids).
258    ///
259    /// <p>The storage profile IDs to include in the queue.</p>
260    pub fn allowed_storage_profile_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
261        self.inner = self.inner.allowed_storage_profile_ids(input.into());
262        self
263    }
264    /// <p>The storage profile IDs to include in the queue.</p>
265    pub fn set_allowed_storage_profile_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
266        self.inner = self.inner.set_allowed_storage_profile_ids(input);
267        self
268    }
269    /// <p>The storage profile IDs to include in the queue.</p>
270    pub fn get_allowed_storage_profile_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
271        self.inner.get_allowed_storage_profile_ids()
272    }
273    ///
274    /// Adds a key-value pair to `tags`.
275    ///
276    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
277    ///
278    /// <p>Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p>
279    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
280        self.inner = self.inner.tags(k.into(), v.into());
281        self
282    }
283    /// <p>Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p>
284    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
285        self.inner = self.inner.set_tags(input);
286        self
287    }
288    /// <p>Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p>
289    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
290        self.inner.get_tags()
291    }
292}
aws_sdk_deadline/operation/create_queue/builders.rs

aws_sdk_deadline/operation/create_queue/
builders.rs
