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

#include <CancelJobRequest.h>

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

Public Member Functions

 CancelJobRequest ()
 
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)
 
CancelJobRequestWithJobId (const Aws::String &value)
 
CancelJobRequestWithJobId (Aws::String &&value)
 
CancelJobRequestWithJobId (const char *value)
 
const Aws::StringGetReasonCode () const
 
bool ReasonCodeHasBeenSet () const
 
void SetReasonCode (const Aws::String &value)
 
void SetReasonCode (Aws::String &&value)
 
void SetReasonCode (const char *value)
 
CancelJobRequestWithReasonCode (const Aws::String &value)
 
CancelJobRequestWithReasonCode (Aws::String &&value)
 
CancelJobRequestWithReasonCode (const char *value)
 
const Aws::StringGetComment () const
 
bool CommentHasBeenSet () const
 
void SetComment (const Aws::String &value)
 
void SetComment (Aws::String &&value)
 
void SetComment (const char *value)
 
CancelJobRequestWithComment (const Aws::String &value)
 
CancelJobRequestWithComment (Aws::String &&value)
 
CancelJobRequestWithComment (const char *value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
CancelJobRequestWithForce (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 CancelJobRequest.h.

Constructor & Destructor Documentation

◆ CancelJobRequest()

Aws::IoT::Model::CancelJobRequest::CancelJobRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ CommentHasBeenSet()

bool Aws::IoT::Model::CancelJobRequest::CommentHasBeenSet ( ) const
inline

An optional comment string describing why the job was canceled.

Definition at line 131 of file CancelJobRequest.h.

◆ ForceHasBeenSet()

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

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

Definition at line 182 of file CancelJobRequest.h.

◆ GetComment()

const Aws::String& Aws::IoT::Model::CancelJobRequest::GetComment ( ) const
inline

An optional comment string describing why the job was canceled.

Definition at line 126 of file CancelJobRequest.h.

◆ GetForce()

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

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

Definition at line 172 of file CancelJobRequest.h.

◆ GetJobId()

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

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

Definition at line 44 of file CancelJobRequest.h.

◆ GetReasonCode()

const Aws::String& Aws::IoT::Model::CancelJobRequest::GetReasonCode ( ) const
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 85 of file CancelJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CancelJobRequest.h.

◆ JobIdHasBeenSet()

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

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

Definition at line 49 of file CancelJobRequest.h.

◆ ReasonCodeHasBeenSet()

bool Aws::IoT::Model::CancelJobRequest::ReasonCodeHasBeenSet ( ) const
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 90 of file CancelJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetComment() [1/3]

void Aws::IoT::Model::CancelJobRequest::SetComment ( const Aws::String value)
inline

An optional comment string describing why the job was canceled.

Definition at line 136 of file CancelJobRequest.h.

◆ SetComment() [2/3]

void Aws::IoT::Model::CancelJobRequest::SetComment ( Aws::String &&  value)
inline

An optional comment string describing why the job was canceled.

Definition at line 141 of file CancelJobRequest.h.

◆ SetComment() [3/3]

void Aws::IoT::Model::CancelJobRequest::SetComment ( const char *  value)
inline

An optional comment string describing why the job was canceled.

Definition at line 146 of file CancelJobRequest.h.

◆ SetForce()

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

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

Definition at line 192 of file CancelJobRequest.h.

◆ SetJobId() [1/3]

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

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

Definition at line 54 of file CancelJobRequest.h.

◆ SetJobId() [2/3]

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

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

Definition at line 59 of file CancelJobRequest.h.

◆ SetJobId() [3/3]

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

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

Definition at line 64 of file CancelJobRequest.h.

◆ SetReasonCode() [1/3]

void Aws::IoT::Model::CancelJobRequest::SetReasonCode ( const Aws::String value)
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 95 of file CancelJobRequest.h.

◆ SetReasonCode() [2/3]

void Aws::IoT::Model::CancelJobRequest::SetReasonCode ( Aws::String &&  value)
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 100 of file CancelJobRequest.h.

◆ SetReasonCode() [3/3]

void Aws::IoT::Model::CancelJobRequest::SetReasonCode ( const char *  value)
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 105 of file CancelJobRequest.h.

◆ WithComment() [1/3]

CancelJobRequest& Aws::IoT::Model::CancelJobRequest::WithComment ( const Aws::String value)
inline

An optional comment string describing why the job was canceled.

Definition at line 151 of file CancelJobRequest.h.

◆ WithComment() [2/3]

CancelJobRequest& Aws::IoT::Model::CancelJobRequest::WithComment ( Aws::String &&  value)
inline

An optional comment string describing why the job was canceled.

Definition at line 156 of file CancelJobRequest.h.

◆ WithComment() [3/3]

CancelJobRequest& Aws::IoT::Model::CancelJobRequest::WithComment ( const char *  value)
inline

An optional comment string describing why the job was canceled.

Definition at line 161 of file CancelJobRequest.h.

◆ WithForce()

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

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

Definition at line 202 of file CancelJobRequest.h.

◆ WithJobId() [1/3]

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

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

Definition at line 69 of file CancelJobRequest.h.

◆ WithJobId() [2/3]

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

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

Definition at line 74 of file CancelJobRequest.h.

◆ WithJobId() [3/3]

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

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

Definition at line 79 of file CancelJobRequest.h.

◆ WithReasonCode() [1/3]

CancelJobRequest& Aws::IoT::Model::CancelJobRequest::WithReasonCode ( const Aws::String value)
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 110 of file CancelJobRequest.h.

◆ WithReasonCode() [2/3]

CancelJobRequest& Aws::IoT::Model::CancelJobRequest::WithReasonCode ( Aws::String &&  value)
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 115 of file CancelJobRequest.h.

◆ WithReasonCode() [3/3]

CancelJobRequest& Aws::IoT::Model::CancelJobRequest::WithReasonCode ( const char *  value)
inline

(Optional)A reason code string that explains why the job was canceled.

Definition at line 120 of file CancelJobRequest.h.


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