#[non_exhaustive]pub struct CreateFuotaTaskInput {
pub name: Option<String>,
pub description: Option<String>,
pub client_request_token: Option<String>,
pub lo_ra_wan: Option<LoRaWanFuotaTask>,
pub firmware_update_image: Option<String>,
pub firmware_update_role: Option<String>,
pub tags: Option<Vec<Tag>>,
pub redundancy_percent: Option<i32>,
pub fragment_size_bytes: Option<i32>,
pub fragment_interval_ms: Option<i32>,
pub descriptor: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
The name of a FUOTA task.
description: Option<String>
The description of the new resource.
client_request_token: Option<String>
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
lo_ra_wan: Option<LoRaWanFuotaTask>
The LoRaWAN information used with a FUOTA task.
firmware_update_image: Option<String>
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
firmware_update_role: Option<String>
The firmware update role that is to be used with a FUOTA task.
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
redundancy_percent: Option<i32>
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 RedundancyPercent
set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
fragment_size_bytes: Option<i32>
The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.
fragment_interval_ms: Option<i32>
The interval for sending fragments in milliseconds, rounded to the nearest second.
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.
descriptor: Option<String>
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.
Implementations§
Source§impl CreateFuotaTaskInput
impl CreateFuotaTaskInput
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the new resource.
Sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
Sourcepub fn lo_ra_wan(&self) -> Option<&LoRaWanFuotaTask>
pub fn lo_ra_wan(&self) -> Option<&LoRaWanFuotaTask>
The LoRaWAN information used with a FUOTA task.
Sourcepub fn firmware_update_image(&self) -> Option<&str>
pub fn firmware_update_image(&self) -> Option<&str>
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
Sourcepub fn firmware_update_role(&self) -> Option<&str>
pub fn firmware_update_role(&self) -> Option<&str>
The firmware update role that is to be used with a FUOTA task.
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn redundancy_percent(&self) -> Option<i32>
pub fn redundancy_percent(&self) -> Option<i32>
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 RedundancyPercent
set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
Sourcepub fn fragment_size_bytes(&self) -> Option<i32>
pub fn fragment_size_bytes(&self) -> Option<i32>
The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.
Sourcepub fn fragment_interval_ms(&self) -> Option<i32>
pub fn fragment_interval_ms(&self) -> Option<i32>
The interval for sending fragments in milliseconds, rounded to the nearest second.
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.
Sourcepub fn descriptor(&self) -> Option<&str>
pub fn descriptor(&self) -> Option<&str>
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.
Source§impl CreateFuotaTaskInput
impl CreateFuotaTaskInput
Sourcepub fn builder() -> CreateFuotaTaskInputBuilder
pub fn builder() -> CreateFuotaTaskInputBuilder
Creates a new builder-style object to manufacture CreateFuotaTaskInput
.
Trait Implementations§
Source§impl Clone for CreateFuotaTaskInput
impl Clone for CreateFuotaTaskInput
Source§fn clone(&self) -> CreateFuotaTaskInput
fn clone(&self) -> CreateFuotaTaskInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateFuotaTaskInput
impl Debug for CreateFuotaTaskInput
Source§impl PartialEq for CreateFuotaTaskInput
impl PartialEq for CreateFuotaTaskInput
impl StructuralPartialEq for CreateFuotaTaskInput
Auto Trait Implementations§
impl Freeze for CreateFuotaTaskInput
impl RefUnwindSafe for CreateFuotaTaskInput
impl Send for CreateFuotaTaskInput
impl Sync for CreateFuotaTaskInput
impl Unpin for CreateFuotaTaskInput
impl UnwindSafe for CreateFuotaTaskInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);