aws_sdk_iotwireless/operation/update_fuota_task/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_fuota_task::_update_fuota_task_output::UpdateFuotaTaskOutputBuilder;
3
4pub use crate::operation::update_fuota_task::_update_fuota_task_input::UpdateFuotaTaskInputBuilder;
5
6impl crate::operation::update_fuota_task::builders::UpdateFuotaTaskInputBuilder {
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_fuota_task::UpdateFuotaTaskOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_fuota_task::UpdateFuotaTaskError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_fuota_task();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateFuotaTask`.
24///
25/// <p>Updates properties of a FUOTA task.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateFuotaTaskFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::update_fuota_task::builders::UpdateFuotaTaskInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::update_fuota_task::UpdateFuotaTaskOutput,
35        crate::operation::update_fuota_task::UpdateFuotaTaskError,
36    > for UpdateFuotaTaskFluentBuilder
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_fuota_task::UpdateFuotaTaskOutput,
44            crate::operation::update_fuota_task::UpdateFuotaTaskError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl UpdateFuotaTaskFluentBuilder {
51    /// Creates a new `UpdateFuotaTaskFluentBuilder`.
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 UpdateFuotaTask as a reference.
60    pub fn as_input(&self) -> &crate::operation::update_fuota_task::builders::UpdateFuotaTaskInputBuilder {
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_fuota_task::UpdateFuotaTaskOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::update_fuota_task::UpdateFuotaTaskError,
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_fuota_task::UpdateFuotaTask::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::update_fuota_task::UpdateFuotaTask::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_fuota_task::UpdateFuotaTaskOutput,
97        crate::operation::update_fuota_task::UpdateFuotaTaskError,
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 ID of a FUOTA task.</p>
112    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.id(input.into());
114        self
115    }
116    /// <p>The ID of a FUOTA task.</p>
117    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_id(input);
119        self
120    }
121    /// <p>The ID of a FUOTA task.</p>
122    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_id()
124    }
125    /// <p>The name of a FUOTA task.</p>
126    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.name(input.into());
128        self
129    }
130    /// <p>The name of a FUOTA task.</p>
131    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_name(input);
133        self
134    }
135    /// <p>The name of a FUOTA task.</p>
136    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_name()
138    }
139    /// <p>The description of the new resource.</p>
140    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.description(input.into());
142        self
143    }
144    /// <p>The description of the new resource.</p>
145    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_description(input);
147        self
148    }
149    /// <p>The description of the new resource.</p>
150    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_description()
152    }
153    /// <p>The LoRaWAN information used with a FUOTA task.</p>
154    pub fn lo_ra_wan(mut self, input: crate::types::LoRaWanFuotaTask) -> Self {
155        self.inner = self.inner.lo_ra_wan(input);
156        self
157    }
158    /// <p>The LoRaWAN information used with a FUOTA task.</p>
159    pub fn set_lo_ra_wan(mut self, input: ::std::option::Option<crate::types::LoRaWanFuotaTask>) -> Self {
160        self.inner = self.inner.set_lo_ra_wan(input);
161        self
162    }
163    /// <p>The LoRaWAN information used with a FUOTA task.</p>
164    pub fn get_lo_ra_wan(&self) -> &::std::option::Option<crate::types::LoRaWanFuotaTask> {
165        self.inner.get_lo_ra_wan()
166    }
167    /// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
168    pub fn firmware_update_image(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.firmware_update_image(input.into());
170        self
171    }
172    /// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
173    pub fn set_firmware_update_image(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174        self.inner = self.inner.set_firmware_update_image(input);
175        self
176    }
177    /// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
178    pub fn get_firmware_update_image(&self) -> &::std::option::Option<::std::string::String> {
179        self.inner.get_firmware_update_image()
180    }
181    /// <p>The firmware update role that is to be used with a FUOTA task.</p>
182    pub fn firmware_update_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
183        self.inner = self.inner.firmware_update_role(input.into());
184        self
185    }
186    /// <p>The firmware update role that is to be used with a FUOTA task.</p>
187    pub fn set_firmware_update_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188        self.inner = self.inner.set_firmware_update_role(input);
189        self
190    }
191    /// <p>The firmware update role that is to be used with a FUOTA task.</p>
192    pub fn get_firmware_update_role(&self) -> &::std::option::Option<::std::string::String> {
193        self.inner.get_firmware_update_role()
194    }
195    /// <p>The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.</p>
196    pub fn redundancy_percent(mut self, input: i32) -> Self {
197        self.inner = self.inner.redundancy_percent(input);
198        self
199    }
200    /// <p>The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.</p>
201    pub fn set_redundancy_percent(mut self, input: ::std::option::Option<i32>) -> Self {
202        self.inner = self.inner.set_redundancy_percent(input);
203        self
204    }
205    /// <p>The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.</p>
206    pub fn get_redundancy_percent(&self) -> &::std::option::Option<i32> {
207        self.inner.get_redundancy_percent()
208    }
209    /// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
210    pub fn fragment_size_bytes(mut self, input: i32) -> Self {
211        self.inner = self.inner.fragment_size_bytes(input);
212        self
213    }
214    /// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
215    pub fn set_fragment_size_bytes(mut self, input: ::std::option::Option<i32>) -> Self {
216        self.inner = self.inner.set_fragment_size_bytes(input);
217        self
218    }
219    /// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
220    pub fn get_fragment_size_bytes(&self) -> &::std::option::Option<i32> {
221        self.inner.get_fragment_size_bytes()
222    }
223    /// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p><note>
224    /// <p>This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.</p>
225    /// </note>
226    pub fn fragment_interval_ms(mut self, input: i32) -> Self {
227        self.inner = self.inner.fragment_interval_ms(input);
228        self
229    }
230    /// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p><note>
231    /// <p>This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.</p>
232    /// </note>
233    pub fn set_fragment_interval_ms(mut self, input: ::std::option::Option<i32>) -> Self {
234        self.inner = self.inner.set_fragment_interval_ms(input);
235        self
236    }
237    /// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p><note>
238    /// <p>This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.</p>
239    /// </note>
240    pub fn get_fragment_interval_ms(&self) -> &::std::option::Option<i32> {
241        self.inner.get_fragment_interval_ms()
242    }
243    /// <p>The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.</p>
244    pub fn descriptor(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
245        self.inner = self.inner.descriptor(input.into());
246        self
247    }
248    /// <p>The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.</p>
249    pub fn set_descriptor(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
250        self.inner = self.inner.set_descriptor(input);
251        self
252    }
253    /// <p>The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.</p>
254    pub fn get_descriptor(&self) -> &::std::option::Option<::std::string::String> {
255        self.inner.get_descriptor()
256    }
257}
aws_sdk_iotwireless/operation/update_fuota_task/builders.rs

aws_sdk_iotwireless/operation/update_fuota_task/
builders.rs
