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

#include <JobSummary.h>

Public Member Functions

 JobSummary ()
 
 JobSummary (Aws::Utils::Json::JsonView jsonValue)
 
JobSummaryoperator= (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)
 
JobSummaryWithJobArn (const Aws::String &value)
 
JobSummaryWithJobArn (Aws::String &&value)
 
JobSummaryWithJobArn (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)
 
JobSummaryWithJobId (const Aws::String &value)
 
JobSummaryWithJobId (Aws::String &&value)
 
JobSummaryWithJobId (const char *value)
 
const Aws::StringGetThingGroupId () const
 
bool ThingGroupIdHasBeenSet () const
 
void SetThingGroupId (const Aws::String &value)
 
void SetThingGroupId (Aws::String &&value)
 
void SetThingGroupId (const char *value)
 
JobSummaryWithThingGroupId (const Aws::String &value)
 
JobSummaryWithThingGroupId (Aws::String &&value)
 
JobSummaryWithThingGroupId (const char *value)
 
const TargetSelectionGetTargetSelection () const
 
bool TargetSelectionHasBeenSet () const
 
void SetTargetSelection (const TargetSelection &value)
 
void SetTargetSelection (TargetSelection &&value)
 
JobSummaryWithTargetSelection (const TargetSelection &value)
 
JobSummaryWithTargetSelection (TargetSelection &&value)
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
JobSummaryWithStatus (const JobStatus &value)
 
JobSummaryWithStatus (JobStatus &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
JobSummaryWithCreatedAt (const Aws::Utils::DateTime &value)
 
JobSummaryWithCreatedAt (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)
 
JobSummaryWithLastUpdatedAt (const Aws::Utils::DateTime &value)
 
JobSummaryWithLastUpdatedAt (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)
 
JobSummaryWithCompletedAt (const Aws::Utils::DateTime &value)
 
JobSummaryWithCompletedAt (Aws::Utils::DateTime &&value)
 

Detailed Description

The job summary.

See Also:

AWS API Reference

Definition at line 34 of file JobSummary.h.

Constructor & Destructor Documentation

◆ JobSummary() [1/2]

Aws::IoT::Model::JobSummary::JobSummary ( )

◆ JobSummary() [2/2]

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

Member Function Documentation

◆ CompletedAtHasBeenSet()

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

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

Definition at line 328 of file JobSummary.h.

◆ CreatedAtHasBeenSet()

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

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

Definition at line 266 of file JobSummary.h.

◆ GetCompletedAt()

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

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

Definition at line 323 of file JobSummary.h.

◆ GetCreatedAt()

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

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

Definition at line 261 of file JobSummary.h.

◆ GetJobArn()

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

The job ARN.

Definition at line 46 of file JobSummary.h.

◆ GetJobId()

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

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

Definition at line 87 of file JobSummary.h.

◆ GetLastUpdatedAt()

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

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

Definition at line 292 of file JobSummary.h.

◆ GetStatus()

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

The job summary status.

Definition at line 230 of file JobSummary.h.

◆ GetTargetSelection()

const TargetSelection& Aws::IoT::Model::JobSummary::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 174 of file JobSummary.h.

◆ GetThingGroupId()

const Aws::String& Aws::IoT::Model::JobSummary::GetThingGroupId ( ) const
inline

The ID of the thing group.

Definition at line 128 of file JobSummary.h.

◆ JobArnHasBeenSet()

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

The job ARN.

Definition at line 51 of file JobSummary.h.

◆ JobIdHasBeenSet()

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

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

Definition at line 92 of file JobSummary.h.

◆ Jsonize()

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

◆ LastUpdatedAtHasBeenSet()

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

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

Definition at line 297 of file JobSummary.h.

◆ operator=()

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

◆ SetCompletedAt() [1/2]

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

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

Definition at line 338 of file JobSummary.h.

◆ SetCompletedAt() [2/2]

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

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

Definition at line 333 of file JobSummary.h.

◆ SetCreatedAt() [1/2]

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

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

Definition at line 276 of file JobSummary.h.

◆ SetCreatedAt() [2/2]

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

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

Definition at line 271 of file JobSummary.h.

◆ SetJobArn() [1/3]

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

The job ARN.

Definition at line 61 of file JobSummary.h.

◆ SetJobArn() [2/3]

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

The job ARN.

Definition at line 56 of file JobSummary.h.

◆ SetJobArn() [3/3]

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

The job ARN.

Definition at line 66 of file JobSummary.h.

◆ SetJobId() [1/3]

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

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

Definition at line 102 of file JobSummary.h.

◆ SetJobId() [2/3]

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

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

Definition at line 97 of file JobSummary.h.

◆ SetJobId() [3/3]

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

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

Definition at line 107 of file JobSummary.h.

◆ SetLastUpdatedAt() [1/2]

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

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

Definition at line 307 of file JobSummary.h.

◆ SetLastUpdatedAt() [2/2]

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

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

Definition at line 302 of file JobSummary.h.

◆ SetStatus() [1/2]

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

The job summary status.

Definition at line 240 of file JobSummary.h.

◆ SetStatus() [2/2]

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

The job summary status.

Definition at line 245 of file JobSummary.h.

◆ SetTargetSelection() [1/2]

void Aws::IoT::Model::JobSummary::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 194 of file JobSummary.h.

◆ SetTargetSelection() [2/2]

void Aws::IoT::Model::JobSummary::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 204 of file JobSummary.h.

◆ SetThingGroupId() [1/3]

void Aws::IoT::Model::JobSummary::SetThingGroupId ( Aws::String &&  value)
inline

The ID of the thing group.

Definition at line 143 of file JobSummary.h.

◆ SetThingGroupId() [2/3]

void Aws::IoT::Model::JobSummary::SetThingGroupId ( const Aws::String value)
inline

The ID of the thing group.

Definition at line 138 of file JobSummary.h.

◆ SetThingGroupId() [3/3]

void Aws::IoT::Model::JobSummary::SetThingGroupId ( const char *  value)
inline

The ID of the thing group.

Definition at line 148 of file JobSummary.h.

◆ StatusHasBeenSet()

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

The job summary status.

Definition at line 235 of file JobSummary.h.

◆ TargetSelectionHasBeenSet()

bool Aws::IoT::Model::JobSummary::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 184 of file JobSummary.h.

◆ ThingGroupIdHasBeenSet()

bool Aws::IoT::Model::JobSummary::ThingGroupIdHasBeenSet ( ) const
inline

The ID of the thing group.

Definition at line 133 of file JobSummary.h.

◆ WithCompletedAt() [1/2]

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

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

Definition at line 348 of file JobSummary.h.

◆ WithCompletedAt() [2/2]

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

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

Definition at line 343 of file JobSummary.h.

◆ WithCreatedAt() [1/2]

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

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

Definition at line 286 of file JobSummary.h.

◆ WithCreatedAt() [2/2]

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

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

Definition at line 281 of file JobSummary.h.

◆ WithJobArn() [1/3]

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

The job ARN.

Definition at line 76 of file JobSummary.h.

◆ WithJobArn() [2/3]

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

The job ARN.

Definition at line 71 of file JobSummary.h.

◆ WithJobArn() [3/3]

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

The job ARN.

Definition at line 81 of file JobSummary.h.

◆ WithJobId() [1/3]

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

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

Definition at line 117 of file JobSummary.h.

◆ WithJobId() [2/3]

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

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

Definition at line 112 of file JobSummary.h.

◆ WithJobId() [3/3]

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

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

Definition at line 122 of file JobSummary.h.

◆ WithLastUpdatedAt() [1/2]

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

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

Definition at line 317 of file JobSummary.h.

◆ WithLastUpdatedAt() [2/2]

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

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

Definition at line 312 of file JobSummary.h.

◆ WithStatus() [1/2]

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

The job summary status.

Definition at line 250 of file JobSummary.h.

◆ WithStatus() [2/2]

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

The job summary status.

Definition at line 255 of file JobSummary.h.

◆ WithTargetSelection() [1/2]

JobSummary& Aws::IoT::Model::JobSummary::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 214 of file JobSummary.h.

◆ WithTargetSelection() [2/2]

JobSummary& Aws::IoT::Model::JobSummary::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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 224 of file JobSummary.h.

◆ WithThingGroupId() [1/3]

JobSummary& Aws::IoT::Model::JobSummary::WithThingGroupId ( Aws::String &&  value)
inline

The ID of the thing group.

Definition at line 158 of file JobSummary.h.

◆ WithThingGroupId() [2/3]

JobSummary& Aws::IoT::Model::JobSummary::WithThingGroupId ( const Aws::String value)
inline

The ID of the thing group.

Definition at line 153 of file JobSummary.h.

◆ WithThingGroupId() [3/3]

JobSummary& Aws::IoT::Model::JobSummary::WithThingGroupId ( const char *  value)
inline

The ID of the thing group.

Definition at line 163 of file JobSummary.h.


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