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

#include <DeleteJobRequest.h>

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

Public Member Functions

 DeleteJobRequest ()
 
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)
 
DeleteJobRequestWithJobId (const Aws::String &value)
 
DeleteJobRequestWithJobId (Aws::String &&value)
 
DeleteJobRequestWithJobId (const char *value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
DeleteJobRequestWithForce (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 DeleteJobRequest.h.

Constructor & Destructor Documentation

◆ DeleteJobRequest()

Aws::IoT::Model::DeleteJobRequest::DeleteJobRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ForceHasBeenSet()

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

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

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

Definition at line 126 of file DeleteJobRequest.h.

◆ GetForce()

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

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

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

Definition at line 115 of file DeleteJobRequest.h.

◆ GetJobId()

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 47 of file DeleteJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DeleteJobRequest.h.

◆ JobIdHasBeenSet()

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 55 of file DeleteJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetForce()

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

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

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

Definition at line 137 of file DeleteJobRequest.h.

◆ SetJobId() [1/3]

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 63 of file DeleteJobRequest.h.

◆ SetJobId() [2/3]

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 71 of file DeleteJobRequest.h.

◆ SetJobId() [3/3]

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 79 of file DeleteJobRequest.h.

◆ WithForce()

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

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

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

Definition at line 148 of file DeleteJobRequest.h.

◆ WithJobId() [1/3]

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 87 of file DeleteJobRequest.h.

◆ WithJobId() [2/3]

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 95 of file DeleteJobRequest.h.

◆ WithJobId() [3/3]

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

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Definition at line 103 of file DeleteJobRequest.h.


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