aws_sdk_iotmanagedintegrations/operation/create_ota_task/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_ota_task::_create_ota_task_output::CreateOtaTaskOutputBuilder;
3
4pub use crate::operation::create_ota_task::_create_ota_task_input::CreateOtaTaskInputBuilder;
5
6impl crate::operation::create_ota_task::builders::CreateOtaTaskInputBuilder {
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_ota_task::CreateOtaTaskOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_ota_task::CreateOtaTaskError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_ota_task();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateOtaTask`.
24///
25/// <p>Create an over-the-air (OTA) task to update a device.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateOtaTaskFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_ota_task::builders::CreateOtaTaskInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_ota_task::CreateOtaTaskOutput,
35        crate::operation::create_ota_task::CreateOtaTaskError,
36    > for CreateOtaTaskFluentBuilder
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_ota_task::CreateOtaTaskOutput,
44            crate::operation::create_ota_task::CreateOtaTaskError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateOtaTaskFluentBuilder {
51    /// Creates a new `CreateOtaTaskFluentBuilder`.
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 CreateOtaTask as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_ota_task::builders::CreateOtaTaskInputBuilder {
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_ota_task::CreateOtaTaskOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_ota_task::CreateOtaTaskError,
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_ota_task::CreateOtaTask::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_ota_task::CreateOtaTask::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_ota_task::CreateOtaTaskOutput,
97        crate::operation::create_ota_task::CreateOtaTaskError,
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 description of the over-the-air (OTA) task.</p>
112    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.description(input.into());
114        self
115    }
116    /// <p>The description of the over-the-air (OTA) task.</p>
117    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_description(input);
119        self
120    }
121    /// <p>The description of the over-the-air (OTA) task.</p>
122    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_description()
124    }
125    /// <p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p>
126    pub fn s3_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.s3_url(input.into());
128        self
129    }
130    /// <p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p>
131    pub fn set_s3_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_s3_url(input);
133        self
134    }
135    /// <p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p>
136    pub fn get_s3_url(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_s3_url()
138    }
139    /// <p>The connection protocol the over-the-air (OTA) task uses to update the device.</p>
140    pub fn protocol(mut self, input: crate::types::OtaProtocol) -> Self {
141        self.inner = self.inner.protocol(input);
142        self
143    }
144    /// <p>The connection protocol the over-the-air (OTA) task uses to update the device.</p>
145    pub fn set_protocol(mut self, input: ::std::option::Option<crate::types::OtaProtocol>) -> Self {
146        self.inner = self.inner.set_protocol(input);
147        self
148    }
149    /// <p>The connection protocol the over-the-air (OTA) task uses to update the device.</p>
150    pub fn get_protocol(&self) -> &::std::option::Option<crate::types::OtaProtocol> {
151        self.inner.get_protocol()
152    }
153    ///
154    /// Appends an item to `Target`.
155    ///
156    /// To override the contents of this collection use [`set_target`](Self::set_target).
157    ///
158    /// <p>The device targeted for the over-the-air (OTA) task.</p>
159    pub fn target(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
160        self.inner = self.inner.target(input.into());
161        self
162    }
163    /// <p>The device targeted for the over-the-air (OTA) task.</p>
164    pub fn set_target(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
165        self.inner = self.inner.set_target(input);
166        self
167    }
168    /// <p>The device targeted for the over-the-air (OTA) task.</p>
169    pub fn get_target(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
170        self.inner.get_target()
171    }
172    /// <p>The identifier for the over-the-air (OTA) task configuration.</p>
173    pub fn task_configuration_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
174        self.inner = self.inner.task_configuration_id(input.into());
175        self
176    }
177    /// <p>The identifier for the over-the-air (OTA) task configuration.</p>
178    pub fn set_task_configuration_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
179        self.inner = self.inner.set_task_configuration_id(input);
180        self
181    }
182    /// <p>The identifier for the over-the-air (OTA) task configuration.</p>
183    pub fn get_task_configuration_id(&self) -> &::std::option::Option<::std::string::String> {
184        self.inner.get_task_configuration_id()
185    }
186    /// <p>The deployment mechanism for the over-the-air (OTA) task.</p>
187    pub fn ota_mechanism(mut self, input: crate::types::OtaMechanism) -> Self {
188        self.inner = self.inner.ota_mechanism(input);
189        self
190    }
191    /// <p>The deployment mechanism for the over-the-air (OTA) task.</p>
192    pub fn set_ota_mechanism(mut self, input: ::std::option::Option<crate::types::OtaMechanism>) -> Self {
193        self.inner = self.inner.set_ota_mechanism(input);
194        self
195    }
196    /// <p>The deployment mechanism for the over-the-air (OTA) task.</p>
197    pub fn get_ota_mechanism(&self) -> &::std::option::Option<crate::types::OtaMechanism> {
198        self.inner.get_ota_mechanism()
199    }
200    /// <p>The frequency type for the over-the-air (OTA) task.</p>
201    pub fn ota_type(mut self, input: crate::types::OtaType) -> Self {
202        self.inner = self.inner.ota_type(input);
203        self
204    }
205    /// <p>The frequency type for the over-the-air (OTA) task.</p>
206    pub fn set_ota_type(mut self, input: ::std::option::Option<crate::types::OtaType>) -> Self {
207        self.inner = self.inner.set_ota_type(input);
208        self
209    }
210    /// <p>The frequency type for the over-the-air (OTA) task.</p>
211    pub fn get_ota_type(&self) -> &::std::option::Option<crate::types::OtaType> {
212        self.inner.get_ota_type()
213    }
214    /// <p>The query string to add things to the thing group.</p>
215    pub fn ota_target_query_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
216        self.inner = self.inner.ota_target_query_string(input.into());
217        self
218    }
219    /// <p>The query string to add things to the thing group.</p>
220    pub fn set_ota_target_query_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
221        self.inner = self.inner.set_ota_target_query_string(input);
222        self
223    }
224    /// <p>The query string to add things to the thing group.</p>
225    pub fn get_ota_target_query_string(&self) -> &::std::option::Option<::std::string::String> {
226        self.inner.get_ota_target_query_string()
227    }
228    /// <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
229    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
230        self.inner = self.inner.client_token(input.into());
231        self
232    }
233    /// <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
234    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
235        self.inner = self.inner.set_client_token(input);
236        self
237    }
238    /// <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>
239    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
240        self.inner.get_client_token()
241    }
242    /// <p>Over-the-air (OTA) task scheduling config.</p>
243    pub fn ota_scheduling_config(mut self, input: crate::types::OtaTaskSchedulingConfig) -> Self {
244        self.inner = self.inner.ota_scheduling_config(input);
245        self
246    }
247    /// <p>Over-the-air (OTA) task scheduling config.</p>
248    pub fn set_ota_scheduling_config(mut self, input: ::std::option::Option<crate::types::OtaTaskSchedulingConfig>) -> Self {
249        self.inner = self.inner.set_ota_scheduling_config(input);
250        self
251    }
252    /// <p>Over-the-air (OTA) task scheduling config.</p>
253    pub fn get_ota_scheduling_config(&self) -> &::std::option::Option<crate::types::OtaTaskSchedulingConfig> {
254        self.inner.get_ota_scheduling_config()
255    }
256    /// <p>Over-the-air (OTA) task retry config.</p>
257    pub fn ota_task_execution_retry_config(mut self, input: crate::types::OtaTaskExecutionRetryConfig) -> Self {
258        self.inner = self.inner.ota_task_execution_retry_config(input);
259        self
260    }
261    /// <p>Over-the-air (OTA) task retry config.</p>
262    pub fn set_ota_task_execution_retry_config(mut self, input: ::std::option::Option<crate::types::OtaTaskExecutionRetryConfig>) -> Self {
263        self.inner = self.inner.set_ota_task_execution_retry_config(input);
264        self
265    }
266    /// <p>Over-the-air (OTA) task retry config.</p>
267    pub fn get_ota_task_execution_retry_config(&self) -> &::std::option::Option<crate::types::OtaTaskExecutionRetryConfig> {
268        self.inner.get_ota_task_execution_retry_config()
269    }
270    ///
271    /// Adds a key-value pair to `Tags`.
272    ///
273    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
274    ///
275    /// <p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p>
276    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
277        self.inner = self.inner.tags(k.into(), v.into());
278        self
279    }
280    /// <p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p>
281    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
282        self.inner = self.inner.set_tags(input);
283        self
284    }
285    /// <p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p>
286    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
287        self.inner.get_tags()
288    }
289}
aws_sdk_iotmanagedintegrations/operation/create_ota_task/builders.rs

aws_sdk_iotmanagedintegrations/operation/create_ota_task/
builders.rs
