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

#include <CancelJobExecutionRequest.h>

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

Public Member Functions

 CancelJobExecutionRequest ()
 
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)
 
CancelJobExecutionRequestWithJobId (const Aws::String &value)
 
CancelJobExecutionRequestWithJobId (Aws::String &&value)
 
CancelJobExecutionRequestWithJobId (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)
 
CancelJobExecutionRequestWithThingName (const Aws::String &value)
 
CancelJobExecutionRequestWithThingName (Aws::String &&value)
 
CancelJobExecutionRequestWithThingName (const char *value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
CancelJobExecutionRequestWithForce (bool value)
 
long long GetExpectedVersion () const
 
bool ExpectedVersionHasBeenSet () const
 
void SetExpectedVersion (long long value)
 
CancelJobExecutionRequestWithExpectedVersion (long long 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)
 
CancelJobExecutionRequestWithStatusDetails (const Aws::Map< Aws::String, Aws::String > &value)
 
CancelJobExecutionRequestWithStatusDetails (Aws::Map< Aws::String, Aws::String > &&value)
 
CancelJobExecutionRequestAddStatusDetails (const Aws::String &key, const Aws::String &value)
 
CancelJobExecutionRequestAddStatusDetails (Aws::String &&key, const Aws::String &value)
 
CancelJobExecutionRequestAddStatusDetails (const Aws::String &key, Aws::String &&value)
 
CancelJobExecutionRequestAddStatusDetails (Aws::String &&key, Aws::String &&value)
 
CancelJobExecutionRequestAddStatusDetails (const char *key, Aws::String &&value)
 
CancelJobExecutionRequestAddStatusDetails (Aws::String &&key, const char *value)
 
CancelJobExecutionRequestAddStatusDetails (const char *key, 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 26 of file CancelJobExecutionRequest.h.

Constructor & Destructor Documentation

◆ CancelJobExecutionRequest()

Aws::IoT::Model::CancelJobExecutionRequest::CancelJobExecutionRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ AddStatusDetails() [1/7]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::AddStatusDetails ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 286 of file CancelJobExecutionRequest.h.

◆ AddStatusDetails() [2/7]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::AddStatusDetails ( Aws::String &&  key,
const Aws::String value 
)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 272 of file CancelJobExecutionRequest.h.

◆ AddStatusDetails() [3/7]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::AddStatusDetails ( Aws::String &&  key,
const char *  value 
)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 300 of file CancelJobExecutionRequest.h.

◆ AddStatusDetails() [4/7]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::AddStatusDetails ( const Aws::String key,
Aws::String &&  value 
)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 279 of file CancelJobExecutionRequest.h.

◆ AddStatusDetails() [5/7]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::AddStatusDetails ( const Aws::String key,
const Aws::String value 
)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 265 of file CancelJobExecutionRequest.h.

◆ AddStatusDetails() [6/7]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::AddStatusDetails ( const char *  key,
Aws::String &&  value 
)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 293 of file CancelJobExecutionRequest.h.

◆ AddStatusDetails() [7/7]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::AddStatusDetails ( const char *  key,
const char *  value 
)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 307 of file CancelJobExecutionRequest.h.

◆ ExpectedVersionHasBeenSet()

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

◆ ForceHasBeenSet()

bool Aws::IoT::Model::CancelJobExecutionRequest::ForceHasBeenSet ( ) const
inline

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Definition at line 146 of file CancelJobExecutionRequest.h.

◆ GetExpectedVersion()

long long Aws::IoT::Model::CancelJobExecutionRequest::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 182 of file CancelJobExecutionRequest.h.

◆ GetForce()

bool Aws::IoT::Model::CancelJobExecutionRequest::GetForce ( ) const
inline

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Definition at line 134 of file CancelJobExecutionRequest.h.

◆ GetJobId()

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

The ID of the job to be canceled.

Definition at line 45 of file CancelJobExecutionRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CancelJobExecutionRequest.h.

◆ GetStatusDetails()

const Aws::Map<Aws::String, Aws::String>& Aws::IoT::Model::CancelJobExecutionRequest::GetStatusDetails ( ) const
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 223 of file CancelJobExecutionRequest.h.

◆ GetThingName()

const Aws::String& Aws::IoT::Model::CancelJobExecutionRequest::GetThingName ( ) const
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 86 of file CancelJobExecutionRequest.h.

◆ JobIdHasBeenSet()

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

The ID of the job to be canceled.

Definition at line 50 of file CancelJobExecutionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExpectedVersion()

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

◆ SetForce()

void Aws::IoT::Model::CancelJobExecutionRequest::SetForce ( bool  value)
inline

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Definition at line 158 of file CancelJobExecutionRequest.h.

◆ SetJobId() [1/3]

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

The ID of the job to be canceled.

Definition at line 60 of file CancelJobExecutionRequest.h.

◆ SetJobId() [2/3]

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

The ID of the job to be canceled.

Definition at line 55 of file CancelJobExecutionRequest.h.

◆ SetJobId() [3/3]

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

The ID of the job to be canceled.

Definition at line 65 of file CancelJobExecutionRequest.h.

◆ SetStatusDetails() [1/2]

void Aws::IoT::Model::CancelJobExecutionRequest::SetStatusDetails ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 244 of file CancelJobExecutionRequest.h.

◆ SetStatusDetails() [2/2]

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

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 237 of file CancelJobExecutionRequest.h.

◆ SetThingName() [1/3]

void Aws::IoT::Model::CancelJobExecutionRequest::SetThingName ( Aws::String &&  value)
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 101 of file CancelJobExecutionRequest.h.

◆ SetThingName() [2/3]

void Aws::IoT::Model::CancelJobExecutionRequest::SetThingName ( const Aws::String value)
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 96 of file CancelJobExecutionRequest.h.

◆ SetThingName() [3/3]

void Aws::IoT::Model::CancelJobExecutionRequest::SetThingName ( const char *  value)
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 106 of file CancelJobExecutionRequest.h.

◆ StatusDetailsHasBeenSet()

bool Aws::IoT::Model::CancelJobExecutionRequest::StatusDetailsHasBeenSet ( ) const
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 230 of file CancelJobExecutionRequest.h.

◆ ThingNameHasBeenSet()

bool Aws::IoT::Model::CancelJobExecutionRequest::ThingNameHasBeenSet ( ) const
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 91 of file CancelJobExecutionRequest.h.

◆ WithExpectedVersion()

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

◆ WithForce()

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::WithForce ( bool  value)
inline

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Definition at line 170 of file CancelJobExecutionRequest.h.

◆ WithJobId() [1/3]

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

The ID of the job to be canceled.

Definition at line 75 of file CancelJobExecutionRequest.h.

◆ WithJobId() [2/3]

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

The ID of the job to be canceled.

Definition at line 70 of file CancelJobExecutionRequest.h.

◆ WithJobId() [3/3]

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

The ID of the job to be canceled.

Definition at line 80 of file CancelJobExecutionRequest.h.

◆ WithStatusDetails() [1/2]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::WithStatusDetails ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 258 of file CancelJobExecutionRequest.h.

◆ WithStatusDetails() [2/2]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::WithStatusDetails ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Definition at line 251 of file CancelJobExecutionRequest.h.

◆ WithThingName() [1/3]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::WithThingName ( Aws::String &&  value)
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 116 of file CancelJobExecutionRequest.h.

◆ WithThingName() [2/3]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::WithThingName ( const Aws::String value)
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 111 of file CancelJobExecutionRequest.h.

◆ WithThingName() [3/3]

CancelJobExecutionRequest& Aws::IoT::Model::CancelJobExecutionRequest::WithThingName ( const char *  value)
inline

The name of the thing whose execution of the job will be canceled.

Definition at line 121 of file CancelJobExecutionRequest.h.


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