#[non_exhaustive]pub struct OtaUpdateInfoBuilder { /* private fields */ }
Expand description
A builder for OtaUpdateInfo
.
Implementations§
Source§impl OtaUpdateInfoBuilder
impl OtaUpdateInfoBuilder
Sourcepub fn ota_update_id(self, input: impl Into<String>) -> Self
pub fn ota_update_id(self, input: impl Into<String>) -> Self
The OTA update ID.
Sourcepub fn set_ota_update_id(self, input: Option<String>) -> Self
pub fn set_ota_update_id(self, input: Option<String>) -> Self
The OTA update ID.
Sourcepub fn get_ota_update_id(&self) -> &Option<String>
pub fn get_ota_update_id(&self) -> &Option<String>
The OTA update ID.
Sourcepub fn ota_update_arn(self, input: impl Into<String>) -> Self
pub fn ota_update_arn(self, input: impl Into<String>) -> Self
The OTA update ARN.
Sourcepub fn set_ota_update_arn(self, input: Option<String>) -> Self
pub fn set_ota_update_arn(self, input: Option<String>) -> Self
The OTA update ARN.
Sourcepub fn get_ota_update_arn(&self) -> &Option<String>
pub fn get_ota_update_arn(&self) -> &Option<String>
The OTA update ARN.
Sourcepub fn creation_date(self, input: DateTime) -> Self
pub fn creation_date(self, input: DateTime) -> Self
The date when the OTA update was created.
Sourcepub fn set_creation_date(self, input: Option<DateTime>) -> Self
pub fn set_creation_date(self, input: Option<DateTime>) -> Self
The date when the OTA update was created.
Sourcepub fn get_creation_date(&self) -> &Option<DateTime>
pub fn get_creation_date(&self) -> &Option<DateTime>
The date when the OTA update was created.
Sourcepub fn last_modified_date(self, input: DateTime) -> Self
pub fn last_modified_date(self, input: DateTime) -> Self
The date when the OTA update was last updated.
Sourcepub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
The date when the OTA update was last updated.
Sourcepub fn get_last_modified_date(&self) -> &Option<DateTime>
pub fn get_last_modified_date(&self) -> &Option<DateTime>
The date when the OTA update was last updated.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the OTA update.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the OTA update.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the OTA update.
Sourcepub fn targets(self, input: impl Into<String>) -> Self
pub fn targets(self, input: impl Into<String>) -> Self
Appends an item to targets
.
To override the contents of this collection use set_targets
.
The targets of the OTA update.
Sourcepub fn set_targets(self, input: Option<Vec<String>>) -> Self
pub fn set_targets(self, input: Option<Vec<String>>) -> Self
The targets of the OTA update.
Sourcepub fn get_targets(&self) -> &Option<Vec<String>>
pub fn get_targets(&self) -> &Option<Vec<String>>
The targets of the OTA update.
Sourcepub fn protocols(self, input: Protocol) -> Self
pub fn protocols(self, input: Protocol) -> Self
Appends an item to protocols
.
To override the contents of this collection use set_protocols
.
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.
Sourcepub fn set_protocols(self, input: Option<Vec<Protocol>>) -> Self
pub fn set_protocols(self, input: Option<Vec<Protocol>>) -> Self
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.
Sourcepub fn get_protocols(&self) -> &Option<Vec<Protocol>>
pub fn get_protocols(&self) -> &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.
Sourcepub fn aws_job_executions_rollout_config(
self,
input: AwsJobExecutionsRolloutConfig,
) -> Self
pub fn aws_job_executions_rollout_config( self, input: AwsJobExecutionsRolloutConfig, ) -> Self
Configuration for the rollout of OTA updates.
Sourcepub fn set_aws_job_executions_rollout_config(
self,
input: Option<AwsJobExecutionsRolloutConfig>,
) -> Self
pub fn set_aws_job_executions_rollout_config( self, input: Option<AwsJobExecutionsRolloutConfig>, ) -> Self
Configuration for the rollout of OTA updates.
Sourcepub fn get_aws_job_executions_rollout_config(
&self,
) -> &Option<AwsJobExecutionsRolloutConfig>
pub fn get_aws_job_executions_rollout_config( &self, ) -> &Option<AwsJobExecutionsRolloutConfig>
Configuration for the rollout of OTA updates.
Sourcepub fn aws_job_presigned_url_config(
self,
input: AwsJobPresignedUrlConfig,
) -> Self
pub fn aws_job_presigned_url_config( self, input: AwsJobPresignedUrlConfig, ) -> Self
Configuration information for pre-signed URLs. Valid when protocols
contains HTTP.
Sourcepub fn set_aws_job_presigned_url_config(
self,
input: Option<AwsJobPresignedUrlConfig>,
) -> Self
pub fn set_aws_job_presigned_url_config( self, input: Option<AwsJobPresignedUrlConfig>, ) -> Self
Configuration information for pre-signed URLs. Valid when protocols
contains HTTP.
Sourcepub fn get_aws_job_presigned_url_config(
&self,
) -> &Option<AwsJobPresignedUrlConfig>
pub fn get_aws_job_presigned_url_config( &self, ) -> &Option<AwsJobPresignedUrlConfig>
Configuration information for pre-signed URLs. Valid when protocols
contains HTTP.
Sourcepub fn target_selection(self, input: TargetSelection) -> Self
pub fn target_selection(self, input: TargetSelection) -> Self
Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
Sourcepub fn set_target_selection(self, input: Option<TargetSelection>) -> Self
pub fn set_target_selection(self, input: Option<TargetSelection>) -> Self
Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
Sourcepub fn get_target_selection(&self) -> &Option<TargetSelection>
pub fn get_target_selection(&self) -> &Option<TargetSelection>
Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
Sourcepub fn ota_update_files(self, input: OtaUpdateFile) -> Self
pub fn ota_update_files(self, input: OtaUpdateFile) -> Self
Appends an item to ota_update_files
.
To override the contents of this collection use set_ota_update_files
.
A list of files associated with the OTA update.
Sourcepub fn set_ota_update_files(self, input: Option<Vec<OtaUpdateFile>>) -> Self
pub fn set_ota_update_files(self, input: Option<Vec<OtaUpdateFile>>) -> Self
A list of files associated with the OTA update.
Sourcepub fn get_ota_update_files(&self) -> &Option<Vec<OtaUpdateFile>>
pub fn get_ota_update_files(&self) -> &Option<Vec<OtaUpdateFile>>
A list of files associated with the OTA update.
Sourcepub fn ota_update_status(self, input: OtaUpdateStatus) -> Self
pub fn ota_update_status(self, input: OtaUpdateStatus) -> Self
The status of the OTA update.
Sourcepub fn set_ota_update_status(self, input: Option<OtaUpdateStatus>) -> Self
pub fn set_ota_update_status(self, input: Option<OtaUpdateStatus>) -> Self
The status of the OTA update.
Sourcepub fn get_ota_update_status(&self) -> &Option<OtaUpdateStatus>
pub fn get_ota_update_status(&self) -> &Option<OtaUpdateStatus>
The status of the OTA update.
Sourcepub fn aws_iot_job_id(self, input: impl Into<String>) -> Self
pub fn aws_iot_job_id(self, input: impl Into<String>) -> Self
The IoT job ID associated with the OTA update.
Sourcepub fn set_aws_iot_job_id(self, input: Option<String>) -> Self
pub fn set_aws_iot_job_id(self, input: Option<String>) -> Self
The IoT job ID associated with the OTA update.
Sourcepub fn get_aws_iot_job_id(&self) -> &Option<String>
pub fn get_aws_iot_job_id(&self) -> &Option<String>
The IoT job ID associated with the OTA update.
Sourcepub fn aws_iot_job_arn(self, input: impl Into<String>) -> Self
pub fn aws_iot_job_arn(self, input: impl Into<String>) -> Self
The IoT job ARN associated with the OTA update.
Sourcepub fn set_aws_iot_job_arn(self, input: Option<String>) -> Self
pub fn set_aws_iot_job_arn(self, input: Option<String>) -> Self
The IoT job ARN associated with the OTA update.
Sourcepub fn get_aws_iot_job_arn(&self) -> &Option<String>
pub fn get_aws_iot_job_arn(&self) -> &Option<String>
The IoT job ARN associated with the OTA update.
Sourcepub fn error_info(self, input: ErrorInfo) -> Self
pub fn error_info(self, input: ErrorInfo) -> Self
Error information associated with the OTA update.
Sourcepub fn set_error_info(self, input: Option<ErrorInfo>) -> Self
pub fn set_error_info(self, input: Option<ErrorInfo>) -> Self
Error information associated with the OTA update.
Sourcepub fn get_error_info(&self) -> &Option<ErrorInfo>
pub fn get_error_info(&self) -> &Option<ErrorInfo>
Error information associated with the OTA update.
Sourcepub fn additional_parameters(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn additional_parameters( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to additional_parameters
.
To override the contents of this collection use set_additional_parameters
.
A collection of name/value pairs
Sourcepub fn set_additional_parameters(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_additional_parameters( self, input: Option<HashMap<String, String>>, ) -> Self
A collection of name/value pairs
Sourcepub fn get_additional_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_additional_parameters(&self) -> &Option<HashMap<String, String>>
A collection of name/value pairs
Sourcepub fn build(self) -> OtaUpdateInfo
pub fn build(self) -> OtaUpdateInfo
Consumes the builder and constructs a OtaUpdateInfo
.
Trait Implementations§
Source§impl Clone for OtaUpdateInfoBuilder
impl Clone for OtaUpdateInfoBuilder
Source§fn clone(&self) -> OtaUpdateInfoBuilder
fn clone(&self) -> OtaUpdateInfoBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OtaUpdateInfoBuilder
impl Debug for OtaUpdateInfoBuilder
Source§impl Default for OtaUpdateInfoBuilder
impl Default for OtaUpdateInfoBuilder
Source§fn default() -> OtaUpdateInfoBuilder
fn default() -> OtaUpdateInfoBuilder
Source§impl PartialEq for OtaUpdateInfoBuilder
impl PartialEq for OtaUpdateInfoBuilder
impl StructuralPartialEq for OtaUpdateInfoBuilder
Auto Trait Implementations§
impl Freeze for OtaUpdateInfoBuilder
impl RefUnwindSafe for OtaUpdateInfoBuilder
impl Send for OtaUpdateInfoBuilder
impl Sync for OtaUpdateInfoBuilder
impl Unpin for OtaUpdateInfoBuilder
impl UnwindSafe for OtaUpdateInfoBuilder
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);