AWS SDK for C++  1.9.71
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
 
void AddQueryStringParameters (Aws::Http::URI &uri) 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)
 
const Aws::StringGetNamespaceId () const
 
bool NamespaceIdHasBeenSet () const
 
void SetNamespaceId (const Aws::String &value)
 
void SetNamespaceId (Aws::String &&value)
 
void SetNamespaceId (const char *value)
 
UpdateJobRequestWithNamespaceId (const Aws::String &value)
 
UpdateJobRequestWithNamespaceId (Aws::String &&value)
 
UpdateJobRequestWithNamespaceId (const char *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 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 29 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 197 of file UpdateJobRequest.h.

◆ AddQueryStringParameters()

void Aws::IoT::Model::UpdateJobRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DescriptionHasBeenSet()

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

A short text description of the job.

Definition at line 94 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 192 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 89 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 161 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 48 of file UpdateJobRequest.h.

◆ GetNamespaceId()

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 284 of file UpdateJobRequest.h.

◆ GetPresignedUrlConfig()

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

Configuration information for pre-signed S3 URLs.

Definition at line 130 of file UpdateJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 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 227 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 166 of file UpdateJobRequest.h.

◆ JobIdHasBeenSet()

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

The ID of the job to be updated.

Definition at line 53 of file UpdateJobRequest.h.

◆ NamespaceIdHasBeenSet()

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 295 of file UpdateJobRequest.h.

◆ PresignedUrlConfigHasBeenSet()

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

Configuration information for pre-signed S3 URLs.

Definition at line 135 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 ( AbortConfig &&  value)
inline

Allows you to create criteria to abort a job.

Definition at line 207 of file UpdateJobRequest.h.

◆ SetAbortConfig() [2/2]

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

Allows you to create criteria to abort a job.

Definition at line 202 of file UpdateJobRequest.h.

◆ SetDescription() [1/3]

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

A short text description of the job.

Definition at line 104 of file UpdateJobRequest.h.

◆ SetDescription() [2/3]

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

A short text description of the job.

Definition at line 99 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 109 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 171 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 176 of file UpdateJobRequest.h.

◆ SetJobId() [1/3]

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

The ID of the job to be updated.

Definition at line 63 of file UpdateJobRequest.h.

◆ SetJobId() [2/3]

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

The ID of the job to be updated.

Definition at line 58 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 68 of file UpdateJobRequest.h.

◆ SetNamespaceId() [1/3]

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 317 of file UpdateJobRequest.h.

◆ SetNamespaceId() [2/3]

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 306 of file UpdateJobRequest.h.

◆ SetNamespaceId() [3/3]

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 328 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 140 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 145 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 245 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 254 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 236 of file UpdateJobRequest.h.

◆ WithAbortConfig() [1/2]

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

Allows you to create criteria to abort a job.

Definition at line 217 of file UpdateJobRequest.h.

◆ WithAbortConfig() [2/2]

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

Allows you to create criteria to abort a job.

Definition at line 212 of file UpdateJobRequest.h.

◆ WithDescription() [1/3]

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

A short text description of the job.

Definition at line 119 of file UpdateJobRequest.h.

◆ WithDescription() [2/3]

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

A short text description of the job.

Definition at line 114 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 124 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 181 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 186 of file UpdateJobRequest.h.

◆ WithJobId() [1/3]

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

The ID of the job to be updated.

Definition at line 78 of file UpdateJobRequest.h.

◆ WithJobId() [2/3]

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

The ID of the job to be updated.

Definition at line 73 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 83 of file UpdateJobRequest.h.

◆ WithNamespaceId() [1/3]

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 350 of file UpdateJobRequest.h.

◆ WithNamespaceId() [2/3]

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 339 of file UpdateJobRequest.h.

◆ WithNamespaceId() [3/3]

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 361 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 150 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 155 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 263 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 272 of file UpdateJobRequest.h.


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