Struct OtaUpdateInfo

#[non_exhaustive]
pub struct OtaUpdateInfo {

    pub ota_update_id: Option<String>,
    pub ota_update_arn: Option<String>,
    pub creation_date: Option<DateTime>,
    pub last_modified_date: Option<DateTime>,
    pub description: Option<String>,
    pub targets: Option<Vec<String>>,
    pub protocols: Option<Vec<Protocol>>,
    pub aws_job_executions_rollout_config: Option<AwsJobExecutionsRolloutConfig>,
    pub aws_job_presigned_url_config: Option<AwsJobPresignedUrlConfig>,
    pub target_selection: Option<TargetSelection>,
    pub ota_update_files: Option<Vec<OtaUpdateFile>>,
    pub ota_update_status: Option<OtaUpdateStatus>,
    pub aws_iot_job_id: Option<String>,
    pub aws_iot_job_arn: Option<String>,
    pub error_info: Option<ErrorInfo>,
    pub additional_parameters: Option<HashMap<String, String>>,
}

Information about an OTA update.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ota_update_id: Option<String>

The OTA update ID.

ota_update_arn: Option<String>

The OTA update ARN.

creation_date: Option<DateTime>

The date when the OTA update was created.

last_modified_date: Option<DateTime>

The date when the OTA update was last updated.

description: Option<String>

A description of the OTA update.

targets: Option<Vec<String>>

The targets of the OTA update.

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.

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. Valid when protocols contains HTTP.

target_selection: 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.

ota_update_files: Option<Vec<OtaUpdateFile>>

A list of files associated with the OTA update.

ota_update_status: Option<OtaUpdateStatus>

The status of the OTA update.

aws_iot_job_id: Option<String>

The IoT job ID associated with the OTA update.

aws_iot_job_arn: Option<String>

The IoT job ARN associated with the OTA update.

error_info: Option<ErrorInfo>

Error information associated with the OTA update.

additional_parameters: Option<HashMap<String, String>>

A collection of name/value pairs

Implementations

impl OtaUpdateInfo

pub fn ota_update_id(&self) -> Option<&str>

The OTA update ID.

pub fn ota_update_arn(&self) -> Option<&str>

The OTA update ARN.

pub fn creation_date(&self) -> Option<&DateTime>

The date when the OTA update was created.

pub fn last_modified_date(&self) -> Option<&DateTime>

The date when the OTA update was last updated.

pub fn description(&self) -> Option<&str>

A description of the OTA update.

pub fn targets(&self) -> &[String]

The targets of 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 .targets.is_none().

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().

pub fn aws_job_executions_rollout_config( &self, ) -> Option<&AwsJobExecutionsRolloutConfig>

Configuration for the rollout of OTA updates.

pub fn aws_job_presigned_url_config(&self) -> Option<&AwsJobPresignedUrlConfig>

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

pub fn 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.

pub fn ota_update_files(&self) -> &[OtaUpdateFile]

A list of files associated with 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 .ota_update_files.is_none().

pub fn ota_update_status(&self) -> Option<&OtaUpdateStatus>

The status of the OTA update.

pub fn aws_iot_job_id(&self) -> Option<&str>

The IoT job ID associated with the OTA update.

pub fn aws_iot_job_arn(&self) -> Option<&str>

The IoT job ARN associated with the OTA update.

pub fn error_info(&self) -> Option<&ErrorInfo>

Error information associated with the OTA update.

pub fn additional_parameters(&self) -> Option<&HashMap<String, String>>

A collection of name/value pairs

impl OtaUpdateInfo

pub fn builder() -> OtaUpdateInfoBuilder

Creates a new builder-style object to manufacture OtaUpdateInfo.

Trait Implementations

impl Clone for OtaUpdateInfo

fn clone(&self) -> OtaUpdateInfo

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OtaUpdateInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OtaUpdateInfo

fn eq(&self, other: &OtaUpdateInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OtaUpdateInfo