AWS SDK for C++  1.9.160
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::OTAUpdateInfo Class Reference

#include <OTAUpdateInfo.h>

Public Member Functions

 OTAUpdateInfo ()
 
 OTAUpdateInfo (Aws::Utils::Json::JsonView jsonValue)
 
OTAUpdateInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetOtaUpdateId () const
 
bool OtaUpdateIdHasBeenSet () const
 
void SetOtaUpdateId (const Aws::String &value)
 
void SetOtaUpdateId (Aws::String &&value)
 
void SetOtaUpdateId (const char *value)
 
OTAUpdateInfoWithOtaUpdateId (const Aws::String &value)
 
OTAUpdateInfoWithOtaUpdateId (Aws::String &&value)
 
OTAUpdateInfoWithOtaUpdateId (const char *value)
 
const Aws::StringGetOtaUpdateArn () const
 
bool OtaUpdateArnHasBeenSet () const
 
void SetOtaUpdateArn (const Aws::String &value)
 
void SetOtaUpdateArn (Aws::String &&value)
 
void SetOtaUpdateArn (const char *value)
 
OTAUpdateInfoWithOtaUpdateArn (const Aws::String &value)
 
OTAUpdateInfoWithOtaUpdateArn (Aws::String &&value)
 
OTAUpdateInfoWithOtaUpdateArn (const char *value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
OTAUpdateInfoWithCreationDate (const Aws::Utils::DateTime &value)
 
OTAUpdateInfoWithCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastModifiedDate () const
 
bool LastModifiedDateHasBeenSet () const
 
void SetLastModifiedDate (const Aws::Utils::DateTime &value)
 
void SetLastModifiedDate (Aws::Utils::DateTime &&value)
 
OTAUpdateInfoWithLastModifiedDate (const Aws::Utils::DateTime &value)
 
OTAUpdateInfoWithLastModifiedDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
OTAUpdateInfoWithDescription (const Aws::String &value)
 
OTAUpdateInfoWithDescription (Aws::String &&value)
 
OTAUpdateInfoWithDescription (const char *value)
 
const Aws::Vector< Aws::String > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Aws::String > &value)
 
void SetTargets (Aws::Vector< Aws::String > &&value)
 
OTAUpdateInfoWithTargets (const Aws::Vector< Aws::String > &value)
 
OTAUpdateInfoWithTargets (Aws::Vector< Aws::String > &&value)
 
OTAUpdateInfoAddTargets (const Aws::String &value)
 
OTAUpdateInfoAddTargets (Aws::String &&value)
 
OTAUpdateInfoAddTargets (const char *value)
 
const Aws::Vector< Protocol > & GetProtocols () const
 
bool ProtocolsHasBeenSet () const
 
void SetProtocols (const Aws::Vector< Protocol > &value)
 
void SetProtocols (Aws::Vector< Protocol > &&value)
 
OTAUpdateInfoWithProtocols (const Aws::Vector< Protocol > &value)
 
OTAUpdateInfoWithProtocols (Aws::Vector< Protocol > &&value)
 
OTAUpdateInfoAddProtocols (const Protocol &value)
 
OTAUpdateInfoAddProtocols (Protocol &&value)
 
const AwsJobExecutionsRolloutConfigGetAwsJobExecutionsRolloutConfig () const
 
bool AwsJobExecutionsRolloutConfigHasBeenSet () const
 
void SetAwsJobExecutionsRolloutConfig (const AwsJobExecutionsRolloutConfig &value)
 
void SetAwsJobExecutionsRolloutConfig (AwsJobExecutionsRolloutConfig &&value)
 
OTAUpdateInfoWithAwsJobExecutionsRolloutConfig (const AwsJobExecutionsRolloutConfig &value)
 
OTAUpdateInfoWithAwsJobExecutionsRolloutConfig (AwsJobExecutionsRolloutConfig &&value)
 
const AwsJobPresignedUrlConfigGetAwsJobPresignedUrlConfig () const
 
bool AwsJobPresignedUrlConfigHasBeenSet () const
 
void SetAwsJobPresignedUrlConfig (const AwsJobPresignedUrlConfig &value)
 
void SetAwsJobPresignedUrlConfig (AwsJobPresignedUrlConfig &&value)
 
OTAUpdateInfoWithAwsJobPresignedUrlConfig (const AwsJobPresignedUrlConfig &value)
 
OTAUpdateInfoWithAwsJobPresignedUrlConfig (AwsJobPresignedUrlConfig &&value)
 
const TargetSelectionGetTargetSelection () const
 
bool TargetSelectionHasBeenSet () const
 
void SetTargetSelection (const TargetSelection &value)
 
void SetTargetSelection (TargetSelection &&value)
 
OTAUpdateInfoWithTargetSelection (const TargetSelection &value)
 
OTAUpdateInfoWithTargetSelection (TargetSelection &&value)
 
const Aws::Vector< OTAUpdateFile > & GetOtaUpdateFiles () const
 
bool OtaUpdateFilesHasBeenSet () const
 
void SetOtaUpdateFiles (const Aws::Vector< OTAUpdateFile > &value)
 
void SetOtaUpdateFiles (Aws::Vector< OTAUpdateFile > &&value)
 
OTAUpdateInfoWithOtaUpdateFiles (const Aws::Vector< OTAUpdateFile > &value)
 
OTAUpdateInfoWithOtaUpdateFiles (Aws::Vector< OTAUpdateFile > &&value)
 
OTAUpdateInfoAddOtaUpdateFiles (const OTAUpdateFile &value)
 
OTAUpdateInfoAddOtaUpdateFiles (OTAUpdateFile &&value)
 
const OTAUpdateStatusGetOtaUpdateStatus () const
 
bool OtaUpdateStatusHasBeenSet () const
 
void SetOtaUpdateStatus (const OTAUpdateStatus &value)
 
void SetOtaUpdateStatus (OTAUpdateStatus &&value)
 
OTAUpdateInfoWithOtaUpdateStatus (const OTAUpdateStatus &value)
 
OTAUpdateInfoWithOtaUpdateStatus (OTAUpdateStatus &&value)
 
const Aws::StringGetAwsIotJobId () const
 
bool AwsIotJobIdHasBeenSet () const
 
void SetAwsIotJobId (const Aws::String &value)
 
void SetAwsIotJobId (Aws::String &&value)
 
void SetAwsIotJobId (const char *value)
 
OTAUpdateInfoWithAwsIotJobId (const Aws::String &value)
 
OTAUpdateInfoWithAwsIotJobId (Aws::String &&value)
 
OTAUpdateInfoWithAwsIotJobId (const char *value)
 
const Aws::StringGetAwsIotJobArn () const
 
bool AwsIotJobArnHasBeenSet () const
 
void SetAwsIotJobArn (const Aws::String &value)
 
void SetAwsIotJobArn (Aws::String &&value)
 
void SetAwsIotJobArn (const char *value)
 
OTAUpdateInfoWithAwsIotJobArn (const Aws::String &value)
 
OTAUpdateInfoWithAwsIotJobArn (Aws::String &&value)
 
OTAUpdateInfoWithAwsIotJobArn (const char *value)
 
const ErrorInfoGetErrorInfo () const
 
bool ErrorInfoHasBeenSet () const
 
void SetErrorInfo (const ErrorInfo &value)
 
void SetErrorInfo (ErrorInfo &&value)
 
OTAUpdateInfoWithErrorInfo (const ErrorInfo &value)
 
OTAUpdateInfoWithErrorInfo (ErrorInfo &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetAdditionalParameters () const
 
bool AdditionalParametersHasBeenSet () const
 
void SetAdditionalParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetAdditionalParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
OTAUpdateInfoWithAdditionalParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
OTAUpdateInfoWithAdditionalParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
OTAUpdateInfoAddAdditionalParameters (const Aws::String &key, const Aws::String &value)
 
OTAUpdateInfoAddAdditionalParameters (Aws::String &&key, const Aws::String &value)
 
OTAUpdateInfoAddAdditionalParameters (const Aws::String &key, Aws::String &&value)
 
OTAUpdateInfoAddAdditionalParameters (Aws::String &&key, Aws::String &&value)
 
OTAUpdateInfoAddAdditionalParameters (const char *key, Aws::String &&value)
 
OTAUpdateInfoAddAdditionalParameters (Aws::String &&key, const char *value)
 
OTAUpdateInfoAddAdditionalParameters (const char *key, const char *value)
 

Detailed Description

Information about an OTA update.

See Also:

AWS API Reference

Definition at line 41 of file OTAUpdateInfo.h.

Constructor & Destructor Documentation

◆ OTAUpdateInfo() [1/2]

Aws::IoT::Model::OTAUpdateInfo::OTAUpdateInfo ( )

◆ OTAUpdateInfo() [2/2]

Aws::IoT::Model::OTAUpdateInfo::OTAUpdateInfo ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAdditionalParameters() [1/7]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddAdditionalParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A collection of name/value pairs

Definition at line 700 of file OTAUpdateInfo.h.

◆ AddAdditionalParameters() [2/7]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddAdditionalParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

A collection of name/value pairs

Definition at line 690 of file OTAUpdateInfo.h.

◆ AddAdditionalParameters() [3/7]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddAdditionalParameters ( Aws::String &&  key,
const char *  value 
)
inline

A collection of name/value pairs

Definition at line 710 of file OTAUpdateInfo.h.

◆ AddAdditionalParameters() [4/7]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddAdditionalParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

A collection of name/value pairs

Definition at line 695 of file OTAUpdateInfo.h.

◆ AddAdditionalParameters() [5/7]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddAdditionalParameters ( const Aws::String key,
const Aws::String value 
)
inline

A collection of name/value pairs

Definition at line 685 of file OTAUpdateInfo.h.

◆ AddAdditionalParameters() [6/7]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddAdditionalParameters ( const char *  key,
Aws::String &&  value 
)
inline

A collection of name/value pairs

Definition at line 705 of file OTAUpdateInfo.h.

◆ AddAdditionalParameters() [7/7]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddAdditionalParameters ( const char *  key,
const char *  value 
)
inline

A collection of name/value pairs

Definition at line 715 of file OTAUpdateInfo.h.

◆ AdditionalParametersHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::AdditionalParametersHasBeenSet ( ) const
inline

A collection of name/value pairs

Definition at line 660 of file OTAUpdateInfo.h.

◆ AddOtaUpdateFiles() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddOtaUpdateFiles ( const OTAUpdateFile value)
inline

A list of files associated with the OTA update.

Definition at line 500 of file OTAUpdateInfo.h.

◆ AddOtaUpdateFiles() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddOtaUpdateFiles ( OTAUpdateFile &&  value)
inline

A list of files associated with the OTA update.

Definition at line 505 of file OTAUpdateInfo.h.

◆ AddProtocols() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddProtocols ( const Protocol value)
inline

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.

Definition at line 328 of file OTAUpdateInfo.h.

◆ AddProtocols() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddProtocols ( Protocol &&  value)
inline

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.

Definition at line 335 of file OTAUpdateInfo.h.

◆ AddTargets() [1/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddTargets ( Aws::String &&  value)
inline

The targets of the OTA update.

Definition at line 273 of file OTAUpdateInfo.h.

◆ AddTargets() [2/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddTargets ( const Aws::String value)
inline

The targets of the OTA update.

Definition at line 268 of file OTAUpdateInfo.h.

◆ AddTargets() [3/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::AddTargets ( const char *  value)
inline

The targets of the OTA update.

Definition at line 278 of file OTAUpdateInfo.h.

◆ AwsIotJobArnHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::AwsIotJobArnHasBeenSet ( ) const
inline

The IoT job ARN associated with the OTA update.

Definition at line 588 of file OTAUpdateInfo.h.

◆ AwsIotJobIdHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::AwsIotJobIdHasBeenSet ( ) const
inline

The IoT job ID associated with the OTA update.

Definition at line 547 of file OTAUpdateInfo.h.

◆ AwsJobExecutionsRolloutConfigHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::AwsJobExecutionsRolloutConfigHasBeenSet ( ) const
inline

Configuration for the rollout of OTA updates.

Definition at line 346 of file OTAUpdateInfo.h.

◆ AwsJobPresignedUrlConfigHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::AwsJobPresignedUrlConfigHasBeenSet ( ) const
inline

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

Definition at line 379 of file OTAUpdateInfo.h.

◆ CreationDateHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::CreationDateHasBeenSet ( ) const
inline

The date when the OTA update was created.

Definition at line 140 of file OTAUpdateInfo.h.

◆ DescriptionHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::DescriptionHasBeenSet ( ) const
inline

A description of the OTA update.

Definition at line 202 of file OTAUpdateInfo.h.

◆ ErrorInfoHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::ErrorInfoHasBeenSet ( ) const
inline

Error information associated with the OTA update.

Definition at line 629 of file OTAUpdateInfo.h.

◆ GetAdditionalParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::IoT::Model::OTAUpdateInfo::GetAdditionalParameters ( ) const
inline

A collection of name/value pairs

Definition at line 655 of file OTAUpdateInfo.h.

◆ GetAwsIotJobArn()

const Aws::String& Aws::IoT::Model::OTAUpdateInfo::GetAwsIotJobArn ( ) const
inline

The IoT job ARN associated with the OTA update.

Definition at line 583 of file OTAUpdateInfo.h.

◆ GetAwsIotJobId()

const Aws::String& Aws::IoT::Model::OTAUpdateInfo::GetAwsIotJobId ( ) const
inline

The IoT job ID associated with the OTA update.

Definition at line 542 of file OTAUpdateInfo.h.

◆ GetAwsJobExecutionsRolloutConfig()

const AwsJobExecutionsRolloutConfig& Aws::IoT::Model::OTAUpdateInfo::GetAwsJobExecutionsRolloutConfig ( ) const
inline

Configuration for the rollout of OTA updates.

Definition at line 341 of file OTAUpdateInfo.h.

◆ GetAwsJobPresignedUrlConfig()

const AwsJobPresignedUrlConfig& Aws::IoT::Model::OTAUpdateInfo::GetAwsJobPresignedUrlConfig ( ) const
inline

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

Definition at line 373 of file OTAUpdateInfo.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::IoT::Model::OTAUpdateInfo::GetCreationDate ( ) const
inline

The date when the OTA update was created.

Definition at line 135 of file OTAUpdateInfo.h.

◆ GetDescription()

const Aws::String& Aws::IoT::Model::OTAUpdateInfo::GetDescription ( ) const
inline

A description of the OTA update.

Definition at line 197 of file OTAUpdateInfo.h.

◆ GetErrorInfo()

const ErrorInfo& Aws::IoT::Model::OTAUpdateInfo::GetErrorInfo ( ) const
inline

Error information associated with the OTA update.

Definition at line 624 of file OTAUpdateInfo.h.

◆ GetLastModifiedDate()

const Aws::Utils::DateTime& Aws::IoT::Model::OTAUpdateInfo::GetLastModifiedDate ( ) const
inline

The date when the OTA update was last updated.

Definition at line 166 of file OTAUpdateInfo.h.

◆ GetOtaUpdateArn()

const Aws::String& Aws::IoT::Model::OTAUpdateInfo::GetOtaUpdateArn ( ) const
inline

The OTA update ARN.

Definition at line 94 of file OTAUpdateInfo.h.

◆ GetOtaUpdateFiles()

const Aws::Vector<OTAUpdateFile>& Aws::IoT::Model::OTAUpdateInfo::GetOtaUpdateFiles ( ) const
inline

A list of files associated with the OTA update.

Definition at line 470 of file OTAUpdateInfo.h.

◆ GetOtaUpdateId()

const Aws::String& Aws::IoT::Model::OTAUpdateInfo::GetOtaUpdateId ( ) const
inline

The OTA update ID.

Definition at line 53 of file OTAUpdateInfo.h.

◆ GetOtaUpdateStatus()

const OTAUpdateStatus& Aws::IoT::Model::OTAUpdateInfo::GetOtaUpdateStatus ( ) const
inline

The status of the OTA update.

Definition at line 511 of file OTAUpdateInfo.h.

◆ GetProtocols()

const Aws::Vector<Protocol>& Aws::IoT::Model::OTAUpdateInfo::GetProtocols ( ) const
inline

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.

Definition at line 286 of file OTAUpdateInfo.h.

◆ GetTargets()

const Aws::Vector<Aws::String>& Aws::IoT::Model::OTAUpdateInfo::GetTargets ( ) const
inline

The targets of the OTA update.

Definition at line 238 of file OTAUpdateInfo.h.

◆ GetTargetSelection()

const TargetSelection& Aws::IoT::Model::OTAUpdateInfo::GetTargetSelection ( ) const
inline

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.

Definition at line 414 of file OTAUpdateInfo.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::OTAUpdateInfo::Jsonize ( ) const

◆ LastModifiedDateHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::LastModifiedDateHasBeenSet ( ) const
inline

The date when the OTA update was last updated.

Definition at line 171 of file OTAUpdateInfo.h.

◆ operator=()

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OtaUpdateArnHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::OtaUpdateArnHasBeenSet ( ) const
inline

The OTA update ARN.

Definition at line 99 of file OTAUpdateInfo.h.

◆ OtaUpdateFilesHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::OtaUpdateFilesHasBeenSet ( ) const
inline

A list of files associated with the OTA update.

Definition at line 475 of file OTAUpdateInfo.h.

◆ OtaUpdateIdHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::OtaUpdateIdHasBeenSet ( ) const
inline

The OTA update ID.

Definition at line 58 of file OTAUpdateInfo.h.

◆ OtaUpdateStatusHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::OtaUpdateStatusHasBeenSet ( ) const
inline

The status of the OTA update.

Definition at line 516 of file OTAUpdateInfo.h.

◆ ProtocolsHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::ProtocolsHasBeenSet ( ) const
inline

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.

Definition at line 293 of file OTAUpdateInfo.h.

◆ SetAdditionalParameters() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetAdditionalParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A collection of name/value pairs

Definition at line 670 of file OTAUpdateInfo.h.

◆ SetAdditionalParameters() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetAdditionalParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A collection of name/value pairs

Definition at line 665 of file OTAUpdateInfo.h.

◆ SetAwsIotJobArn() [1/3]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsIotJobArn ( Aws::String &&  value)
inline

The IoT job ARN associated with the OTA update.

Definition at line 598 of file OTAUpdateInfo.h.

◆ SetAwsIotJobArn() [2/3]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsIotJobArn ( const Aws::String value)
inline

The IoT job ARN associated with the OTA update.

Definition at line 593 of file OTAUpdateInfo.h.

◆ SetAwsIotJobArn() [3/3]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsIotJobArn ( const char *  value)
inline

The IoT job ARN associated with the OTA update.

Definition at line 603 of file OTAUpdateInfo.h.

◆ SetAwsIotJobId() [1/3]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsIotJobId ( Aws::String &&  value)
inline

The IoT job ID associated with the OTA update.

Definition at line 557 of file OTAUpdateInfo.h.

◆ SetAwsIotJobId() [2/3]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsIotJobId ( const Aws::String value)
inline

The IoT job ID associated with the OTA update.

Definition at line 552 of file OTAUpdateInfo.h.

◆ SetAwsIotJobId() [3/3]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsIotJobId ( const char *  value)
inline

The IoT job ID associated with the OTA update.

Definition at line 562 of file OTAUpdateInfo.h.

◆ SetAwsJobExecutionsRolloutConfig() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsJobExecutionsRolloutConfig ( AwsJobExecutionsRolloutConfig &&  value)
inline

Configuration for the rollout of OTA updates.

Definition at line 356 of file OTAUpdateInfo.h.

◆ SetAwsJobExecutionsRolloutConfig() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsJobExecutionsRolloutConfig ( const AwsJobExecutionsRolloutConfig value)
inline

Configuration for the rollout of OTA updates.

Definition at line 351 of file OTAUpdateInfo.h.

◆ SetAwsJobPresignedUrlConfig() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsJobPresignedUrlConfig ( AwsJobPresignedUrlConfig &&  value)
inline

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

Definition at line 391 of file OTAUpdateInfo.h.

◆ SetAwsJobPresignedUrlConfig() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetAwsJobPresignedUrlConfig ( const AwsJobPresignedUrlConfig value)
inline

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

Definition at line 385 of file OTAUpdateInfo.h.

◆ SetCreationDate() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date when the OTA update was created.

Definition at line 150 of file OTAUpdateInfo.h.

◆ SetCreationDate() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The date when the OTA update was created.

Definition at line 145 of file OTAUpdateInfo.h.

◆ SetDescription() [1/3]

void Aws::IoT::Model::OTAUpdateInfo::SetDescription ( Aws::String &&  value)
inline

A description of the OTA update.

Definition at line 212 of file OTAUpdateInfo.h.

◆ SetDescription() [2/3]

void Aws::IoT::Model::OTAUpdateInfo::SetDescription ( const Aws::String value)
inline

A description of the OTA update.

Definition at line 207 of file OTAUpdateInfo.h.

◆ SetDescription() [3/3]

void Aws::IoT::Model::OTAUpdateInfo::SetDescription ( const char *  value)
inline

A description of the OTA update.

Definition at line 217 of file OTAUpdateInfo.h.

◆ SetErrorInfo() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetErrorInfo ( const ErrorInfo value)
inline

Error information associated with the OTA update.

Definition at line 634 of file OTAUpdateInfo.h.

◆ SetErrorInfo() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetErrorInfo ( ErrorInfo &&  value)
inline

Error information associated with the OTA update.

Definition at line 639 of file OTAUpdateInfo.h.

◆ SetLastModifiedDate() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetLastModifiedDate ( Aws::Utils::DateTime &&  value)
inline

The date when the OTA update was last updated.

Definition at line 181 of file OTAUpdateInfo.h.

◆ SetLastModifiedDate() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetLastModifiedDate ( const Aws::Utils::DateTime value)
inline

The date when the OTA update was last updated.

Definition at line 176 of file OTAUpdateInfo.h.

◆ SetOtaUpdateArn() [1/3]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateArn ( Aws::String &&  value)
inline

The OTA update ARN.

Definition at line 109 of file OTAUpdateInfo.h.

◆ SetOtaUpdateArn() [2/3]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateArn ( const Aws::String value)
inline

The OTA update ARN.

Definition at line 104 of file OTAUpdateInfo.h.

◆ SetOtaUpdateArn() [3/3]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateArn ( const char *  value)
inline

The OTA update ARN.

Definition at line 114 of file OTAUpdateInfo.h.

◆ SetOtaUpdateFiles() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateFiles ( Aws::Vector< OTAUpdateFile > &&  value)
inline

A list of files associated with the OTA update.

Definition at line 485 of file OTAUpdateInfo.h.

◆ SetOtaUpdateFiles() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateFiles ( const Aws::Vector< OTAUpdateFile > &  value)
inline

A list of files associated with the OTA update.

Definition at line 480 of file OTAUpdateInfo.h.

◆ SetOtaUpdateId() [1/3]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateId ( Aws::String &&  value)
inline

The OTA update ID.

Definition at line 68 of file OTAUpdateInfo.h.

◆ SetOtaUpdateId() [2/3]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateId ( const Aws::String value)
inline

The OTA update ID.

Definition at line 63 of file OTAUpdateInfo.h.

◆ SetOtaUpdateId() [3/3]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateId ( const char *  value)
inline

The OTA update ID.

Definition at line 73 of file OTAUpdateInfo.h.

◆ SetOtaUpdateStatus() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateStatus ( const OTAUpdateStatus value)
inline

The status of the OTA update.

Definition at line 521 of file OTAUpdateInfo.h.

◆ SetOtaUpdateStatus() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetOtaUpdateStatus ( OTAUpdateStatus &&  value)
inline

The status of the OTA update.

Definition at line 526 of file OTAUpdateInfo.h.

◆ SetProtocols() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetProtocols ( Aws::Vector< Protocol > &&  value)
inline

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.

Definition at line 307 of file OTAUpdateInfo.h.

◆ SetProtocols() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetProtocols ( const Aws::Vector< Protocol > &  value)
inline

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.

Definition at line 300 of file OTAUpdateInfo.h.

◆ SetTargets() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetTargets ( Aws::Vector< Aws::String > &&  value)
inline

The targets of the OTA update.

Definition at line 253 of file OTAUpdateInfo.h.

◆ SetTargets() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetTargets ( const Aws::Vector< Aws::String > &  value)
inline

The targets of the OTA update.

Definition at line 248 of file OTAUpdateInfo.h.

◆ SetTargetSelection() [1/2]

void Aws::IoT::Model::OTAUpdateInfo::SetTargetSelection ( const TargetSelection value)
inline

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.

Definition at line 434 of file OTAUpdateInfo.h.

◆ SetTargetSelection() [2/2]

void Aws::IoT::Model::OTAUpdateInfo::SetTargetSelection ( TargetSelection &&  value)
inline

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.

Definition at line 444 of file OTAUpdateInfo.h.

◆ TargetSelectionHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::TargetSelectionHasBeenSet ( ) const
inline

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.

Definition at line 424 of file OTAUpdateInfo.h.

◆ TargetsHasBeenSet()

bool Aws::IoT::Model::OTAUpdateInfo::TargetsHasBeenSet ( ) const
inline

The targets of the OTA update.

Definition at line 243 of file OTAUpdateInfo.h.

◆ WithAdditionalParameters() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAdditionalParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A collection of name/value pairs

Definition at line 680 of file OTAUpdateInfo.h.

◆ WithAdditionalParameters() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAdditionalParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A collection of name/value pairs

Definition at line 675 of file OTAUpdateInfo.h.

◆ WithAwsIotJobArn() [1/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsIotJobArn ( Aws::String &&  value)
inline

The IoT job ARN associated with the OTA update.

Definition at line 613 of file OTAUpdateInfo.h.

◆ WithAwsIotJobArn() [2/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsIotJobArn ( const Aws::String value)
inline

The IoT job ARN associated with the OTA update.

Definition at line 608 of file OTAUpdateInfo.h.

◆ WithAwsIotJobArn() [3/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsIotJobArn ( const char *  value)
inline

The IoT job ARN associated with the OTA update.

Definition at line 618 of file OTAUpdateInfo.h.

◆ WithAwsIotJobId() [1/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsIotJobId ( Aws::String &&  value)
inline

The IoT job ID associated with the OTA update.

Definition at line 572 of file OTAUpdateInfo.h.

◆ WithAwsIotJobId() [2/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsIotJobId ( const Aws::String value)
inline

The IoT job ID associated with the OTA update.

Definition at line 567 of file OTAUpdateInfo.h.

◆ WithAwsIotJobId() [3/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsIotJobId ( const char *  value)
inline

The IoT job ID associated with the OTA update.

Definition at line 577 of file OTAUpdateInfo.h.

◆ WithAwsJobExecutionsRolloutConfig() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsJobExecutionsRolloutConfig ( AwsJobExecutionsRolloutConfig &&  value)
inline

Configuration for the rollout of OTA updates.

Definition at line 366 of file OTAUpdateInfo.h.

◆ WithAwsJobExecutionsRolloutConfig() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsJobExecutionsRolloutConfig ( const AwsJobExecutionsRolloutConfig value)
inline

Configuration for the rollout of OTA updates.

Definition at line 361 of file OTAUpdateInfo.h.

◆ WithAwsJobPresignedUrlConfig() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsJobPresignedUrlConfig ( AwsJobPresignedUrlConfig &&  value)
inline

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

Definition at line 403 of file OTAUpdateInfo.h.

◆ WithAwsJobPresignedUrlConfig() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithAwsJobPresignedUrlConfig ( const AwsJobPresignedUrlConfig value)
inline

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

Definition at line 397 of file OTAUpdateInfo.h.

◆ WithCreationDate() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date when the OTA update was created.

Definition at line 160 of file OTAUpdateInfo.h.

◆ WithCreationDate() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The date when the OTA update was created.

Definition at line 155 of file OTAUpdateInfo.h.

◆ WithDescription() [1/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithDescription ( Aws::String &&  value)
inline

A description of the OTA update.

Definition at line 227 of file OTAUpdateInfo.h.

◆ WithDescription() [2/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithDescription ( const Aws::String value)
inline

A description of the OTA update.

Definition at line 222 of file OTAUpdateInfo.h.

◆ WithDescription() [3/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithDescription ( const char *  value)
inline

A description of the OTA update.

Definition at line 232 of file OTAUpdateInfo.h.

◆ WithErrorInfo() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithErrorInfo ( const ErrorInfo value)
inline

Error information associated with the OTA update.

Definition at line 644 of file OTAUpdateInfo.h.

◆ WithErrorInfo() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithErrorInfo ( ErrorInfo &&  value)
inline

Error information associated with the OTA update.

Definition at line 649 of file OTAUpdateInfo.h.

◆ WithLastModifiedDate() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithLastModifiedDate ( Aws::Utils::DateTime &&  value)
inline

The date when the OTA update was last updated.

Definition at line 191 of file OTAUpdateInfo.h.

◆ WithLastModifiedDate() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithLastModifiedDate ( const Aws::Utils::DateTime value)
inline

The date when the OTA update was last updated.

Definition at line 186 of file OTAUpdateInfo.h.

◆ WithOtaUpdateArn() [1/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateArn ( Aws::String &&  value)
inline

The OTA update ARN.

Definition at line 124 of file OTAUpdateInfo.h.

◆ WithOtaUpdateArn() [2/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateArn ( const Aws::String value)
inline

The OTA update ARN.

Definition at line 119 of file OTAUpdateInfo.h.

◆ WithOtaUpdateArn() [3/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateArn ( const char *  value)
inline

The OTA update ARN.

Definition at line 129 of file OTAUpdateInfo.h.

◆ WithOtaUpdateFiles() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateFiles ( Aws::Vector< OTAUpdateFile > &&  value)
inline

A list of files associated with the OTA update.

Definition at line 495 of file OTAUpdateInfo.h.

◆ WithOtaUpdateFiles() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateFiles ( const Aws::Vector< OTAUpdateFile > &  value)
inline

A list of files associated with the OTA update.

Definition at line 490 of file OTAUpdateInfo.h.

◆ WithOtaUpdateId() [1/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateId ( Aws::String &&  value)
inline

The OTA update ID.

Definition at line 83 of file OTAUpdateInfo.h.

◆ WithOtaUpdateId() [2/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateId ( const Aws::String value)
inline

The OTA update ID.

Definition at line 78 of file OTAUpdateInfo.h.

◆ WithOtaUpdateId() [3/3]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateId ( const char *  value)
inline

The OTA update ID.

Definition at line 88 of file OTAUpdateInfo.h.

◆ WithOtaUpdateStatus() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateStatus ( const OTAUpdateStatus value)
inline

The status of the OTA update.

Definition at line 531 of file OTAUpdateInfo.h.

◆ WithOtaUpdateStatus() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithOtaUpdateStatus ( OTAUpdateStatus &&  value)
inline

The status of the OTA update.

Definition at line 536 of file OTAUpdateInfo.h.

◆ WithProtocols() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithProtocols ( Aws::Vector< Protocol > &&  value)
inline

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.

Definition at line 321 of file OTAUpdateInfo.h.

◆ WithProtocols() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithProtocols ( const Aws::Vector< Protocol > &  value)
inline

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.

Definition at line 314 of file OTAUpdateInfo.h.

◆ WithTargets() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithTargets ( Aws::Vector< Aws::String > &&  value)
inline

The targets of the OTA update.

Definition at line 263 of file OTAUpdateInfo.h.

◆ WithTargets() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithTargets ( const Aws::Vector< Aws::String > &  value)
inline

The targets of the OTA update.

Definition at line 258 of file OTAUpdateInfo.h.

◆ WithTargetSelection() [1/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithTargetSelection ( const TargetSelection value)
inline

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.

Definition at line 454 of file OTAUpdateInfo.h.

◆ WithTargetSelection() [2/2]

OTAUpdateInfo& Aws::IoT::Model::OTAUpdateInfo::WithTargetSelection ( TargetSelection &&  value)
inline

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.

Definition at line 464 of file OTAUpdateInfo.h.


The documentation for this class was generated from the following file: