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

#include <CreateOTAUpdateRequest.h>

+ Inheritance diagram for Aws::IoT::Model::CreateOTAUpdateRequest:

Public Member Functions

 CreateOTAUpdateRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetOtaUpdateId () const
 
bool OtaUpdateIdHasBeenSet () const
 
void SetOtaUpdateId (const Aws::String &value)
 
void SetOtaUpdateId (Aws::String &&value)
 
void SetOtaUpdateId (const char *value)
 
CreateOTAUpdateRequestWithOtaUpdateId (const Aws::String &value)
 
CreateOTAUpdateRequestWithOtaUpdateId (Aws::String &&value)
 
CreateOTAUpdateRequestWithOtaUpdateId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateOTAUpdateRequestWithDescription (const Aws::String &value)
 
CreateOTAUpdateRequestWithDescription (Aws::String &&value)
 
CreateOTAUpdateRequestWithDescription (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)
 
CreateOTAUpdateRequestWithTargets (const Aws::Vector< Aws::String > &value)
 
CreateOTAUpdateRequestWithTargets (Aws::Vector< Aws::String > &&value)
 
CreateOTAUpdateRequestAddTargets (const Aws::String &value)
 
CreateOTAUpdateRequestAddTargets (Aws::String &&value)
 
CreateOTAUpdateRequestAddTargets (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)
 
CreateOTAUpdateRequestWithProtocols (const Aws::Vector< Protocol > &value)
 
CreateOTAUpdateRequestWithProtocols (Aws::Vector< Protocol > &&value)
 
CreateOTAUpdateRequestAddProtocols (const Protocol &value)
 
CreateOTAUpdateRequestAddProtocols (Protocol &&value)
 
const TargetSelectionGetTargetSelection () const
 
bool TargetSelectionHasBeenSet () const
 
void SetTargetSelection (const TargetSelection &value)
 
void SetTargetSelection (TargetSelection &&value)
 
CreateOTAUpdateRequestWithTargetSelection (const TargetSelection &value)
 
CreateOTAUpdateRequestWithTargetSelection (TargetSelection &&value)
 
const AwsJobExecutionsRolloutConfigGetAwsJobExecutionsRolloutConfig () const
 
bool AwsJobExecutionsRolloutConfigHasBeenSet () const
 
void SetAwsJobExecutionsRolloutConfig (const AwsJobExecutionsRolloutConfig &value)
 
void SetAwsJobExecutionsRolloutConfig (AwsJobExecutionsRolloutConfig &&value)
 
CreateOTAUpdateRequestWithAwsJobExecutionsRolloutConfig (const AwsJobExecutionsRolloutConfig &value)
 
CreateOTAUpdateRequestWithAwsJobExecutionsRolloutConfig (AwsJobExecutionsRolloutConfig &&value)
 
const AwsJobPresignedUrlConfigGetAwsJobPresignedUrlConfig () const
 
bool AwsJobPresignedUrlConfigHasBeenSet () const
 
void SetAwsJobPresignedUrlConfig (const AwsJobPresignedUrlConfig &value)
 
void SetAwsJobPresignedUrlConfig (AwsJobPresignedUrlConfig &&value)
 
CreateOTAUpdateRequestWithAwsJobPresignedUrlConfig (const AwsJobPresignedUrlConfig &value)
 
CreateOTAUpdateRequestWithAwsJobPresignedUrlConfig (AwsJobPresignedUrlConfig &&value)
 
const AwsJobAbortConfigGetAwsJobAbortConfig () const
 
bool AwsJobAbortConfigHasBeenSet () const
 
void SetAwsJobAbortConfig (const AwsJobAbortConfig &value)
 
void SetAwsJobAbortConfig (AwsJobAbortConfig &&value)
 
CreateOTAUpdateRequestWithAwsJobAbortConfig (const AwsJobAbortConfig &value)
 
CreateOTAUpdateRequestWithAwsJobAbortConfig (AwsJobAbortConfig &&value)
 
const AwsJobTimeoutConfigGetAwsJobTimeoutConfig () const
 
bool AwsJobTimeoutConfigHasBeenSet () const
 
void SetAwsJobTimeoutConfig (const AwsJobTimeoutConfig &value)
 
void SetAwsJobTimeoutConfig (AwsJobTimeoutConfig &&value)
 
CreateOTAUpdateRequestWithAwsJobTimeoutConfig (const AwsJobTimeoutConfig &value)
 
CreateOTAUpdateRequestWithAwsJobTimeoutConfig (AwsJobTimeoutConfig &&value)
 
const Aws::Vector< OTAUpdateFile > & GetFiles () const
 
bool FilesHasBeenSet () const
 
void SetFiles (const Aws::Vector< OTAUpdateFile > &value)
 
void SetFiles (Aws::Vector< OTAUpdateFile > &&value)
 
CreateOTAUpdateRequestWithFiles (const Aws::Vector< OTAUpdateFile > &value)
 
CreateOTAUpdateRequestWithFiles (Aws::Vector< OTAUpdateFile > &&value)
 
CreateOTAUpdateRequestAddFiles (const OTAUpdateFile &value)
 
CreateOTAUpdateRequestAddFiles (OTAUpdateFile &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
CreateOTAUpdateRequestWithRoleArn (const Aws::String &value)
 
CreateOTAUpdateRequestWithRoleArn (Aws::String &&value)
 
CreateOTAUpdateRequestWithRoleArn (const char *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)
 
CreateOTAUpdateRequestWithAdditionalParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateOTAUpdateRequestWithAdditionalParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateOTAUpdateRequestAddAdditionalParameters (const Aws::String &key, const Aws::String &value)
 
CreateOTAUpdateRequestAddAdditionalParameters (Aws::String &&key, const Aws::String &value)
 
CreateOTAUpdateRequestAddAdditionalParameters (const Aws::String &key, Aws::String &&value)
 
CreateOTAUpdateRequestAddAdditionalParameters (Aws::String &&key, Aws::String &&value)
 
CreateOTAUpdateRequestAddAdditionalParameters (const char *key, Aws::String &&value)
 
CreateOTAUpdateRequestAddAdditionalParameters (Aws::String &&key, const char *value)
 
CreateOTAUpdateRequestAddAdditionalParameters (const char *key, const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateOTAUpdateRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateOTAUpdateRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateOTAUpdateRequestAddTags (const Tag &value)
 
CreateOTAUpdateRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::IoT::IoTRequest
virtual ~IoTRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::IoT::IoTRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 31 of file CreateOTAUpdateRequest.h.

Constructor & Destructor Documentation

◆ CreateOTAUpdateRequest()

Aws::IoT::Model::CreateOTAUpdateRequest::CreateOTAUpdateRequest ( )

Member Function Documentation

◆ AddAdditionalParameters() [1/7]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 585 of file CreateOTAUpdateRequest.h.

◆ AddAdditionalParameters() [2/7]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 575 of file CreateOTAUpdateRequest.h.

◆ AddAdditionalParameters() [3/7]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 595 of file CreateOTAUpdateRequest.h.

◆ AddAdditionalParameters() [4/7]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 580 of file CreateOTAUpdateRequest.h.

◆ AddAdditionalParameters() [5/7]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 570 of file CreateOTAUpdateRequest.h.

◆ AddAdditionalParameters() [6/7]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 590 of file CreateOTAUpdateRequest.h.

◆ AddAdditionalParameters() [7/7]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 600 of file CreateOTAUpdateRequest.h.

◆ AddFiles() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::AddFiles ( const OTAUpdateFile value)
inline

The files to be streamed by the OTA update.

Definition at line 472 of file CreateOTAUpdateRequest.h.

◆ AddFiles() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::AddFiles ( OTAUpdateFile &&  value)
inline

The files to be streamed by the OTA update.

Definition at line 477 of file CreateOTAUpdateRequest.h.

◆ AdditionalParametersHasBeenSet()

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 545 of file CreateOTAUpdateRequest.h.

◆ AddProtocols() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::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 220 of file CreateOTAUpdateRequest.h.

◆ AddProtocols() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::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 227 of file CreateOTAUpdateRequest.h.

◆ AddTags() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::AddTags ( const Tag value)
inline

Metadata which can be used to manage updates.

Definition at line 636 of file CreateOTAUpdateRequest.h.

◆ AddTags() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::AddTags ( Tag &&  value)
inline

Metadata which can be used to manage updates.

Definition at line 641 of file CreateOTAUpdateRequest.h.

◆ AddTargets() [1/3]

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

The devices targeted to receive OTA updates.

Definition at line 165 of file CreateOTAUpdateRequest.h.

◆ AddTargets() [2/3]

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

The devices targeted to receive OTA updates.

Definition at line 160 of file CreateOTAUpdateRequest.h.

◆ AddTargets() [3/3]

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

The devices targeted to receive OTA updates.

Definition at line 170 of file CreateOTAUpdateRequest.h.

◆ AwsJobAbortConfigHasBeenSet()

bool Aws::IoT::Model::CreateOTAUpdateRequest::AwsJobAbortConfigHasBeenSet ( ) const
inline

The criteria that determine when and how a job abort takes place.

Definition at line 361 of file CreateOTAUpdateRequest.h.

◆ AwsJobExecutionsRolloutConfigHasBeenSet()

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

Configuration for the rollout of OTA updates.

Definition at line 299 of file CreateOTAUpdateRequest.h.

◆ AwsJobPresignedUrlConfigHasBeenSet()

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

Configuration information for pre-signed URLs.

Definition at line 330 of file CreateOTAUpdateRequest.h.

◆ AwsJobTimeoutConfigHasBeenSet()

bool Aws::IoT::Model::CreateOTAUpdateRequest::AwsJobTimeoutConfigHasBeenSet ( ) const
inline

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.

Definition at line 400 of file CreateOTAUpdateRequest.h.

◆ DescriptionHasBeenSet()

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

The description of the OTA update.

Definition at line 94 of file CreateOTAUpdateRequest.h.

◆ FilesHasBeenSet()

bool Aws::IoT::Model::CreateOTAUpdateRequest::FilesHasBeenSet ( ) const
inline

The files to be streamed by the OTA update.

Definition at line 447 of file CreateOTAUpdateRequest.h.

◆ GetAdditionalParameters()

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 540 of file CreateOTAUpdateRequest.h.

◆ GetAwsJobAbortConfig()

const AwsJobAbortConfig& Aws::IoT::Model::CreateOTAUpdateRequest::GetAwsJobAbortConfig ( ) const
inline

The criteria that determine when and how a job abort takes place.

Definition at line 356 of file CreateOTAUpdateRequest.h.

◆ GetAwsJobExecutionsRolloutConfig()

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

Configuration for the rollout of OTA updates.

Definition at line 294 of file CreateOTAUpdateRequest.h.

◆ GetAwsJobPresignedUrlConfig()

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

Configuration information for pre-signed URLs.

Definition at line 325 of file CreateOTAUpdateRequest.h.

◆ GetAwsJobTimeoutConfig()

const AwsJobTimeoutConfig& Aws::IoT::Model::CreateOTAUpdateRequest::GetAwsJobTimeoutConfig ( ) const
inline

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.

Definition at line 391 of file CreateOTAUpdateRequest.h.

◆ GetDescription()

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

The description of the OTA update.

Definition at line 89 of file CreateOTAUpdateRequest.h.

◆ GetFiles()

const Aws::Vector<OTAUpdateFile>& Aws::IoT::Model::CreateOTAUpdateRequest::GetFiles ( ) const
inline

The files to be streamed by the OTA update.

Definition at line 442 of file CreateOTAUpdateRequest.h.

◆ GetOtaUpdateId()

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

The ID of the OTA update to be created.

Definition at line 48 of file CreateOTAUpdateRequest.h.

◆ GetProtocols()

const Aws::Vector<Protocol>& Aws::IoT::Model::CreateOTAUpdateRequest::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 178 of file CreateOTAUpdateRequest.h.

◆ GetRoleArn()

const Aws::String& Aws::IoT::Model::CreateOTAUpdateRequest::GetRoleArn ( ) const
inline

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.

Definition at line 485 of file CreateOTAUpdateRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoT::Model::CreateOTAUpdateRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file CreateOTAUpdateRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::IoT::Model::CreateOTAUpdateRequest::GetTags ( ) const
inline

Metadata which can be used to manage updates.

Definition at line 606 of file CreateOTAUpdateRequest.h.

◆ GetTargets()

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

The devices targeted to receive OTA updates.

Definition at line 130 of file CreateOTAUpdateRequest.h.

◆ GetTargetSelection()

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

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.

Definition at line 238 of file CreateOTAUpdateRequest.h.

◆ OtaUpdateIdHasBeenSet()

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

The ID of the OTA update to be created.

Definition at line 53 of file CreateOTAUpdateRequest.h.

◆ ProtocolsHasBeenSet()

bool Aws::IoT::Model::CreateOTAUpdateRequest::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 185 of file CreateOTAUpdateRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::IoT::Model::CreateOTAUpdateRequest::RoleArnHasBeenSet ( ) const
inline

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.

Definition at line 492 of file CreateOTAUpdateRequest.h.

◆ SerializePayload()

Aws::String Aws::IoT::Model::CreateOTAUpdateRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAdditionalParameters() [1/2]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 555 of file CreateOTAUpdateRequest.h.

◆ SetAdditionalParameters() [2/2]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 550 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobAbortConfig() [1/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetAwsJobAbortConfig ( AwsJobAbortConfig &&  value)
inline

The criteria that determine when and how a job abort takes place.

Definition at line 371 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobAbortConfig() [2/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetAwsJobAbortConfig ( const AwsJobAbortConfig value)
inline

The criteria that determine when and how a job abort takes place.

Definition at line 366 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobExecutionsRolloutConfig() [1/2]

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

Configuration for the rollout of OTA updates.

Definition at line 309 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobExecutionsRolloutConfig() [2/2]

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

Configuration for the rollout of OTA updates.

Definition at line 304 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobPresignedUrlConfig() [1/2]

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

Configuration information for pre-signed URLs.

Definition at line 340 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobPresignedUrlConfig() [2/2]

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

Configuration information for pre-signed URLs.

Definition at line 335 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobTimeoutConfig() [1/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetAwsJobTimeoutConfig ( AwsJobTimeoutConfig &&  value)
inline

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.

Definition at line 418 of file CreateOTAUpdateRequest.h.

◆ SetAwsJobTimeoutConfig() [2/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetAwsJobTimeoutConfig ( const AwsJobTimeoutConfig value)
inline

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.

Definition at line 409 of file CreateOTAUpdateRequest.h.

◆ SetDescription() [1/3]

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

The description of the OTA update.

Definition at line 104 of file CreateOTAUpdateRequest.h.

◆ SetDescription() [2/3]

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

The description of the OTA update.

Definition at line 99 of file CreateOTAUpdateRequest.h.

◆ SetDescription() [3/3]

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

The description of the OTA update.

Definition at line 109 of file CreateOTAUpdateRequest.h.

◆ SetFiles() [1/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetFiles ( Aws::Vector< OTAUpdateFile > &&  value)
inline

The files to be streamed by the OTA update.

Definition at line 457 of file CreateOTAUpdateRequest.h.

◆ SetFiles() [2/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetFiles ( const Aws::Vector< OTAUpdateFile > &  value)
inline

The files to be streamed by the OTA update.

Definition at line 452 of file CreateOTAUpdateRequest.h.

◆ SetOtaUpdateId() [1/3]

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

The ID of the OTA update to be created.

Definition at line 63 of file CreateOTAUpdateRequest.h.

◆ SetOtaUpdateId() [2/3]

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

The ID of the OTA update to be created.

Definition at line 58 of file CreateOTAUpdateRequest.h.

◆ SetOtaUpdateId() [3/3]

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

The ID of the OTA update to be created.

Definition at line 68 of file CreateOTAUpdateRequest.h.

◆ SetProtocols() [1/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::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 199 of file CreateOTAUpdateRequest.h.

◆ SetProtocols() [2/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::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 192 of file CreateOTAUpdateRequest.h.

◆ SetRoleArn() [1/3]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 506 of file CreateOTAUpdateRequest.h.

◆ SetRoleArn() [2/3]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetRoleArn ( const Aws::String value)
inline

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.

Definition at line 499 of file CreateOTAUpdateRequest.h.

◆ SetRoleArn() [3/3]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetRoleArn ( const char *  value)
inline

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.

Definition at line 513 of file CreateOTAUpdateRequest.h.

◆ SetTags() [1/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Metadata which can be used to manage updates.

Definition at line 621 of file CreateOTAUpdateRequest.h.

◆ SetTags() [2/2]

void Aws::IoT::Model::CreateOTAUpdateRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Metadata which can be used to manage updates.

Definition at line 616 of file CreateOTAUpdateRequest.h.

◆ SetTargets() [1/2]

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

The devices targeted to receive OTA updates.

Definition at line 145 of file CreateOTAUpdateRequest.h.

◆ SetTargets() [2/2]

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

The devices targeted to receive OTA updates.

Definition at line 140 of file CreateOTAUpdateRequest.h.

◆ SetTargetSelection() [1/2]

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

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.

Definition at line 258 of file CreateOTAUpdateRequest.h.

◆ SetTargetSelection() [2/2]

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

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.

Definition at line 268 of file CreateOTAUpdateRequest.h.

◆ TagsHasBeenSet()

bool Aws::IoT::Model::CreateOTAUpdateRequest::TagsHasBeenSet ( ) const
inline

Metadata which can be used to manage updates.

Definition at line 611 of file CreateOTAUpdateRequest.h.

◆ TargetSelectionHasBeenSet()

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

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.

Definition at line 248 of file CreateOTAUpdateRequest.h.

◆ TargetsHasBeenSet()

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

The devices targeted to receive OTA updates.

Definition at line 135 of file CreateOTAUpdateRequest.h.

◆ WithAdditionalParameters() [1/2]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 565 of file CreateOTAUpdateRequest.h.

◆ WithAdditionalParameters() [2/2]

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

A list of additional OTA update parameters which are name-value pairs.

Definition at line 560 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobAbortConfig() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithAwsJobAbortConfig ( AwsJobAbortConfig &&  value)
inline

The criteria that determine when and how a job abort takes place.

Definition at line 381 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobAbortConfig() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithAwsJobAbortConfig ( const AwsJobAbortConfig value)
inline

The criteria that determine when and how a job abort takes place.

Definition at line 376 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobExecutionsRolloutConfig() [1/2]

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

Configuration for the rollout of OTA updates.

Definition at line 319 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobExecutionsRolloutConfig() [2/2]

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

Configuration for the rollout of OTA updates.

Definition at line 314 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobPresignedUrlConfig() [1/2]

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

Configuration information for pre-signed URLs.

Definition at line 350 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobPresignedUrlConfig() [2/2]

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

Configuration information for pre-signed URLs.

Definition at line 345 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobTimeoutConfig() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithAwsJobTimeoutConfig ( AwsJobTimeoutConfig &&  value)
inline

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.

Definition at line 436 of file CreateOTAUpdateRequest.h.

◆ WithAwsJobTimeoutConfig() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithAwsJobTimeoutConfig ( const AwsJobTimeoutConfig value)
inline

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.

Definition at line 427 of file CreateOTAUpdateRequest.h.

◆ WithDescription() [1/3]

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

The description of the OTA update.

Definition at line 119 of file CreateOTAUpdateRequest.h.

◆ WithDescription() [2/3]

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

The description of the OTA update.

Definition at line 114 of file CreateOTAUpdateRequest.h.

◆ WithDescription() [3/3]

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

The description of the OTA update.

Definition at line 124 of file CreateOTAUpdateRequest.h.

◆ WithFiles() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithFiles ( Aws::Vector< OTAUpdateFile > &&  value)
inline

The files to be streamed by the OTA update.

Definition at line 467 of file CreateOTAUpdateRequest.h.

◆ WithFiles() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithFiles ( const Aws::Vector< OTAUpdateFile > &  value)
inline

The files to be streamed by the OTA update.

Definition at line 462 of file CreateOTAUpdateRequest.h.

◆ WithOtaUpdateId() [1/3]

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

The ID of the OTA update to be created.

Definition at line 78 of file CreateOTAUpdateRequest.h.

◆ WithOtaUpdateId() [2/3]

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

The ID of the OTA update to be created.

Definition at line 73 of file CreateOTAUpdateRequest.h.

◆ WithOtaUpdateId() [3/3]

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

The ID of the OTA update to be created.

Definition at line 83 of file CreateOTAUpdateRequest.h.

◆ WithProtocols() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::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 213 of file CreateOTAUpdateRequest.h.

◆ WithProtocols() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::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 206 of file CreateOTAUpdateRequest.h.

◆ WithRoleArn() [1/3]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 527 of file CreateOTAUpdateRequest.h.

◆ WithRoleArn() [2/3]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithRoleArn ( const Aws::String value)
inline

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.

Definition at line 520 of file CreateOTAUpdateRequest.h.

◆ WithRoleArn() [3/3]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithRoleArn ( const char *  value)
inline

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.

Definition at line 534 of file CreateOTAUpdateRequest.h.

◆ WithTags() [1/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Metadata which can be used to manage updates.

Definition at line 631 of file CreateOTAUpdateRequest.h.

◆ WithTags() [2/2]

CreateOTAUpdateRequest& Aws::IoT::Model::CreateOTAUpdateRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Metadata which can be used to manage updates.

Definition at line 626 of file CreateOTAUpdateRequest.h.

◆ WithTargets() [1/2]

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

The devices targeted to receive OTA updates.

Definition at line 155 of file CreateOTAUpdateRequest.h.

◆ WithTargets() [2/2]

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

The devices targeted to receive OTA updates.

Definition at line 150 of file CreateOTAUpdateRequest.h.

◆ WithTargetSelection() [1/2]

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

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.

Definition at line 278 of file CreateOTAUpdateRequest.h.

◆ WithTargetSelection() [2/2]

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

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.

Definition at line 288 of file CreateOTAUpdateRequest.h.


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