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

#include <UpdateJobRequest.h>

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

Public Member Functions

 UpdateJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
UpdateJobRequestWithJobId (const Aws::String &value)
 
UpdateJobRequestWithJobId (Aws::String &&value)
 
UpdateJobRequestWithJobId (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)
 
UpdateJobRequestWithDescription (const Aws::String &value)
 
UpdateJobRequestWithDescription (Aws::String &&value)
 
UpdateJobRequestWithDescription (const char *value)
 
const PresignedUrlConfigGetPresignedUrlConfig () const
 
bool PresignedUrlConfigHasBeenSet () const
 
void SetPresignedUrlConfig (const PresignedUrlConfig &value)
 
void SetPresignedUrlConfig (PresignedUrlConfig &&value)
 
UpdateJobRequestWithPresignedUrlConfig (const PresignedUrlConfig &value)
 
UpdateJobRequestWithPresignedUrlConfig (PresignedUrlConfig &&value)
 
const JobExecutionsRolloutConfigGetJobExecutionsRolloutConfig () const
 
bool JobExecutionsRolloutConfigHasBeenSet () const
 
void SetJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
void SetJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
UpdateJobRequestWithJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
UpdateJobRequestWithJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
const AbortConfigGetAbortConfig () const
 
bool AbortConfigHasBeenSet () const
 
void SetAbortConfig (const AbortConfig &value)
 
void SetAbortConfig (AbortConfig &&value)
 
UpdateJobRequestWithAbortConfig (const AbortConfig &value)
 
UpdateJobRequestWithAbortConfig (AbortConfig &&value)
 
const TimeoutConfigGetTimeoutConfig () const
 
bool TimeoutConfigHasBeenSet () const
 
void SetTimeoutConfig (const TimeoutConfig &value)
 
void SetTimeoutConfig (TimeoutConfig &&value)
 
UpdateJobRequestWithTimeoutConfig (const TimeoutConfig &value)
 
UpdateJobRequestWithTimeoutConfig (TimeoutConfig &&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 25 of file UpdateJobRequest.h.

Constructor & Destructor Documentation

◆ UpdateJobRequest()

Aws::IoT::Model::UpdateJobRequest::UpdateJobRequest ( )

Member Function Documentation

◆ AbortConfigHasBeenSet()

bool Aws::IoT::Model::UpdateJobRequest::AbortConfigHasBeenSet ( ) const
inline

Allows you to create criteria to abort a job.

Definition at line 191 of file UpdateJobRequest.h.

◆ DescriptionHasBeenSet()

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

A short text description of the job.

Definition at line 88 of file UpdateJobRequest.h.

◆ GetAbortConfig()

const AbortConfig& Aws::IoT::Model::UpdateJobRequest::GetAbortConfig ( ) const
inline

Allows you to create criteria to abort a job.

Definition at line 186 of file UpdateJobRequest.h.

◆ GetDescription()

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

A short text description of the job.

Definition at line 83 of file UpdateJobRequest.h.

◆ GetJobExecutionsRolloutConfig()

const JobExecutionsRolloutConfig& Aws::IoT::Model::UpdateJobRequest::GetJobExecutionsRolloutConfig ( ) const
inline

Allows you to create a staged rollout of the job.

Definition at line 155 of file UpdateJobRequest.h.

◆ GetJobId()

const Aws::String& Aws::IoT::Model::UpdateJobRequest::GetJobId ( ) const
inline

The ID of the job to be updated.

Definition at line 42 of file UpdateJobRequest.h.

◆ GetPresignedUrlConfig()

const PresignedUrlConfig& Aws::IoT::Model::UpdateJobRequest::GetPresignedUrlConfig ( ) const
inline

Configuration information for pre-signed S3 URLs.

Definition at line 124 of file UpdateJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file UpdateJobRequest.h.

◆ GetTimeoutConfig()

const TimeoutConfig& Aws::IoT::Model::UpdateJobRequest::GetTimeoutConfig ( ) const
inline

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 221 of file UpdateJobRequest.h.

◆ JobExecutionsRolloutConfigHasBeenSet()

bool Aws::IoT::Model::UpdateJobRequest::JobExecutionsRolloutConfigHasBeenSet ( ) const
inline

Allows you to create a staged rollout of the job.

Definition at line 160 of file UpdateJobRequest.h.

◆ JobIdHasBeenSet()

bool Aws::IoT::Model::UpdateJobRequest::JobIdHasBeenSet ( ) const
inline

The ID of the job to be updated.

Definition at line 47 of file UpdateJobRequest.h.

◆ PresignedUrlConfigHasBeenSet()

bool Aws::IoT::Model::UpdateJobRequest::PresignedUrlConfigHasBeenSet ( ) const
inline

Configuration information for pre-signed S3 URLs.

Definition at line 129 of file UpdateJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAbortConfig() [1/2]

void Aws::IoT::Model::UpdateJobRequest::SetAbortConfig ( const AbortConfig value)
inline

Allows you to create criteria to abort a job.

Definition at line 196 of file UpdateJobRequest.h.

◆ SetAbortConfig() [2/2]

void Aws::IoT::Model::UpdateJobRequest::SetAbortConfig ( AbortConfig &&  value)
inline

Allows you to create criteria to abort a job.

Definition at line 201 of file UpdateJobRequest.h.

◆ SetDescription() [1/3]

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

A short text description of the job.

Definition at line 93 of file UpdateJobRequest.h.

◆ SetDescription() [2/3]

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

A short text description of the job.

Definition at line 98 of file UpdateJobRequest.h.

◆ SetDescription() [3/3]

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

A short text description of the job.

Definition at line 103 of file UpdateJobRequest.h.

◆ SetJobExecutionsRolloutConfig() [1/2]

void Aws::IoT::Model::UpdateJobRequest::SetJobExecutionsRolloutConfig ( const JobExecutionsRolloutConfig value)
inline

Allows you to create a staged rollout of the job.

Definition at line 165 of file UpdateJobRequest.h.

◆ SetJobExecutionsRolloutConfig() [2/2]

void Aws::IoT::Model::UpdateJobRequest::SetJobExecutionsRolloutConfig ( JobExecutionsRolloutConfig &&  value)
inline

Allows you to create a staged rollout of the job.

Definition at line 170 of file UpdateJobRequest.h.

◆ SetJobId() [1/3]

void Aws::IoT::Model::UpdateJobRequest::SetJobId ( const Aws::String value)
inline

The ID of the job to be updated.

Definition at line 52 of file UpdateJobRequest.h.

◆ SetJobId() [2/3]

void Aws::IoT::Model::UpdateJobRequest::SetJobId ( Aws::String &&  value)
inline

The ID of the job to be updated.

Definition at line 57 of file UpdateJobRequest.h.

◆ SetJobId() [3/3]

void Aws::IoT::Model::UpdateJobRequest::SetJobId ( const char *  value)
inline

The ID of the job to be updated.

Definition at line 62 of file UpdateJobRequest.h.

◆ SetPresignedUrlConfig() [1/2]

void Aws::IoT::Model::UpdateJobRequest::SetPresignedUrlConfig ( const PresignedUrlConfig value)
inline

Configuration information for pre-signed S3 URLs.

Definition at line 134 of file UpdateJobRequest.h.

◆ SetPresignedUrlConfig() [2/2]

void Aws::IoT::Model::UpdateJobRequest::SetPresignedUrlConfig ( PresignedUrlConfig &&  value)
inline

Configuration information for pre-signed S3 URLs.

Definition at line 139 of file UpdateJobRequest.h.

◆ SetTimeoutConfig() [1/2]

void Aws::IoT::Model::UpdateJobRequest::SetTimeoutConfig ( const TimeoutConfig value)
inline

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 239 of file UpdateJobRequest.h.

◆ SetTimeoutConfig() [2/2]

void Aws::IoT::Model::UpdateJobRequest::SetTimeoutConfig ( TimeoutConfig &&  value)
inline

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 248 of file UpdateJobRequest.h.

◆ TimeoutConfigHasBeenSet()

bool Aws::IoT::Model::UpdateJobRequest::TimeoutConfigHasBeenSet ( ) const
inline

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 230 of file UpdateJobRequest.h.

◆ WithAbortConfig() [1/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithAbortConfig ( const AbortConfig value)
inline

Allows you to create criteria to abort a job.

Definition at line 206 of file UpdateJobRequest.h.

◆ WithAbortConfig() [2/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithAbortConfig ( AbortConfig &&  value)
inline

Allows you to create criteria to abort a job.

Definition at line 211 of file UpdateJobRequest.h.

◆ WithDescription() [1/3]

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

A short text description of the job.

Definition at line 108 of file UpdateJobRequest.h.

◆ WithDescription() [2/3]

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

A short text description of the job.

Definition at line 113 of file UpdateJobRequest.h.

◆ WithDescription() [3/3]

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

A short text description of the job.

Definition at line 118 of file UpdateJobRequest.h.

◆ WithJobExecutionsRolloutConfig() [1/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithJobExecutionsRolloutConfig ( const JobExecutionsRolloutConfig value)
inline

Allows you to create a staged rollout of the job.

Definition at line 175 of file UpdateJobRequest.h.

◆ WithJobExecutionsRolloutConfig() [2/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithJobExecutionsRolloutConfig ( JobExecutionsRolloutConfig &&  value)
inline

Allows you to create a staged rollout of the job.

Definition at line 180 of file UpdateJobRequest.h.

◆ WithJobId() [1/3]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithJobId ( const Aws::String value)
inline

The ID of the job to be updated.

Definition at line 67 of file UpdateJobRequest.h.

◆ WithJobId() [2/3]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithJobId ( Aws::String &&  value)
inline

The ID of the job to be updated.

Definition at line 72 of file UpdateJobRequest.h.

◆ WithJobId() [3/3]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithJobId ( const char *  value)
inline

The ID of the job to be updated.

Definition at line 77 of file UpdateJobRequest.h.

◆ WithPresignedUrlConfig() [1/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithPresignedUrlConfig ( const PresignedUrlConfig value)
inline

Configuration information for pre-signed S3 URLs.

Definition at line 144 of file UpdateJobRequest.h.

◆ WithPresignedUrlConfig() [2/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithPresignedUrlConfig ( PresignedUrlConfig &&  value)
inline

Configuration information for pre-signed S3 URLs.

Definition at line 149 of file UpdateJobRequest.h.

◆ WithTimeoutConfig() [1/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithTimeoutConfig ( const TimeoutConfig value)
inline

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 257 of file UpdateJobRequest.h.

◆ WithTimeoutConfig() [2/2]

UpdateJobRequest& Aws::IoT::Model::UpdateJobRequest::WithTimeoutConfig ( TimeoutConfig &&  value)
inline

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

Definition at line 266 of file UpdateJobRequest.h.


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