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

#include <Job.h>

Public Member Functions

 Job ()
 
 Job (Aws::Utils::Json::JsonView jsonValue)
 
Joboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobArn () const
 
bool JobArnHasBeenSet () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
JobWithJobArn (const Aws::String &value)
 
JobWithJobArn (Aws::String &&value)
 
JobWithJobArn (const char *value)
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
JobWithJobId (const Aws::String &value)
 
JobWithJobId (Aws::String &&value)
 
JobWithJobId (const char *value)
 
const TargetSelectionGetTargetSelection () const
 
bool TargetSelectionHasBeenSet () const
 
void SetTargetSelection (const TargetSelection &value)
 
void SetTargetSelection (TargetSelection &&value)
 
JobWithTargetSelection (const TargetSelection &value)
 
JobWithTargetSelection (TargetSelection &&value)
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
JobWithStatus (const JobStatus &value)
 
JobWithStatus (JobStatus &&value)
 
bool GetForceCanceled () const
 
bool ForceCanceledHasBeenSet () const
 
void SetForceCanceled (bool value)
 
JobWithForceCanceled (bool value)
 
const Aws::StringGetReasonCode () const
 
bool ReasonCodeHasBeenSet () const
 
void SetReasonCode (const Aws::String &value)
 
void SetReasonCode (Aws::String &&value)
 
void SetReasonCode (const char *value)
 
JobWithReasonCode (const Aws::String &value)
 
JobWithReasonCode (Aws::String &&value)
 
JobWithReasonCode (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)
 
JobWithComment (const Aws::String &value)
 
JobWithComment (Aws::String &&value)
 
JobWithComment (const char *value)
 
const Aws::Vector< Aws::String > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Aws::String > &value)
 
void SetTargets (Aws::Vector< Aws::String > &&value)
 
JobWithTargets (const Aws::Vector< Aws::String > &value)
 
JobWithTargets (Aws::Vector< Aws::String > &&value)
 
JobAddTargets (const Aws::String &value)
 
JobAddTargets (Aws::String &&value)
 
JobAddTargets (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
JobWithDescription (const Aws::String &value)
 
JobWithDescription (Aws::String &&value)
 
JobWithDescription (const char *value)
 
const PresignedUrlConfigGetPresignedUrlConfig () const
 
bool PresignedUrlConfigHasBeenSet () const
 
void SetPresignedUrlConfig (const PresignedUrlConfig &value)
 
void SetPresignedUrlConfig (PresignedUrlConfig &&value)
 
JobWithPresignedUrlConfig (const PresignedUrlConfig &value)
 
JobWithPresignedUrlConfig (PresignedUrlConfig &&value)
 
const JobExecutionsRolloutConfigGetJobExecutionsRolloutConfig () const
 
bool JobExecutionsRolloutConfigHasBeenSet () const
 
void SetJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
void SetJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
JobWithJobExecutionsRolloutConfig (const JobExecutionsRolloutConfig &value)
 
JobWithJobExecutionsRolloutConfig (JobExecutionsRolloutConfig &&value)
 
const AbortConfigGetAbortConfig () const
 
bool AbortConfigHasBeenSet () const
 
void SetAbortConfig (const AbortConfig &value)
 
void SetAbortConfig (AbortConfig &&value)
 
JobWithAbortConfig (const AbortConfig &value)
 
JobWithAbortConfig (AbortConfig &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
JobWithCreatedAt (const Aws::Utils::DateTime &value)
 
JobWithCreatedAt (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)
 
JobWithLastUpdatedAt (const Aws::Utils::DateTime &value)
 
JobWithLastUpdatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCompletedAt () const
 
bool CompletedAtHasBeenSet () const
 
void SetCompletedAt (const Aws::Utils::DateTime &value)
 
void SetCompletedAt (Aws::Utils::DateTime &&value)
 
JobWithCompletedAt (const Aws::Utils::DateTime &value)
 
JobWithCompletedAt (Aws::Utils::DateTime &&value)
 
const JobProcessDetailsGetJobProcessDetails () const
 
bool JobProcessDetailsHasBeenSet () const
 
void SetJobProcessDetails (const JobProcessDetails &value)
 
void SetJobProcessDetails (JobProcessDetails &&value)
 
JobWithJobProcessDetails (const JobProcessDetails &value)
 
JobWithJobProcessDetails (JobProcessDetails &&value)
 
const TimeoutConfigGetTimeoutConfig () const
 
bool TimeoutConfigHasBeenSet () const
 
void SetTimeoutConfig (const TimeoutConfig &value)
 
void SetTimeoutConfig (TimeoutConfig &&value)
 
JobWithTimeoutConfig (const TimeoutConfig &value)
 
JobWithTimeoutConfig (TimeoutConfig &&value)
 
const Aws::StringGetNamespaceId () const
 
bool NamespaceIdHasBeenSet () const
 
void SetNamespaceId (const Aws::String &value)
 
void SetNamespaceId (Aws::String &&value)
 
void SetNamespaceId (const char *value)
 
JobWithNamespaceId (const Aws::String &value)
 
JobWithNamespaceId (Aws::String &&value)
 
JobWithNamespaceId (const char *value)
 

Detailed Description

The Job object contains details about a job.

See Also:

AWS API Reference

Definition at line 41 of file Job.h.

Constructor & Destructor Documentation

◆ Job() [1/2]

Aws::IoT::Model::Job::Job ( )

◆ Job() [2/2]

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

Member Function Documentation

◆ AbortConfigHasBeenSet()

bool Aws::IoT::Model::Job::AbortConfigHasBeenSet ( ) const
inline

Configuration for criteria to abort the job.

Definition at line 508 of file Job.h.

◆ AddTargets() [1/3]

Job& Aws::IoT::Model::Job::AddTargets ( const Aws::String value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 384 of file Job.h.

◆ AddTargets() [2/3]

Job& Aws::IoT::Model::Job::AddTargets ( Aws::String &&  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 389 of file Job.h.

◆ AddTargets() [3/3]

Job& Aws::IoT::Model::Job::AddTargets ( const char *  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 394 of file Job.h.

◆ CommentHasBeenSet()

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

If the job was updated, describes the reason for the update.

Definition at line 318 of file Job.h.

◆ CompletedAtHasBeenSet()

bool Aws::IoT::Model::Job::CompletedAtHasBeenSet ( ) const
inline

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

Definition at line 601 of file Job.h.

◆ CreatedAtHasBeenSet()

bool Aws::IoT::Model::Job::CreatedAtHasBeenSet ( ) const
inline

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

Definition at line 539 of file Job.h.

◆ DescriptionHasBeenSet()

bool Aws::IoT::Model::Job::DescriptionHasBeenSet ( ) const
inline

A short text description of the job.

Definition at line 405 of file Job.h.

◆ ForceCanceledHasBeenSet()

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

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

Definition at line 254 of file Job.h.

◆ GetAbortConfig()

const AbortConfig& Aws::IoT::Model::Job::GetAbortConfig ( ) const
inline

Configuration for criteria to abort the job.

Definition at line 503 of file Job.h.

◆ GetComment()

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

If the job was updated, describes the reason for the update.

Definition at line 313 of file Job.h.

◆ GetCompletedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::Job::GetCompletedAt ( ) const
inline

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

Definition at line 596 of file Job.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::Job::GetCreatedAt ( ) const
inline

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

Definition at line 534 of file Job.h.

◆ GetDescription()

const Aws::String& Aws::IoT::Model::Job::GetDescription ( ) const
inline

A short text description of the job.

Definition at line 400 of file Job.h.

◆ GetForceCanceled()

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

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

Definition at line 248 of file Job.h.

◆ GetJobArn()

const Aws::String& Aws::IoT::Model::Job::GetJobArn ( ) const
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 54 of file Job.h.

◆ GetJobExecutionsRolloutConfig()

const JobExecutionsRolloutConfig& Aws::IoT::Model::Job::GetJobExecutionsRolloutConfig ( ) const
inline

Allows you to create a staged rollout of a job.

Definition at line 472 of file Job.h.

◆ GetJobId()

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

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

Definition at line 102 of file Job.h.

◆ GetJobProcessDetails()

const JobProcessDetails& Aws::IoT::Model::Job::GetJobProcessDetails ( ) const
inline

Details about the job process.

Definition at line 627 of file Job.h.

◆ GetLastUpdatedAt()

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

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

Definition at line 565 of file Job.h.

◆ GetNamespaceId()

const Aws::String& Aws::IoT::Model::Job::GetNamespaceId ( ) const
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 719 of file Job.h.

◆ GetPresignedUrlConfig()

const PresignedUrlConfig& Aws::IoT::Model::Job::GetPresignedUrlConfig ( ) const
inline

Configuration for pre-signed S3 URLs.

Definition at line 441 of file Job.h.

◆ GetReasonCode()

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

If the job was updated, provides the reason code for the update.

Definition at line 272 of file Job.h.

◆ GetStatus()

const JobStatus& Aws::IoT::Model::Job::GetStatus ( ) const
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 206 of file Job.h.

◆ GetTargets()

const Aws::Vector<Aws::String>& Aws::IoT::Model::Job::GetTargets ( ) const
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 354 of file Job.h.

◆ GetTargetSelection()

const TargetSelection& Aws::IoT::Model::Job::GetTargetSelection ( ) const
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 148 of file Job.h.

◆ GetTimeoutConfig()

const TimeoutConfig& Aws::IoT::Model::Job::GetTimeoutConfig ( ) const
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 662 of file Job.h.

◆ JobArnHasBeenSet()

bool Aws::IoT::Model::Job::JobArnHasBeenSet ( ) const
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 60 of file Job.h.

◆ JobExecutionsRolloutConfigHasBeenSet()

bool Aws::IoT::Model::Job::JobExecutionsRolloutConfigHasBeenSet ( ) const
inline

Allows you to create a staged rollout of a job.

Definition at line 477 of file Job.h.

◆ JobIdHasBeenSet()

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

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

Definition at line 107 of file Job.h.

◆ JobProcessDetailsHasBeenSet()

bool Aws::IoT::Model::Job::JobProcessDetailsHasBeenSet ( ) const
inline

Details about the job process.

Definition at line 632 of file Job.h.

◆ Jsonize()

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

◆ LastUpdatedAtHasBeenSet()

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

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

Definition at line 570 of file Job.h.

◆ NamespaceIdHasBeenSet()

bool Aws::IoT::Model::Job::NamespaceIdHasBeenSet ( ) const
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 730 of file Job.h.

◆ operator=()

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

◆ PresignedUrlConfigHasBeenSet()

bool Aws::IoT::Model::Job::PresignedUrlConfigHasBeenSet ( ) const
inline

Configuration for pre-signed S3 URLs.

Definition at line 446 of file Job.h.

◆ ReasonCodeHasBeenSet()

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

If the job was updated, provides the reason code for the update.

Definition at line 277 of file Job.h.

◆ SetAbortConfig() [1/2]

void Aws::IoT::Model::Job::SetAbortConfig ( const AbortConfig value)
inline

Configuration for criteria to abort the job.

Definition at line 513 of file Job.h.

◆ SetAbortConfig() [2/2]

void Aws::IoT::Model::Job::SetAbortConfig ( AbortConfig &&  value)
inline

Configuration for criteria to abort the job.

Definition at line 518 of file Job.h.

◆ SetComment() [1/3]

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

If the job was updated, describes the reason for the update.

Definition at line 323 of file Job.h.

◆ SetComment() [2/3]

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

If the job was updated, describes the reason for the update.

Definition at line 328 of file Job.h.

◆ SetComment() [3/3]

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

If the job was updated, describes the reason for the update.

Definition at line 333 of file Job.h.

◆ SetCompletedAt() [1/2]

void Aws::IoT::Model::Job::SetCompletedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 606 of file Job.h.

◆ SetCompletedAt() [2/2]

void Aws::IoT::Model::Job::SetCompletedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 611 of file Job.h.

◆ SetCreatedAt() [1/2]

void Aws::IoT::Model::Job::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 544 of file Job.h.

◆ SetCreatedAt() [2/2]

void Aws::IoT::Model::Job::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 549 of file Job.h.

◆ SetDescription() [1/3]

void Aws::IoT::Model::Job::SetDescription ( const Aws::String value)
inline

A short text description of the job.

Definition at line 410 of file Job.h.

◆ SetDescription() [2/3]

void Aws::IoT::Model::Job::SetDescription ( Aws::String &&  value)
inline

A short text description of the job.

Definition at line 415 of file Job.h.

◆ SetDescription() [3/3]

void Aws::IoT::Model::Job::SetDescription ( const char *  value)
inline

A short text description of the job.

Definition at line 420 of file Job.h.

◆ SetForceCanceled()

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

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

Definition at line 260 of file Job.h.

◆ SetJobArn() [1/3]

void Aws::IoT::Model::Job::SetJobArn ( const Aws::String value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 66 of file Job.h.

◆ SetJobArn() [2/3]

void Aws::IoT::Model::Job::SetJobArn ( Aws::String &&  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 72 of file Job.h.

◆ SetJobArn() [3/3]

void Aws::IoT::Model::Job::SetJobArn ( const char *  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 78 of file Job.h.

◆ SetJobExecutionsRolloutConfig() [1/2]

void Aws::IoT::Model::Job::SetJobExecutionsRolloutConfig ( const JobExecutionsRolloutConfig value)
inline

Allows you to create a staged rollout of a job.

Definition at line 482 of file Job.h.

◆ SetJobExecutionsRolloutConfig() [2/2]

void Aws::IoT::Model::Job::SetJobExecutionsRolloutConfig ( JobExecutionsRolloutConfig &&  value)
inline

Allows you to create a staged rollout of a job.

Definition at line 487 of file Job.h.

◆ SetJobId() [1/3]

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

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

Definition at line 112 of file Job.h.

◆ SetJobId() [2/3]

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

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

Definition at line 117 of file Job.h.

◆ SetJobId() [3/3]

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

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

Definition at line 122 of file Job.h.

◆ SetJobProcessDetails() [1/2]

void Aws::IoT::Model::Job::SetJobProcessDetails ( const JobProcessDetails value)
inline

Details about the job process.

Definition at line 637 of file Job.h.

◆ SetJobProcessDetails() [2/2]

void Aws::IoT::Model::Job::SetJobProcessDetails ( JobProcessDetails &&  value)
inline

Details about the job process.

Definition at line 642 of file Job.h.

◆ SetLastUpdatedAt() [1/2]

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

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

Definition at line 575 of file Job.h.

◆ SetLastUpdatedAt() [2/2]

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

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

Definition at line 580 of file Job.h.

◆ SetNamespaceId() [1/3]

void Aws::IoT::Model::Job::SetNamespaceId ( const Aws::String value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 741 of file Job.h.

◆ SetNamespaceId() [2/3]

void Aws::IoT::Model::Job::SetNamespaceId ( Aws::String &&  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 752 of file Job.h.

◆ SetNamespaceId() [3/3]

void Aws::IoT::Model::Job::SetNamespaceId ( const char *  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 763 of file Job.h.

◆ SetPresignedUrlConfig() [1/2]

void Aws::IoT::Model::Job::SetPresignedUrlConfig ( const PresignedUrlConfig value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 451 of file Job.h.

◆ SetPresignedUrlConfig() [2/2]

void Aws::IoT::Model::Job::SetPresignedUrlConfig ( PresignedUrlConfig &&  value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 456 of file Job.h.

◆ SetReasonCode() [1/3]

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

If the job was updated, provides the reason code for the update.

Definition at line 282 of file Job.h.

◆ SetReasonCode() [2/3]

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

If the job was updated, provides the reason code for the update.

Definition at line 287 of file Job.h.

◆ SetReasonCode() [3/3]

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

If the job was updated, provides the reason code for the update.

Definition at line 292 of file Job.h.

◆ SetStatus() [1/2]

void Aws::IoT::Model::Job::SetStatus ( const JobStatus value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 220 of file Job.h.

◆ SetStatus() [2/2]

void Aws::IoT::Model::Job::SetStatus ( JobStatus &&  value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 227 of file Job.h.

◆ SetTargets() [1/2]

void Aws::IoT::Model::Job::SetTargets ( const Aws::Vector< Aws::String > &  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 364 of file Job.h.

◆ SetTargets() [2/2]

void Aws::IoT::Model::Job::SetTargets ( Aws::Vector< Aws::String > &&  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 369 of file Job.h.

◆ SetTargetSelection() [1/2]

void Aws::IoT::Model::Job::SetTargetSelection ( const TargetSelection value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 168 of file Job.h.

◆ SetTargetSelection() [2/2]

void Aws::IoT::Model::Job::SetTargetSelection ( TargetSelection &&  value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 178 of file Job.h.

◆ SetTimeoutConfig() [1/2]

void Aws::IoT::Model::Job::SetTimeoutConfig ( const TimeoutConfig value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 680 of file Job.h.

◆ SetTimeoutConfig() [2/2]

void Aws::IoT::Model::Job::SetTimeoutConfig ( TimeoutConfig &&  value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 689 of file Job.h.

◆ StatusHasBeenSet()

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

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 213 of file Job.h.

◆ TargetSelectionHasBeenSet()

bool Aws::IoT::Model::Job::TargetSelectionHasBeenSet ( ) const
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 158 of file Job.h.

◆ TargetsHasBeenSet()

bool Aws::IoT::Model::Job::TargetsHasBeenSet ( ) const
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 359 of file Job.h.

◆ TimeoutConfigHasBeenSet()

bool Aws::IoT::Model::Job::TimeoutConfigHasBeenSet ( ) const
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 671 of file Job.h.

◆ WithAbortConfig() [1/2]

Job& Aws::IoT::Model::Job::WithAbortConfig ( const AbortConfig value)
inline

Configuration for criteria to abort the job.

Definition at line 523 of file Job.h.

◆ WithAbortConfig() [2/2]

Job& Aws::IoT::Model::Job::WithAbortConfig ( AbortConfig &&  value)
inline

Configuration for criteria to abort the job.

Definition at line 528 of file Job.h.

◆ WithComment() [1/3]

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

If the job was updated, describes the reason for the update.

Definition at line 338 of file Job.h.

◆ WithComment() [2/3]

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

If the job was updated, describes the reason for the update.

Definition at line 343 of file Job.h.

◆ WithComment() [3/3]

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

If the job was updated, describes the reason for the update.

Definition at line 348 of file Job.h.

◆ WithCompletedAt() [1/2]

Job& Aws::IoT::Model::Job::WithCompletedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 616 of file Job.h.

◆ WithCompletedAt() [2/2]

Job& Aws::IoT::Model::Job::WithCompletedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 621 of file Job.h.

◆ WithCreatedAt() [1/2]

Job& Aws::IoT::Model::Job::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 554 of file Job.h.

◆ WithCreatedAt() [2/2]

Job& Aws::IoT::Model::Job::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 559 of file Job.h.

◆ WithDescription() [1/3]

Job& Aws::IoT::Model::Job::WithDescription ( const Aws::String value)
inline

A short text description of the job.

Definition at line 425 of file Job.h.

◆ WithDescription() [2/3]

Job& Aws::IoT::Model::Job::WithDescription ( Aws::String &&  value)
inline

A short text description of the job.

Definition at line 430 of file Job.h.

◆ WithDescription() [3/3]

Job& Aws::IoT::Model::Job::WithDescription ( const char *  value)
inline

A short text description of the job.

Definition at line 435 of file Job.h.

◆ WithForceCanceled()

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

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

Definition at line 266 of file Job.h.

◆ WithJobArn() [1/3]

Job& Aws::IoT::Model::Job::WithJobArn ( const Aws::String value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 84 of file Job.h.

◆ WithJobArn() [2/3]

Job& Aws::IoT::Model::Job::WithJobArn ( Aws::String &&  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 90 of file Job.h.

◆ WithJobArn() [3/3]

Job& Aws::IoT::Model::Job::WithJobArn ( const char *  value)
inline

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Definition at line 96 of file Job.h.

◆ WithJobExecutionsRolloutConfig() [1/2]

Job& Aws::IoT::Model::Job::WithJobExecutionsRolloutConfig ( const JobExecutionsRolloutConfig value)
inline

Allows you to create a staged rollout of a job.

Definition at line 492 of file Job.h.

◆ WithJobExecutionsRolloutConfig() [2/2]

Job& Aws::IoT::Model::Job::WithJobExecutionsRolloutConfig ( JobExecutionsRolloutConfig &&  value)
inline

Allows you to create a staged rollout of a job.

Definition at line 497 of file Job.h.

◆ WithJobId() [1/3]

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

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

Definition at line 127 of file Job.h.

◆ WithJobId() [2/3]

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

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

Definition at line 132 of file Job.h.

◆ WithJobId() [3/3]

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

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

Definition at line 137 of file Job.h.

◆ WithJobProcessDetails() [1/2]

Job& Aws::IoT::Model::Job::WithJobProcessDetails ( const JobProcessDetails value)
inline

Details about the job process.

Definition at line 647 of file Job.h.

◆ WithJobProcessDetails() [2/2]

Job& Aws::IoT::Model::Job::WithJobProcessDetails ( JobProcessDetails &&  value)
inline

Details about the job process.

Definition at line 652 of file Job.h.

◆ WithLastUpdatedAt() [1/2]

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

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

Definition at line 585 of file Job.h.

◆ WithLastUpdatedAt() [2/2]

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

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

Definition at line 590 of file Job.h.

◆ WithNamespaceId() [1/3]

Job& Aws::IoT::Model::Job::WithNamespaceId ( const Aws::String value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 774 of file Job.h.

◆ WithNamespaceId() [2/3]

Job& Aws::IoT::Model::Job::WithNamespaceId ( Aws::String &&  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 785 of file Job.h.

◆ WithNamespaceId() [3/3]

Job& Aws::IoT::Model::Job::WithNamespaceId ( const char *  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 796 of file Job.h.

◆ WithPresignedUrlConfig() [1/2]

Job& Aws::IoT::Model::Job::WithPresignedUrlConfig ( const PresignedUrlConfig value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 461 of file Job.h.

◆ WithPresignedUrlConfig() [2/2]

Job& Aws::IoT::Model::Job::WithPresignedUrlConfig ( PresignedUrlConfig &&  value)
inline

Configuration for pre-signed S3 URLs.

Definition at line 466 of file Job.h.

◆ WithReasonCode() [1/3]

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

If the job was updated, provides the reason code for the update.

Definition at line 297 of file Job.h.

◆ WithReasonCode() [2/3]

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

If the job was updated, provides the reason code for the update.

Definition at line 302 of file Job.h.

◆ WithReasonCode() [3/3]

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

If the job was updated, provides the reason code for the update.

Definition at line 307 of file Job.h.

◆ WithStatus() [1/2]

Job& Aws::IoT::Model::Job::WithStatus ( const JobStatus value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 234 of file Job.h.

◆ WithStatus() [2/2]

Job& Aws::IoT::Model::Job::WithStatus ( JobStatus &&  value)
inline

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Definition at line 241 of file Job.h.

◆ WithTargets() [1/2]

Job& Aws::IoT::Model::Job::WithTargets ( const Aws::Vector< Aws::String > &  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 374 of file Job.h.

◆ WithTargets() [2/2]

Job& Aws::IoT::Model::Job::WithTargets ( Aws::Vector< Aws::String > &&  value)
inline

A list of IoT things and thing groups to which the job should be sent.

Definition at line 379 of file Job.h.

◆ WithTargetSelection() [1/2]

Job& Aws::IoT::Model::Job::WithTargetSelection ( const TargetSelection value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 188 of file Job.h.

◆ WithTargetSelection() [2/2]

Job& Aws::IoT::Model::Job::WithTargetSelection ( TargetSelection &&  value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 198 of file Job.h.

◆ WithTimeoutConfig() [1/2]

Job& Aws::IoT::Model::Job::WithTimeoutConfig ( const TimeoutConfig value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 698 of file Job.h.

◆ WithTimeoutConfig() [2/2]

Job& Aws::IoT::Model::Job::WithTimeoutConfig ( TimeoutConfig &&  value)
inline

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Definition at line 707 of file Job.h.


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