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

#include <JobExecution.h>

Public Member Functions

 JobExecution ()
 
 JobExecution (Aws::Utils::Json::JsonView jsonValue)
 
JobExecutionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
JobExecutionWithJobId (const Aws::String &value)
 
JobExecutionWithJobId (Aws::String &&value)
 
JobExecutionWithJobId (const char *value)
 
const JobExecutionStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobExecutionStatus &value)
 
void SetStatus (JobExecutionStatus &&value)
 
JobExecutionWithStatus (const JobExecutionStatus &value)
 
JobExecutionWithStatus (JobExecutionStatus &&value)
 
bool GetForceCanceled () const
 
bool ForceCanceledHasBeenSet () const
 
void SetForceCanceled (bool value)
 
JobExecutionWithForceCanceled (bool value)
 
const JobExecutionStatusDetailsGetStatusDetails () const
 
bool StatusDetailsHasBeenSet () const
 
void SetStatusDetails (const JobExecutionStatusDetails &value)
 
void SetStatusDetails (JobExecutionStatusDetails &&value)
 
JobExecutionWithStatusDetails (const JobExecutionStatusDetails &value)
 
JobExecutionWithStatusDetails (JobExecutionStatusDetails &&value)
 
const Aws::StringGetThingArn () const
 
bool ThingArnHasBeenSet () const
 
void SetThingArn (const Aws::String &value)
 
void SetThingArn (Aws::String &&value)
 
void SetThingArn (const char *value)
 
JobExecutionWithThingArn (const Aws::String &value)
 
JobExecutionWithThingArn (Aws::String &&value)
 
JobExecutionWithThingArn (const char *value)
 
const Aws::Utils::DateTimeGetQueuedAt () const
 
bool QueuedAtHasBeenSet () const
 
void SetQueuedAt (const Aws::Utils::DateTime &value)
 
void SetQueuedAt (Aws::Utils::DateTime &&value)
 
JobExecutionWithQueuedAt (const Aws::Utils::DateTime &value)
 
JobExecutionWithQueuedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetStartedAt () const
 
bool StartedAtHasBeenSet () const
 
void SetStartedAt (const Aws::Utils::DateTime &value)
 
void SetStartedAt (Aws::Utils::DateTime &&value)
 
JobExecutionWithStartedAt (const Aws::Utils::DateTime &value)
 
JobExecutionWithStartedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedAt () const
 
bool LastUpdatedAtHasBeenSet () const
 
void SetLastUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedAt (Aws::Utils::DateTime &&value)
 
JobExecutionWithLastUpdatedAt (const Aws::Utils::DateTime &value)
 
JobExecutionWithLastUpdatedAt (Aws::Utils::DateTime &&value)
 
long long GetExecutionNumber () const
 
bool ExecutionNumberHasBeenSet () const
 
void SetExecutionNumber (long long value)
 
JobExecutionWithExecutionNumber (long long value)
 
long long GetVersionNumber () const
 
bool VersionNumberHasBeenSet () const
 
void SetVersionNumber (long long value)
 
JobExecutionWithVersionNumber (long long value)
 
long long GetApproximateSecondsBeforeTimedOut () const
 
bool ApproximateSecondsBeforeTimedOutHasBeenSet () const
 
void SetApproximateSecondsBeforeTimedOut (long long value)
 
JobExecutionWithApproximateSecondsBeforeTimedOut (long long value)
 

Detailed Description

The job execution object represents the execution of a job on a particular device.

See Also:

AWS API Reference

Definition at line 35 of file JobExecution.h.

Constructor & Destructor Documentation

◆ JobExecution() [1/2]

Aws::IoT::Model::JobExecution::JobExecution ( )

◆ JobExecution() [2/2]

Aws::IoT::Model::JobExecution::JobExecution ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ApproximateSecondsBeforeTimedOutHasBeenSet()

bool Aws::IoT::Model::JobExecution::ApproximateSecondsBeforeTimedOutHasBeenSet ( ) const
inline

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

Definition at line 394 of file JobExecution.h.

◆ ExecutionNumberHasBeenSet()

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

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

Definition at line 336 of file JobExecution.h.

◆ ForceCanceledHasBeenSet()

bool Aws::IoT::Model::JobExecution::ForceCanceledHasBeenSet ( ) const
inline

Will be true if the job execution was canceled with the optional force parameter set to true.

Definition at line 132 of file JobExecution.h.

◆ GetApproximateSecondsBeforeTimedOut()

long long Aws::IoT::Model::JobExecution::GetApproximateSecondsBeforeTimedOut ( ) const
inline

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

Definition at line 385 of file JobExecution.h.

◆ GetExecutionNumber()

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

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

Definition at line 329 of file JobExecution.h.

◆ GetForceCanceled()

bool Aws::IoT::Model::JobExecution::GetForceCanceled ( ) const
inline

Will be true if the job execution was canceled with the optional force parameter set to true.

Definition at line 126 of file JobExecution.h.

◆ GetJobId()

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

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

Definition at line 47 of file JobExecution.h.

◆ GetLastUpdatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::JobExecution::GetLastUpdatedAt ( ) const
inline

The time, in seconds since the epoch, when the job execution was last updated.

Definition at line 291 of file JobExecution.h.

◆ GetQueuedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::JobExecution::GetQueuedAt ( ) const
inline

The time, in seconds since the epoch, when the job execution was queued.

Definition at line 228 of file JobExecution.h.

◆ GetStartedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::JobExecution::GetStartedAt ( ) const
inline

The time, in seconds since the epoch, when the job execution started.

Definition at line 259 of file JobExecution.h.

◆ GetStatus()

const JobExecutionStatus& Aws::IoT::Model::JobExecution::GetStatus ( ) const
inline

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

Definition at line 89 of file JobExecution.h.

◆ GetStatusDetails()

const JobExecutionStatusDetails& Aws::IoT::Model::JobExecution::GetStatusDetails ( ) const
inline

A collection of name/value pairs that describe the status of the job execution.

Definition at line 151 of file JobExecution.h.

◆ GetThingArn()

const Aws::String& Aws::IoT::Model::JobExecution::GetThingArn ( ) const
inline

The ARN of the thing on which the job execution is running.

Definition at line 187 of file JobExecution.h.

◆ GetVersionNumber()

long long Aws::IoT::Model::JobExecution::GetVersionNumber ( ) const
inline

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Definition at line 357 of file JobExecution.h.

◆ JobIdHasBeenSet()

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

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

Definition at line 52 of file JobExecution.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::JobExecution::Jsonize ( ) const

◆ LastUpdatedAtHasBeenSet()

bool Aws::IoT::Model::JobExecution::LastUpdatedAtHasBeenSet ( ) const
inline

The time, in seconds since the epoch, when the job execution was last updated.

Definition at line 297 of file JobExecution.h.

◆ operator=()

JobExecution& Aws::IoT::Model::JobExecution::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ QueuedAtHasBeenSet()

bool Aws::IoT::Model::JobExecution::QueuedAtHasBeenSet ( ) const
inline

The time, in seconds since the epoch, when the job execution was queued.

Definition at line 233 of file JobExecution.h.

◆ SetApproximateSecondsBeforeTimedOut()

void Aws::IoT::Model::JobExecution::SetApproximateSecondsBeforeTimedOut ( long long  value)
inline

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

Definition at line 403 of file JobExecution.h.

◆ SetExecutionNumber()

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

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

Definition at line 343 of file JobExecution.h.

◆ SetForceCanceled()

void Aws::IoT::Model::JobExecution::SetForceCanceled ( bool  value)
inline

Will be true if the job execution was canceled with the optional force parameter set to true.

Definition at line 138 of file JobExecution.h.

◆ SetJobId() [1/3]

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

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

Definition at line 62 of file JobExecution.h.

◆ SetJobId() [2/3]

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

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

Definition at line 57 of file JobExecution.h.

◆ SetJobId() [3/3]

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

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

Definition at line 67 of file JobExecution.h.

◆ SetLastUpdatedAt() [1/2]

void Aws::IoT::Model::JobExecution::SetLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job execution was last updated.

Definition at line 309 of file JobExecution.h.

◆ SetLastUpdatedAt() [2/2]

void Aws::IoT::Model::JobExecution::SetLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job execution was last updated.

Definition at line 303 of file JobExecution.h.

◆ SetQueuedAt() [1/2]

void Aws::IoT::Model::JobExecution::SetQueuedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job execution was queued.

Definition at line 243 of file JobExecution.h.

◆ SetQueuedAt() [2/2]

void Aws::IoT::Model::JobExecution::SetQueuedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job execution was queued.

Definition at line 238 of file JobExecution.h.

◆ SetStartedAt() [1/2]

void Aws::IoT::Model::JobExecution::SetStartedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job execution started.

Definition at line 274 of file JobExecution.h.

◆ SetStartedAt() [2/2]

void Aws::IoT::Model::JobExecution::SetStartedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job execution started.

Definition at line 269 of file JobExecution.h.

◆ SetStatus() [1/2]

void Aws::IoT::Model::JobExecution::SetStatus ( const JobExecutionStatus value)
inline

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

Definition at line 101 of file JobExecution.h.

◆ SetStatus() [2/2]

void Aws::IoT::Model::JobExecution::SetStatus ( JobExecutionStatus &&  value)
inline

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

Definition at line 107 of file JobExecution.h.

◆ SetStatusDetails() [1/2]

void Aws::IoT::Model::JobExecution::SetStatusDetails ( const JobExecutionStatusDetails value)
inline

A collection of name/value pairs that describe the status of the job execution.

Definition at line 163 of file JobExecution.h.

◆ SetStatusDetails() [2/2]

void Aws::IoT::Model::JobExecution::SetStatusDetails ( JobExecutionStatusDetails &&  value)
inline

A collection of name/value pairs that describe the status of the job execution.

Definition at line 169 of file JobExecution.h.

◆ SetThingArn() [1/3]

void Aws::IoT::Model::JobExecution::SetThingArn ( Aws::String &&  value)
inline

The ARN of the thing on which the job execution is running.

Definition at line 202 of file JobExecution.h.

◆ SetThingArn() [2/3]

void Aws::IoT::Model::JobExecution::SetThingArn ( const Aws::String value)
inline

The ARN of the thing on which the job execution is running.

Definition at line 197 of file JobExecution.h.

◆ SetThingArn() [3/3]

void Aws::IoT::Model::JobExecution::SetThingArn ( const char *  value)
inline

The ARN of the thing on which the job execution is running.

Definition at line 207 of file JobExecution.h.

◆ SetVersionNumber()

void Aws::IoT::Model::JobExecution::SetVersionNumber ( long long  value)
inline

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Definition at line 369 of file JobExecution.h.

◆ StartedAtHasBeenSet()

bool Aws::IoT::Model::JobExecution::StartedAtHasBeenSet ( ) const
inline

The time, in seconds since the epoch, when the job execution started.

Definition at line 264 of file JobExecution.h.

◆ StatusDetailsHasBeenSet()

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

A collection of name/value pairs that describe the status of the job execution.

Definition at line 157 of file JobExecution.h.

◆ StatusHasBeenSet()

bool Aws::IoT::Model::JobExecution::StatusHasBeenSet ( ) const
inline

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

Definition at line 95 of file JobExecution.h.

◆ ThingArnHasBeenSet()

bool Aws::IoT::Model::JobExecution::ThingArnHasBeenSet ( ) const
inline

The ARN of the thing on which the job execution is running.

Definition at line 192 of file JobExecution.h.

◆ VersionNumberHasBeenSet()

bool Aws::IoT::Model::JobExecution::VersionNumberHasBeenSet ( ) const
inline

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Definition at line 363 of file JobExecution.h.

◆ WithApproximateSecondsBeforeTimedOut()

JobExecution& Aws::IoT::Model::JobExecution::WithApproximateSecondsBeforeTimedOut ( long long  value)
inline

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

Definition at line 412 of file JobExecution.h.

◆ WithExecutionNumber()

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

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

Definition at line 350 of file JobExecution.h.

◆ WithForceCanceled()

JobExecution& Aws::IoT::Model::JobExecution::WithForceCanceled ( bool  value)
inline

Will be true if the job execution was canceled with the optional force parameter set to true.

Definition at line 144 of file JobExecution.h.

◆ WithJobId() [1/3]

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

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

Definition at line 77 of file JobExecution.h.

◆ WithJobId() [2/3]

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

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

Definition at line 72 of file JobExecution.h.

◆ WithJobId() [3/3]

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

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

Definition at line 82 of file JobExecution.h.

◆ WithLastUpdatedAt() [1/2]

JobExecution& Aws::IoT::Model::JobExecution::WithLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job execution was last updated.

Definition at line 321 of file JobExecution.h.

◆ WithLastUpdatedAt() [2/2]

JobExecution& Aws::IoT::Model::JobExecution::WithLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job execution was last updated.

Definition at line 315 of file JobExecution.h.

◆ WithQueuedAt() [1/2]

JobExecution& Aws::IoT::Model::JobExecution::WithQueuedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job execution was queued.

Definition at line 253 of file JobExecution.h.

◆ WithQueuedAt() [2/2]

JobExecution& Aws::IoT::Model::JobExecution::WithQueuedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job execution was queued.

Definition at line 248 of file JobExecution.h.

◆ WithStartedAt() [1/2]

JobExecution& Aws::IoT::Model::JobExecution::WithStartedAt ( Aws::Utils::DateTime &&  value)
inline

The time, in seconds since the epoch, when the job execution started.

Definition at line 284 of file JobExecution.h.

◆ WithStartedAt() [2/2]

JobExecution& Aws::IoT::Model::JobExecution::WithStartedAt ( const Aws::Utils::DateTime value)
inline

The time, in seconds since the epoch, when the job execution started.

Definition at line 279 of file JobExecution.h.

◆ WithStatus() [1/2]

JobExecution& Aws::IoT::Model::JobExecution::WithStatus ( const JobExecutionStatus value)
inline

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

Definition at line 113 of file JobExecution.h.

◆ WithStatus() [2/2]

JobExecution& Aws::IoT::Model::JobExecution::WithStatus ( JobExecutionStatus &&  value)
inline

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

Definition at line 119 of file JobExecution.h.

◆ WithStatusDetails() [1/2]

JobExecution& Aws::IoT::Model::JobExecution::WithStatusDetails ( const JobExecutionStatusDetails value)
inline

A collection of name/value pairs that describe the status of the job execution.

Definition at line 175 of file JobExecution.h.

◆ WithStatusDetails() [2/2]

JobExecution& Aws::IoT::Model::JobExecution::WithStatusDetails ( JobExecutionStatusDetails &&  value)
inline

A collection of name/value pairs that describe the status of the job execution.

Definition at line 181 of file JobExecution.h.

◆ WithThingArn() [1/3]

JobExecution& Aws::IoT::Model::JobExecution::WithThingArn ( Aws::String &&  value)
inline

The ARN of the thing on which the job execution is running.

Definition at line 217 of file JobExecution.h.

◆ WithThingArn() [2/3]

JobExecution& Aws::IoT::Model::JobExecution::WithThingArn ( const Aws::String value)
inline

The ARN of the thing on which the job execution is running.

Definition at line 212 of file JobExecution.h.

◆ WithThingArn() [3/3]

JobExecution& Aws::IoT::Model::JobExecution::WithThingArn ( const char *  value)
inline

The ARN of the thing on which the job execution is running.

Definition at line 222 of file JobExecution.h.

◆ WithVersionNumber()

JobExecution& Aws::IoT::Model::JobExecution::WithVersionNumber ( long long  value)
inline

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Definition at line 375 of file JobExecution.h.


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