AWS SDK for C++  1.8.99
AWS SDK for C++
Public Member Functions | List of all members
Aws::Snowball::Model::JobListEntry Class Reference

#include <JobListEntry.h>

Public Member Functions

 JobListEntry ()
 
 JobListEntry (Aws::Utils::Json::JsonView jsonValue)
 
JobListEntryoperator= (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)
 
JobListEntryWithJobId (const Aws::String &value)
 
JobListEntryWithJobId (Aws::String &&value)
 
JobListEntryWithJobId (const char *value)
 
const JobStateGetJobState () const
 
bool JobStateHasBeenSet () const
 
void SetJobState (const JobState &value)
 
void SetJobState (JobState &&value)
 
JobListEntryWithJobState (const JobState &value)
 
JobListEntryWithJobState (JobState &&value)
 
bool GetIsMaster () const
 
bool IsMasterHasBeenSet () const
 
void SetIsMaster (bool value)
 
JobListEntryWithIsMaster (bool value)
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
JobListEntryWithJobType (const JobType &value)
 
JobListEntryWithJobType (JobType &&value)
 
const SnowballTypeGetSnowballType () const
 
bool SnowballTypeHasBeenSet () const
 
void SetSnowballType (const SnowballType &value)
 
void SetSnowballType (SnowballType &&value)
 
JobListEntryWithSnowballType (const SnowballType &value)
 
JobListEntryWithSnowballType (SnowballType &&value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
JobListEntryWithCreationDate (const Aws::Utils::DateTime &value)
 
JobListEntryWithCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
JobListEntryWithDescription (const Aws::String &value)
 
JobListEntryWithDescription (Aws::String &&value)
 
JobListEntryWithDescription (const char *value)
 

Detailed Description

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of an export job.

See Also:

AWS API Reference

Definition at line 37 of file JobListEntry.h.

Constructor & Destructor Documentation

◆ JobListEntry() [1/2]

Aws::Snowball::Model::JobListEntry::JobListEntry ( )

◆ JobListEntry() [2/2]

Aws::Snowball::Model::JobListEntry::JobListEntry ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreationDateHasBeenSet()

bool Aws::Snowball::Model::JobListEntry::CreationDateHasBeenSet ( ) const
inline

The creation date for this job.

Definition at line 237 of file JobListEntry.h.

◆ DescriptionHasBeenSet()

bool Aws::Snowball::Model::JobListEntry::DescriptionHasBeenSet ( ) const
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 270 of file JobListEntry.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::Snowball::Model::JobListEntry::GetCreationDate ( ) const
inline

The creation date for this job.

Definition at line 232 of file JobListEntry.h.

◆ GetDescription()

const Aws::String& Aws::Snowball::Model::JobListEntry::GetDescription ( ) const
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 264 of file JobListEntry.h.

◆ GetIsMaster()

bool Aws::Snowball::Model::JobListEntry::GetIsMaster ( ) const
inline

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

Definition at line 134 of file JobListEntry.h.

◆ GetJobId()

const Aws::String& Aws::Snowball::Model::JobListEntry::GetJobId ( ) const
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 50 of file JobListEntry.h.

◆ GetJobState()

const JobState& Aws::Snowball::Model::JobListEntry::GetJobState ( ) const
inline

The current state of this job.

Definition at line 98 of file JobListEntry.h.

◆ GetJobType()

const JobType& Aws::Snowball::Model::JobListEntry::GetJobType ( ) const
inline

The type of job.

Definition at line 170 of file JobListEntry.h.

◆ GetSnowballType()

const SnowballType& Aws::Snowball::Model::JobListEntry::GetSnowballType ( ) const
inline

The type of device used with this job.

Definition at line 201 of file JobListEntry.h.

◆ IsMasterHasBeenSet()

bool Aws::Snowball::Model::JobListEntry::IsMasterHasBeenSet ( ) const
inline

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

Definition at line 144 of file JobListEntry.h.

◆ JobIdHasBeenSet()

bool Aws::Snowball::Model::JobListEntry::JobIdHasBeenSet ( ) const
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 56 of file JobListEntry.h.

◆ JobStateHasBeenSet()

bool Aws::Snowball::Model::JobListEntry::JobStateHasBeenSet ( ) const
inline

The current state of this job.

Definition at line 103 of file JobListEntry.h.

◆ JobTypeHasBeenSet()

bool Aws::Snowball::Model::JobListEntry::JobTypeHasBeenSet ( ) const
inline

The type of job.

Definition at line 175 of file JobListEntry.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Snowball::Model::JobListEntry::Jsonize ( ) const

◆ operator=()

JobListEntry& Aws::Snowball::Model::JobListEntry::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCreationDate() [1/2]

void Aws::Snowball::Model::JobListEntry::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The creation date for this job.

Definition at line 242 of file JobListEntry.h.

◆ SetCreationDate() [2/2]

void Aws::Snowball::Model::JobListEntry::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The creation date for this job.

Definition at line 247 of file JobListEntry.h.

◆ SetDescription() [1/3]

void Aws::Snowball::Model::JobListEntry::SetDescription ( const Aws::String value)
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 276 of file JobListEntry.h.

◆ SetDescription() [2/3]

void Aws::Snowball::Model::JobListEntry::SetDescription ( Aws::String &&  value)
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 282 of file JobListEntry.h.

◆ SetDescription() [3/3]

void Aws::Snowball::Model::JobListEntry::SetDescription ( const char *  value)
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 288 of file JobListEntry.h.

◆ SetIsMaster()

void Aws::Snowball::Model::JobListEntry::SetIsMaster ( bool  value)
inline

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

Definition at line 154 of file JobListEntry.h.

◆ SetJobId() [1/3]

void Aws::Snowball::Model::JobListEntry::SetJobId ( const Aws::String value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 62 of file JobListEntry.h.

◆ SetJobId() [2/3]

void Aws::Snowball::Model::JobListEntry::SetJobId ( Aws::String &&  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 68 of file JobListEntry.h.

◆ SetJobId() [3/3]

void Aws::Snowball::Model::JobListEntry::SetJobId ( const char *  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 74 of file JobListEntry.h.

◆ SetJobState() [1/2]

void Aws::Snowball::Model::JobListEntry::SetJobState ( const JobState value)
inline

The current state of this job.

Definition at line 108 of file JobListEntry.h.

◆ SetJobState() [2/2]

void Aws::Snowball::Model::JobListEntry::SetJobState ( JobState &&  value)
inline

The current state of this job.

Definition at line 113 of file JobListEntry.h.

◆ SetJobType() [1/2]

void Aws::Snowball::Model::JobListEntry::SetJobType ( const JobType value)
inline

The type of job.

Definition at line 180 of file JobListEntry.h.

◆ SetJobType() [2/2]

void Aws::Snowball::Model::JobListEntry::SetJobType ( JobType &&  value)
inline

The type of job.

Definition at line 185 of file JobListEntry.h.

◆ SetSnowballType() [1/2]

void Aws::Snowball::Model::JobListEntry::SetSnowballType ( const SnowballType value)
inline

The type of device used with this job.

Definition at line 211 of file JobListEntry.h.

◆ SetSnowballType() [2/2]

void Aws::Snowball::Model::JobListEntry::SetSnowballType ( SnowballType &&  value)
inline

The type of device used with this job.

Definition at line 216 of file JobListEntry.h.

◆ SnowballTypeHasBeenSet()

bool Aws::Snowball::Model::JobListEntry::SnowballTypeHasBeenSet ( ) const
inline

The type of device used with this job.

Definition at line 206 of file JobListEntry.h.

◆ WithCreationDate() [1/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The creation date for this job.

Definition at line 252 of file JobListEntry.h.

◆ WithCreationDate() [2/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The creation date for this job.

Definition at line 257 of file JobListEntry.h.

◆ WithDescription() [1/3]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithDescription ( const Aws::String value)
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 294 of file JobListEntry.h.

◆ WithDescription() [2/3]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithDescription ( Aws::String &&  value)
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 300 of file JobListEntry.h.

◆ WithDescription() [3/3]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithDescription ( const char *  value)
inline

The optional description of this specific job, for example Important Photos 2016-08-11.

Definition at line 306 of file JobListEntry.h.

◆ WithIsMaster()

JobListEntry& Aws::Snowball::Model::JobListEntry::WithIsMaster ( bool  value)
inline

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

Definition at line 164 of file JobListEntry.h.

◆ WithJobId() [1/3]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithJobId ( const Aws::String value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 80 of file JobListEntry.h.

◆ WithJobId() [2/3]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithJobId ( Aws::String &&  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 86 of file JobListEntry.h.

◆ WithJobId() [3/3]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithJobId ( const char *  value)
inline

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Definition at line 92 of file JobListEntry.h.

◆ WithJobState() [1/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithJobState ( const JobState value)
inline

The current state of this job.

Definition at line 118 of file JobListEntry.h.

◆ WithJobState() [2/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithJobState ( JobState &&  value)
inline

The current state of this job.

Definition at line 123 of file JobListEntry.h.

◆ WithJobType() [1/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithJobType ( const JobType value)
inline

The type of job.

Definition at line 190 of file JobListEntry.h.

◆ WithJobType() [2/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithJobType ( JobType &&  value)
inline

The type of job.

Definition at line 195 of file JobListEntry.h.

◆ WithSnowballType() [1/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithSnowballType ( const SnowballType value)
inline

The type of device used with this job.

Definition at line 221 of file JobListEntry.h.

◆ WithSnowballType() [2/2]

JobListEntry& Aws::Snowball::Model::JobListEntry::WithSnowballType ( SnowballType &&  value)
inline

The type of device used with this job.

Definition at line 226 of file JobListEntry.h.


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