AWS SDK for C++  1.9.45
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest Class Reference

#include <UpdateJobExecutionRequest.h>

+ Inheritance diagram for Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest:

Public Member Functions

 UpdateJobExecutionRequest ()
 
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)
 
UpdateJobExecutionRequestWithJobId (const Aws::String &value)
 
UpdateJobExecutionRequestWithJobId (Aws::String &&value)
 
UpdateJobExecutionRequestWithJobId (const char *value)
 
const Aws::StringGetThingName () const
 
bool ThingNameHasBeenSet () const
 
void SetThingName (const Aws::String &value)
 
void SetThingName (Aws::String &&value)
 
void SetThingName (const char *value)
 
UpdateJobExecutionRequestWithThingName (const Aws::String &value)
 
UpdateJobExecutionRequestWithThingName (Aws::String &&value)
 
UpdateJobExecutionRequestWithThingName (const char *value)
 
const JobExecutionStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobExecutionStatus &value)
 
void SetStatus (JobExecutionStatus &&value)
 
UpdateJobExecutionRequestWithStatus (const JobExecutionStatus &value)
 
UpdateJobExecutionRequestWithStatus (JobExecutionStatus &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetStatusDetails () const
 
bool StatusDetailsHasBeenSet () const
 
void SetStatusDetails (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetStatusDetails (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateJobExecutionRequestWithStatusDetails (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateJobExecutionRequestWithStatusDetails (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateJobExecutionRequestAddStatusDetails (const Aws::String &key, const Aws::String &value)
 
UpdateJobExecutionRequestAddStatusDetails (Aws::String &&key, const Aws::String &value)
 
UpdateJobExecutionRequestAddStatusDetails (const Aws::String &key, Aws::String &&value)
 
UpdateJobExecutionRequestAddStatusDetails (Aws::String &&key, Aws::String &&value)
 
UpdateJobExecutionRequestAddStatusDetails (const char *key, Aws::String &&value)
 
UpdateJobExecutionRequestAddStatusDetails (Aws::String &&key, const char *value)
 
UpdateJobExecutionRequestAddStatusDetails (const char *key, const char *value)
 
long long GetStepTimeoutInMinutes () const
 
bool StepTimeoutInMinutesHasBeenSet () const
 
void SetStepTimeoutInMinutes (long long value)
 
UpdateJobExecutionRequestWithStepTimeoutInMinutes (long long value)
 
long long GetExpectedVersion () const
 
bool ExpectedVersionHasBeenSet () const
 
void SetExpectedVersion (long long value)
 
UpdateJobExecutionRequestWithExpectedVersion (long long value)
 
bool GetIncludeJobExecutionState () const
 
bool IncludeJobExecutionStateHasBeenSet () const
 
void SetIncludeJobExecutionState (bool value)
 
UpdateJobExecutionRequestWithIncludeJobExecutionState (bool value)
 
bool GetIncludeJobDocument () const
 
bool IncludeJobDocumentHasBeenSet () const
 
void SetIncludeJobDocument (bool value)
 
UpdateJobExecutionRequestWithIncludeJobDocument (bool value)
 
long long GetExecutionNumber () const
 
bool ExecutionNumberHasBeenSet () const
 
void SetExecutionNumber (long long value)
 
UpdateJobExecutionRequestWithExecutionNumber (long long value)
 
- Public Member Functions inherited from Aws::IoTJobsDataPlane::IoTJobsDataPlaneRequest
virtual ~IoTJobsDataPlaneRequest ()
 
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::IoTJobsDataPlane::IoTJobsDataPlaneRequest
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 23 of file UpdateJobExecutionRequest.h.

Constructor & Destructor Documentation

◆ UpdateJobExecutionRequest()

Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::UpdateJobExecutionRequest ( )

Member Function Documentation

◆ AddStatusDetails() [1/7]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::AddStatusDetails ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 214 of file UpdateJobExecutionRequest.h.

◆ AddStatusDetails() [2/7]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::AddStatusDetails ( Aws::String &&  key,
const Aws::String value 
)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 202 of file UpdateJobExecutionRequest.h.

◆ AddStatusDetails() [3/7]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::AddStatusDetails ( Aws::String &&  key,
const char *  value 
)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 226 of file UpdateJobExecutionRequest.h.

◆ AddStatusDetails() [4/7]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::AddStatusDetails ( const Aws::String key,
Aws::String &&  value 
)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 208 of file UpdateJobExecutionRequest.h.

◆ AddStatusDetails() [5/7]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::AddStatusDetails ( const Aws::String key,
const Aws::String value 
)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 196 of file UpdateJobExecutionRequest.h.

◆ AddStatusDetails() [6/7]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::AddStatusDetails ( const char *  key,
Aws::String &&  value 
)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 220 of file UpdateJobExecutionRequest.h.

◆ AddStatusDetails() [7/7]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::AddStatusDetails ( const char *  key,
const char *  value 
)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 232 of file UpdateJobExecutionRequest.h.

◆ ExecutionNumberHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::ExecutionNumberHasBeenSet ( ) const
inline

Optional. A number that identifies a particular job execution on a particular device.

Definition at line 393 of file UpdateJobExecutionRequest.h.

◆ ExpectedVersionHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::ExpectedVersionHasBeenSet ( ) const
inline

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Definition at line 308 of file UpdateJobExecutionRequest.h.

◆ GetExecutionNumber()

long long Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetExecutionNumber ( ) const
inline

Optional. A number that identifies a particular job execution on a particular device.

Definition at line 387 of file UpdateJobExecutionRequest.h.

◆ GetExpectedVersion()

long long Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetExpectedVersion ( ) const
inline

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Definition at line 297 of file UpdateJobExecutionRequest.h.

◆ GetIncludeJobDocument()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetIncludeJobDocument ( ) const
inline

Optional. When set to true, the response contains the job document. The default is false.

Definition at line 362 of file UpdateJobExecutionRequest.h.

◆ GetIncludeJobExecutionState()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetIncludeJobExecutionState ( ) const
inline

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Definition at line 337 of file UpdateJobExecutionRequest.h.

◆ GetJobId()

const Aws::String& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetJobId ( ) const
inline

The unique identifier assigned to this job when it was created.

Definition at line 40 of file UpdateJobExecutionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file UpdateJobExecutionRequest.h.

◆ GetStatus()

const JobExecutionStatus& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetStatus ( ) const
inline

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Definition at line 123 of file UpdateJobExecutionRequest.h.

◆ GetStatusDetails()

const Aws::Map<Aws::String, Aws::String>& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetStatusDetails ( ) const
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 160 of file UpdateJobExecutionRequest.h.

◆ GetStepTimeoutInMinutes()

long long Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetStepTimeoutInMinutes ( ) const
inline

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Definition at line 246 of file UpdateJobExecutionRequest.h.

◆ GetThingName()

const Aws::String& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::GetThingName ( ) const
inline

The name of the thing associated with the device.

Definition at line 81 of file UpdateJobExecutionRequest.h.

◆ IncludeJobDocumentHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::IncludeJobDocumentHasBeenSet ( ) const
inline

Optional. When set to true, the response contains the job document. The default is false.

Definition at line 368 of file UpdateJobExecutionRequest.h.

◆ IncludeJobExecutionStateHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::IncludeJobExecutionStateHasBeenSet ( ) const
inline

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Definition at line 343 of file UpdateJobExecutionRequest.h.

◆ JobIdHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::JobIdHasBeenSet ( ) const
inline

The unique identifier assigned to this job when it was created.

Definition at line 45 of file UpdateJobExecutionRequest.h.

◆ SerializePayload()

Aws::String Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExecutionNumber()

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetExecutionNumber ( long long  value)
inline

Optional. A number that identifies a particular job execution on a particular device.

Definition at line 399 of file UpdateJobExecutionRequest.h.

◆ SetExpectedVersion()

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetExpectedVersion ( long long  value)
inline

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Definition at line 319 of file UpdateJobExecutionRequest.h.

◆ SetIncludeJobDocument()

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetIncludeJobDocument ( bool  value)
inline

Optional. When set to true, the response contains the job document. The default is false.

Definition at line 374 of file UpdateJobExecutionRequest.h.

◆ SetIncludeJobExecutionState()

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetIncludeJobExecutionState ( bool  value)
inline

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Definition at line 349 of file UpdateJobExecutionRequest.h.

◆ SetJobId() [1/3]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetJobId ( Aws::String &&  value)
inline

The unique identifier assigned to this job when it was created.

Definition at line 55 of file UpdateJobExecutionRequest.h.

◆ SetJobId() [2/3]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetJobId ( const Aws::String value)
inline

The unique identifier assigned to this job when it was created.

Definition at line 50 of file UpdateJobExecutionRequest.h.

◆ SetJobId() [3/3]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetJobId ( const char *  value)
inline

The unique identifier assigned to this job when it was created.

Definition at line 60 of file UpdateJobExecutionRequest.h.

◆ SetStatus() [1/2]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetStatus ( const JobExecutionStatus value)
inline

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Definition at line 135 of file UpdateJobExecutionRequest.h.

◆ SetStatus() [2/2]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetStatus ( JobExecutionStatus &&  value)
inline

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Definition at line 141 of file UpdateJobExecutionRequest.h.

◆ SetStatusDetails() [1/2]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetStatusDetails ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 178 of file UpdateJobExecutionRequest.h.

◆ SetStatusDetails() [2/2]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetStatusDetails ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 172 of file UpdateJobExecutionRequest.h.

◆ SetStepTimeoutInMinutes()

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetStepTimeoutInMinutes ( long long  value)
inline

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Definition at line 272 of file UpdateJobExecutionRequest.h.

◆ SetThingName() [1/3]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetThingName ( Aws::String &&  value)
inline

The name of the thing associated with the device.

Definition at line 96 of file UpdateJobExecutionRequest.h.

◆ SetThingName() [2/3]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetThingName ( const Aws::String value)
inline

The name of the thing associated with the device.

Definition at line 91 of file UpdateJobExecutionRequest.h.

◆ SetThingName() [3/3]

void Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::SetThingName ( const char *  value)
inline

The name of the thing associated with the device.

Definition at line 101 of file UpdateJobExecutionRequest.h.

◆ StatusDetailsHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::StatusDetailsHasBeenSet ( ) const
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 166 of file UpdateJobExecutionRequest.h.

◆ StatusHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::StatusHasBeenSet ( ) const
inline

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Definition at line 129 of file UpdateJobExecutionRequest.h.

◆ StepTimeoutInMinutesHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::StepTimeoutInMinutesHasBeenSet ( ) const
inline

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Definition at line 259 of file UpdateJobExecutionRequest.h.

◆ ThingNameHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::ThingNameHasBeenSet ( ) const
inline

The name of the thing associated with the device.

Definition at line 86 of file UpdateJobExecutionRequest.h.

◆ WithExecutionNumber()

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithExecutionNumber ( long long  value)
inline

Optional. A number that identifies a particular job execution on a particular device.

Definition at line 405 of file UpdateJobExecutionRequest.h.

◆ WithExpectedVersion()

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithExpectedVersion ( long long  value)
inline

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Definition at line 330 of file UpdateJobExecutionRequest.h.

◆ WithIncludeJobDocument()

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithIncludeJobDocument ( bool  value)
inline

Optional. When set to true, the response contains the job document. The default is false.

Definition at line 380 of file UpdateJobExecutionRequest.h.

◆ WithIncludeJobExecutionState()

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithIncludeJobExecutionState ( bool  value)
inline

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Definition at line 355 of file UpdateJobExecutionRequest.h.

◆ WithJobId() [1/3]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithJobId ( Aws::String &&  value)
inline

The unique identifier assigned to this job when it was created.

Definition at line 70 of file UpdateJobExecutionRequest.h.

◆ WithJobId() [2/3]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithJobId ( const Aws::String value)
inline

The unique identifier assigned to this job when it was created.

Definition at line 65 of file UpdateJobExecutionRequest.h.

◆ WithJobId() [3/3]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithJobId ( const char *  value)
inline

The unique identifier assigned to this job when it was created.

Definition at line 75 of file UpdateJobExecutionRequest.h.

◆ WithStatus() [1/2]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithStatus ( const JobExecutionStatus value)
inline

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Definition at line 147 of file UpdateJobExecutionRequest.h.

◆ WithStatus() [2/2]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithStatus ( JobExecutionStatus &&  value)
inline

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Definition at line 153 of file UpdateJobExecutionRequest.h.

◆ WithStatusDetails() [1/2]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithStatusDetails ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 190 of file UpdateJobExecutionRequest.h.

◆ WithStatusDetails() [2/2]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithStatusDetails ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Definition at line 184 of file UpdateJobExecutionRequest.h.

◆ WithStepTimeoutInMinutes()

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithStepTimeoutInMinutes ( long long  value)
inline

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Definition at line 285 of file UpdateJobExecutionRequest.h.

◆ WithThingName() [1/3]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithThingName ( Aws::String &&  value)
inline

The name of the thing associated with the device.

Definition at line 111 of file UpdateJobExecutionRequest.h.

◆ WithThingName() [2/3]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithThingName ( const Aws::String value)
inline

The name of the thing associated with the device.

Definition at line 106 of file UpdateJobExecutionRequest.h.

◆ WithThingName() [3/3]

UpdateJobExecutionRequest& Aws::IoTJobsDataPlane::Model::UpdateJobExecutionRequest::WithThingName ( const char *  value)
inline

The name of the thing associated with the device.

Definition at line 116 of file UpdateJobExecutionRequest.h.


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