#[non_exhaustive]pub struct CreateOtaUpdateInput {Show 13 fields
pub ota_update_id: Option<String>,
pub description: Option<String>,
pub targets: Option<Vec<String>>,
pub protocols: Option<Vec<Protocol>>,
pub target_selection: Option<TargetSelection>,
pub aws_job_executions_rollout_config: Option<AwsJobExecutionsRolloutConfig>,
pub aws_job_presigned_url_config: Option<AwsJobPresignedUrlConfig>,
pub aws_job_abort_config: Option<AwsJobAbortConfig>,
pub aws_job_timeout_config: Option<AwsJobTimeoutConfig>,
pub files: Option<Vec<OtaUpdateFile>>,
pub role_arn: Option<String>,
pub additional_parameters: Option<HashMap<String, String>>,
pub tags: Option<Vec<Tag>>,
}
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.ota_update_id: Option<String>
The ID of the OTA update to be created.
description: Option<String>
The description of the OTA update.
targets: Option<Vec<String>>
The devices targeted to receive OTA updates.
protocols: Option<Vec<Protocol>>
The protocol used to transfer the OTA update image. Valid values are \[HTTP\], \[MQTT\], \[HTTP, MQTT\]. When both HTTP and MQTT are specified, the target device can choose the protocol.
target_selection: Option<TargetSelection>
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
aws_job_executions_rollout_config: Option<AwsJobExecutionsRolloutConfig>
Configuration for the rollout of OTA updates.
aws_job_presigned_url_config: Option<AwsJobPresignedUrlConfig>
Configuration information for pre-signed URLs.
aws_job_abort_config: Option<AwsJobAbortConfig>
The criteria that determine when and how a job abort takes place.
aws_job_timeout_config: Option<AwsJobTimeoutConfig>
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT
.
files: Option<Vec<OtaUpdateFile>>
The files to be streamed by the OTA update.
role_arn: Option<String>
The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
additional_parameters: Option<HashMap<String, String>>
A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
Metadata which can be used to manage updates.
Implementations§
Source§impl CreateOtaUpdateInput
impl CreateOtaUpdateInput
Sourcepub fn ota_update_id(&self) -> Option<&str>
pub fn ota_update_id(&self) -> Option<&str>
The ID of the OTA update to be created.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the OTA update.
Sourcepub fn targets(&self) -> &[String]
pub fn targets(&self) -> &[String]
The devices targeted to receive OTA updates.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none()
.
Sourcepub fn protocols(&self) -> &[Protocol]
pub fn protocols(&self) -> &[Protocol]
The protocol used to transfer the OTA update image. Valid values are \[HTTP\], \[MQTT\], \[HTTP, MQTT\]. When both HTTP and MQTT are specified, the target device can choose the protocol.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .protocols.is_none()
.
Sourcepub fn target_selection(&self) -> Option<&TargetSelection>
pub fn target_selection(&self) -> Option<&TargetSelection>
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Sourcepub fn aws_job_executions_rollout_config(
&self,
) -> Option<&AwsJobExecutionsRolloutConfig>
pub fn aws_job_executions_rollout_config( &self, ) -> Option<&AwsJobExecutionsRolloutConfig>
Configuration for the rollout of OTA updates.
Sourcepub fn aws_job_presigned_url_config(&self) -> Option<&AwsJobPresignedUrlConfig>
pub fn aws_job_presigned_url_config(&self) -> Option<&AwsJobPresignedUrlConfig>
Configuration information for pre-signed URLs.
Sourcepub fn aws_job_abort_config(&self) -> Option<&AwsJobAbortConfig>
pub fn aws_job_abort_config(&self) -> Option<&AwsJobAbortConfig>
The criteria that determine when and how a job abort takes place.
Sourcepub fn aws_job_timeout_config(&self) -> Option<&AwsJobTimeoutConfig>
pub fn aws_job_timeout_config(&self) -> Option<&AwsJobTimeoutConfig>
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT
.
Sourcepub fn files(&self) -> &[OtaUpdateFile]
pub fn files(&self) -> &[OtaUpdateFile]
The files to be streamed by the OTA update.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .files.is_none()
.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
Sourcepub fn additional_parameters(&self) -> Option<&HashMap<String, String>>
pub fn additional_parameters(&self) -> Option<&HashMap<String, String>>
A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
Metadata which can be used to manage updates.
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()
.
Source§impl CreateOtaUpdateInput
impl CreateOtaUpdateInput
Sourcepub fn builder() -> CreateOtaUpdateInputBuilder
pub fn builder() -> CreateOtaUpdateInputBuilder
Creates a new builder-style object to manufacture CreateOtaUpdateInput
.
Trait Implementations§
Source§impl Clone for CreateOtaUpdateInput
impl Clone for CreateOtaUpdateInput
Source§fn clone(&self) -> CreateOtaUpdateInput
fn clone(&self) -> CreateOtaUpdateInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateOtaUpdateInput
impl Debug for CreateOtaUpdateInput
Source§impl PartialEq for CreateOtaUpdateInput
impl PartialEq for CreateOtaUpdateInput
impl StructuralPartialEq for CreateOtaUpdateInput
Auto Trait Implementations§
impl Freeze for CreateOtaUpdateInput
impl RefUnwindSafe for CreateOtaUpdateInput
impl Send for CreateOtaUpdateInput
impl Sync for CreateOtaUpdateInput
impl Unpin for CreateOtaUpdateInput
impl UnwindSafe for CreateOtaUpdateInput
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);