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

#include <StartNextPendingJobExecutionRequest.h>

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

Public Member Functions

 StartNextPendingJobExecutionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetThingName () const
 
bool ThingNameHasBeenSet () const
 
void SetThingName (const Aws::String &value)
 
void SetThingName (Aws::String &&value)
 
void SetThingName (const char *value)
 
StartNextPendingJobExecutionRequestWithThingName (const Aws::String &value)
 
StartNextPendingJobExecutionRequestWithThingName (Aws::String &&value)
 
StartNextPendingJobExecutionRequestWithThingName (const char *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)
 
StartNextPendingJobExecutionRequestWithStatusDetails (const Aws::Map< Aws::String, Aws::String > &value)
 
StartNextPendingJobExecutionRequestWithStatusDetails (Aws::Map< Aws::String, Aws::String > &&value)
 
StartNextPendingJobExecutionRequestAddStatusDetails (const Aws::String &key, const Aws::String &value)
 
StartNextPendingJobExecutionRequestAddStatusDetails (Aws::String &&key, const Aws::String &value)
 
StartNextPendingJobExecutionRequestAddStatusDetails (const Aws::String &key, Aws::String &&value)
 
StartNextPendingJobExecutionRequestAddStatusDetails (Aws::String &&key, Aws::String &&value)
 
StartNextPendingJobExecutionRequestAddStatusDetails (const char *key, Aws::String &&value)
 
StartNextPendingJobExecutionRequestAddStatusDetails (Aws::String &&key, const char *value)
 
StartNextPendingJobExecutionRequestAddStatusDetails (const char *key, const char *value)
 
long long GetStepTimeoutInMinutes () const
 
bool StepTimeoutInMinutesHasBeenSet () const
 
void SetStepTimeoutInMinutes (long long value)
 
StartNextPendingJobExecutionRequestWithStepTimeoutInMinutes (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 22 of file StartNextPendingJobExecutionRequest.h.

Constructor & Destructor Documentation

◆ StartNextPendingJobExecutionRequest()

Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::StartNextPendingJobExecutionRequest ( )

Member Function Documentation

◆ AddStatusDetails() [1/7]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 135 of file StartNextPendingJobExecutionRequest.h.

◆ AddStatusDetails() [2/7]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 123 of file StartNextPendingJobExecutionRequest.h.

◆ AddStatusDetails() [3/7]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 147 of file StartNextPendingJobExecutionRequest.h.

◆ AddStatusDetails() [4/7]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 129 of file StartNextPendingJobExecutionRequest.h.

◆ AddStatusDetails() [5/7]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 117 of file StartNextPendingJobExecutionRequest.h.

◆ AddStatusDetails() [6/7]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 141 of file StartNextPendingJobExecutionRequest.h.

◆ AddStatusDetails() [7/7]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 153 of file StartNextPendingJobExecutionRequest.h.

◆ GetServiceRequestName()

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

◆ GetStatusDetails()

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

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

Definition at line 81 of file StartNextPendingJobExecutionRequest.h.

◆ GetStepTimeoutInMinutes()

long long Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 167 of file StartNextPendingJobExecutionRequest.h.

◆ GetThingName()

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

The name of the thing associated with the device.

Definition at line 39 of file StartNextPendingJobExecutionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetStatusDetails() [1/2]

void Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 99 of file StartNextPendingJobExecutionRequest.h.

◆ SetStatusDetails() [2/2]

void Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 93 of file StartNextPendingJobExecutionRequest.h.

◆ SetStepTimeoutInMinutes()

void Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 193 of file StartNextPendingJobExecutionRequest.h.

◆ SetThingName() [1/3]

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

The name of the thing associated with the device.

Definition at line 54 of file StartNextPendingJobExecutionRequest.h.

◆ SetThingName() [2/3]

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

The name of the thing associated with the device.

Definition at line 49 of file StartNextPendingJobExecutionRequest.h.

◆ SetThingName() [3/3]

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

The name of the thing associated with the device.

Definition at line 59 of file StartNextPendingJobExecutionRequest.h.

◆ StatusDetailsHasBeenSet()

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

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

Definition at line 87 of file StartNextPendingJobExecutionRequest.h.

◆ StepTimeoutInMinutesHasBeenSet()

bool Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 180 of file StartNextPendingJobExecutionRequest.h.

◆ ThingNameHasBeenSet()

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

The name of the thing associated with the device.

Definition at line 44 of file StartNextPendingJobExecutionRequest.h.

◆ WithStatusDetails() [1/2]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 111 of file StartNextPendingJobExecutionRequest.h.

◆ WithStatusDetails() [2/2]

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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.

Definition at line 105 of file StartNextPendingJobExecutionRequest.h.

◆ WithStepTimeoutInMinutes()

StartNextPendingJobExecutionRequest& Aws::IoTJobsDataPlane::Model::StartNextPendingJobExecutionRequest::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 calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting 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 206 of file StartNextPendingJobExecutionRequest.h.

◆ WithThingName() [1/3]

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

The name of the thing associated with the device.

Definition at line 69 of file StartNextPendingJobExecutionRequest.h.

◆ WithThingName() [2/3]

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

The name of the thing associated with the device.

Definition at line 64 of file StartNextPendingJobExecutionRequest.h.

◆ WithThingName() [3/3]

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

The name of the thing associated with the device.

Definition at line 74 of file StartNextPendingJobExecutionRequest.h.


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