1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateFuotaTaskInput {
/// <p>The name of a FUOTA task.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The description of the new resource.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.</p>
pub client_request_token: ::std::option::Option<::std::string::String>,
/// <p>The LoRaWAN information used with a FUOTA task.</p>
pub lo_ra_wan: ::std::option::Option<crate::types::LoRaWanFuotaTask>,
/// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
pub firmware_update_image: ::std::option::Option<::std::string::String>,
/// <p>The firmware update role that is to be used with a FUOTA task.</p>
pub firmware_update_role: ::std::option::Option<::std::string::String>,
/// <p>The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <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>
pub redundancy_percent: ::std::option::Option<i32>,
/// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
pub fragment_size_bytes: ::std::option::Option<i32>,
/// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p> <note>
/// <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>
/// </note>
pub fragment_interval_ms: ::std::option::Option<i32>,
}
impl CreateFuotaTaskInput {
/// <p>The name of a FUOTA task.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The description of the new resource.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.</p>
pub fn client_request_token(&self) -> ::std::option::Option<&str> {
self.client_request_token.as_deref()
}
/// <p>The LoRaWAN information used with a FUOTA task.</p>
pub fn lo_ra_wan(&self) -> ::std::option::Option<&crate::types::LoRaWanFuotaTask> {
self.lo_ra_wan.as_ref()
}
/// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
pub fn firmware_update_image(&self) -> ::std::option::Option<&str> {
self.firmware_update_image.as_deref()
}
/// <p>The firmware update role that is to be used with a FUOTA task.</p>
pub fn firmware_update_role(&self) -> ::std::option::Option<&str> {
self.firmware_update_role.as_deref()
}
/// <p>The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.</p>
pub fn tags(&self) -> ::std::option::Option<&[crate::types::Tag]> {
self.tags.as_deref()
}
/// <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>
pub fn redundancy_percent(&self) -> ::std::option::Option<i32> {
self.redundancy_percent
}
/// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
pub fn fragment_size_bytes(&self) -> ::std::option::Option<i32> {
self.fragment_size_bytes
}
/// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p> <note>
/// <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>
/// </note>
pub fn fragment_interval_ms(&self) -> ::std::option::Option<i32> {
self.fragment_interval_ms
}
}
impl CreateFuotaTaskInput {
/// Creates a new builder-style object to manufacture [`CreateFuotaTaskInput`](crate::operation::create_fuota_task::CreateFuotaTaskInput).
pub fn builder() -> crate::operation::create_fuota_task::builders::CreateFuotaTaskInputBuilder {
crate::operation::create_fuota_task::builders::CreateFuotaTaskInputBuilder::default()
}
}
/// A builder for [`CreateFuotaTaskInput`](crate::operation::create_fuota_task::CreateFuotaTaskInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateFuotaTaskInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) client_request_token: ::std::option::Option<::std::string::String>,
pub(crate) lo_ra_wan: ::std::option::Option<crate::types::LoRaWanFuotaTask>,
pub(crate) firmware_update_image: ::std::option::Option<::std::string::String>,
pub(crate) firmware_update_role: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) redundancy_percent: ::std::option::Option<i32>,
pub(crate) fragment_size_bytes: ::std::option::Option<i32>,
pub(crate) fragment_interval_ms: ::std::option::Option<i32>,
}
impl CreateFuotaTaskInputBuilder {
/// <p>The name of a FUOTA task.</p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of a FUOTA task.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of a FUOTA task.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The description of the new resource.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>The description of the new resource.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description of the new resource.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.</p>
pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_request_token = ::std::option::Option::Some(input.into());
self
}
/// <p>Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.</p>
pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_request_token = input;
self
}
/// <p>Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.</p>
pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_request_token
}
/// <p>The LoRaWAN information used with a FUOTA task.</p>
pub fn lo_ra_wan(mut self, input: crate::types::LoRaWanFuotaTask) -> Self {
self.lo_ra_wan = ::std::option::Option::Some(input);
self
}
/// <p>The LoRaWAN information used with a FUOTA task.</p>
pub fn set_lo_ra_wan(mut self, input: ::std::option::Option<crate::types::LoRaWanFuotaTask>) -> Self {
self.lo_ra_wan = input;
self
}
/// <p>The LoRaWAN information used with a FUOTA task.</p>
pub fn get_lo_ra_wan(&self) -> &::std::option::Option<crate::types::LoRaWanFuotaTask> {
&self.lo_ra_wan
}
/// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
pub fn firmware_update_image(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.firmware_update_image = ::std::option::Option::Some(input.into());
self
}
/// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
pub fn set_firmware_update_image(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.firmware_update_image = input;
self
}
/// <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
pub fn get_firmware_update_image(&self) -> &::std::option::Option<::std::string::String> {
&self.firmware_update_image
}
/// <p>The firmware update role that is to be used with a FUOTA task.</p>
pub fn firmware_update_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.firmware_update_role = ::std::option::Option::Some(input.into());
self
}
/// <p>The firmware update role that is to be used with a FUOTA task.</p>
pub fn set_firmware_update_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.firmware_update_role = input;
self
}
/// <p>The firmware update role that is to be used with a FUOTA task.</p>
pub fn get_firmware_update_role(&self) -> &::std::option::Option<::std::string::String> {
&self.firmware_update_role
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// <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>
pub fn redundancy_percent(mut self, input: i32) -> Self {
self.redundancy_percent = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_redundancy_percent(mut self, input: ::std::option::Option<i32>) -> Self {
self.redundancy_percent = input;
self
}
/// <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>
pub fn get_redundancy_percent(&self) -> &::std::option::Option<i32> {
&self.redundancy_percent
}
/// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
pub fn fragment_size_bytes(mut self, input: i32) -> Self {
self.fragment_size_bytes = ::std::option::Option::Some(input);
self
}
/// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
pub fn set_fragment_size_bytes(mut self, input: ::std::option::Option<i32>) -> Self {
self.fragment_size_bytes = input;
self
}
/// <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
pub fn get_fragment_size_bytes(&self) -> &::std::option::Option<i32> {
&self.fragment_size_bytes
}
/// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p> <note>
/// <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>
/// </note>
pub fn fragment_interval_ms(mut self, input: i32) -> Self {
self.fragment_interval_ms = ::std::option::Option::Some(input);
self
}
/// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p> <note>
/// <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>
/// </note>
pub fn set_fragment_interval_ms(mut self, input: ::std::option::Option<i32>) -> Self {
self.fragment_interval_ms = input;
self
}
/// <p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p> <note>
/// <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>
/// </note>
pub fn get_fragment_interval_ms(&self) -> &::std::option::Option<i32> {
&self.fragment_interval_ms
}
/// Consumes the builder and constructs a [`CreateFuotaTaskInput`](crate::operation::create_fuota_task::CreateFuotaTaskInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_fuota_task::CreateFuotaTaskInput, ::aws_smithy_http::operation::error::BuildError> {
::std::result::Result::Ok(crate::operation::create_fuota_task::CreateFuotaTaskInput {
name: self.name,
description: self.description,
client_request_token: self.client_request_token,
lo_ra_wan: self.lo_ra_wan,
firmware_update_image: self.firmware_update_image,
firmware_update_role: self.firmware_update_role,
tags: self.tags,
redundancy_percent: self.redundancy_percent,
fragment_size_bytes: self.fragment_size_bytes,
fragment_interval_ms: self.fragment_interval_ms,
})
}
}