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

#include <DeleteJobExecutionRequest.h>

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

Public Member Functions

 DeleteJobExecutionRequest ()
 
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)
 
DeleteJobExecutionRequestWithJobId (const Aws::String &value)
 
DeleteJobExecutionRequestWithJobId (Aws::String &&value)
 
DeleteJobExecutionRequestWithJobId (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)
 
DeleteJobExecutionRequestWithThingName (const Aws::String &value)
 
DeleteJobExecutionRequestWithThingName (Aws::String &&value)
 
DeleteJobExecutionRequestWithThingName (const char *value)
 
long long GetExecutionNumber () const
 
bool ExecutionNumberHasBeenSet () const
 
void SetExecutionNumber (long long value)
 
DeleteJobExecutionRequestWithExecutionNumber (long long value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
DeleteJobExecutionRequestWithForce (bool 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 25 of file DeleteJobExecutionRequest.h.

Constructor & Destructor Documentation

◆ DeleteJobExecutionRequest()

Aws::IoT::Model::DeleteJobExecutionRequest::DeleteJobExecutionRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ExecutionNumberHasBeenSet()

bool Aws::IoT::Model::DeleteJobExecutionRequest::ExecutionNumberHasBeenSet ( ) const
inline

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Definition at line 137 of file DeleteJobExecutionRequest.h.

◆ ForceHasBeenSet()

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

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

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

Definition at line 176 of file DeleteJobExecutionRequest.h.

◆ GetExecutionNumber()

long long Aws::IoT::Model::DeleteJobExecutionRequest::GetExecutionNumber ( ) const
inline

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Definition at line 129 of file DeleteJobExecutionRequest.h.

◆ GetForce()

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

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

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

Definition at line 165 of file DeleteJobExecutionRequest.h.

◆ GetJobId()

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 44 of file DeleteJobExecutionRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DeleteJobExecutionRequest.h.

◆ GetThingName()

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

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

Definition at line 85 of file DeleteJobExecutionRequest.h.

◆ JobIdHasBeenSet()

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 49 of file DeleteJobExecutionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExecutionNumber()

void Aws::IoT::Model::DeleteJobExecutionRequest::SetExecutionNumber ( long long  value)
inline

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Definition at line 145 of file DeleteJobExecutionRequest.h.

◆ SetForce()

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

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

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

Definition at line 187 of file DeleteJobExecutionRequest.h.

◆ SetJobId() [1/3]

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 54 of file DeleteJobExecutionRequest.h.

◆ SetJobId() [2/3]

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 59 of file DeleteJobExecutionRequest.h.

◆ SetJobId() [3/3]

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 64 of file DeleteJobExecutionRequest.h.

◆ SetThingName() [1/3]

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

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

Definition at line 95 of file DeleteJobExecutionRequest.h.

◆ SetThingName() [2/3]

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

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

Definition at line 100 of file DeleteJobExecutionRequest.h.

◆ SetThingName() [3/3]

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

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

Definition at line 105 of file DeleteJobExecutionRequest.h.

◆ ThingNameHasBeenSet()

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

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

Definition at line 90 of file DeleteJobExecutionRequest.h.

◆ WithExecutionNumber()

DeleteJobExecutionRequest& Aws::IoT::Model::DeleteJobExecutionRequest::WithExecutionNumber ( long long  value)
inline

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Definition at line 153 of file DeleteJobExecutionRequest.h.

◆ WithForce()

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

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

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

Definition at line 198 of file DeleteJobExecutionRequest.h.

◆ WithJobId() [1/3]

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 69 of file DeleteJobExecutionRequest.h.

◆ WithJobId() [2/3]

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 74 of file DeleteJobExecutionRequest.h.

◆ WithJobId() [3/3]

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

The ID of the job whose execution on a particular device will be deleted.

Definition at line 79 of file DeleteJobExecutionRequest.h.

◆ WithThingName() [1/3]

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

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

Definition at line 110 of file DeleteJobExecutionRequest.h.

◆ WithThingName() [2/3]

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

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

Definition at line 115 of file DeleteJobExecutionRequest.h.

◆ WithThingName() [3/3]

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

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

Definition at line 120 of file DeleteJobExecutionRequest.h.


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