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

#include <JobListDescriptor.h>

Public Member Functions

 JobListDescriptor ()
 
 JobListDescriptor (const Aws::Utils::Xml::XmlNode &xmlNode)
 
JobListDescriptoroperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
JobListDescriptorWithJobId (const Aws::String &value)
 
JobListDescriptorWithJobId (Aws::String &&value)
 
JobListDescriptorWithJobId (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)
 
JobListDescriptorWithDescription (const Aws::String &value)
 
JobListDescriptorWithDescription (Aws::String &&value)
 
JobListDescriptorWithDescription (const char *value)
 
const OperationNameGetOperation () const
 
bool OperationHasBeenSet () const
 
void SetOperation (const OperationName &value)
 
void SetOperation (OperationName &&value)
 
JobListDescriptorWithOperation (const OperationName &value)
 
JobListDescriptorWithOperation (OperationName &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
JobListDescriptorWithPriority (int value)
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
JobListDescriptorWithStatus (const JobStatus &value)
 
JobListDescriptorWithStatus (JobStatus &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
JobListDescriptorWithCreationTime (const Aws::Utils::DateTime &value)
 
JobListDescriptorWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTerminationDate () const
 
bool TerminationDateHasBeenSet () const
 
void SetTerminationDate (const Aws::Utils::DateTime &value)
 
void SetTerminationDate (Aws::Utils::DateTime &&value)
 
JobListDescriptorWithTerminationDate (const Aws::Utils::DateTime &value)
 
JobListDescriptorWithTerminationDate (Aws::Utils::DateTime &&value)
 
const JobProgressSummaryGetProgressSummary () const
 
bool ProgressSummaryHasBeenSet () const
 
void SetProgressSummary (const JobProgressSummary &value)
 
void SetProgressSummary (JobProgressSummary &&value)
 
JobListDescriptorWithProgressSummary (const JobProgressSummary &value)
 
JobListDescriptorWithProgressSummary (JobProgressSummary &&value)
 

Detailed Description

Contains the configuration and status information for a single job retrieved as part of a job list.

See Also:

AWS API Reference

Definition at line 35 of file JobListDescriptor.h.

Constructor & Destructor Documentation

◆ JobListDescriptor() [1/2]

Aws::S3Control::Model::JobListDescriptor::JobListDescriptor ( )

◆ JobListDescriptor() [2/2]

Aws::S3Control::Model::JobListDescriptor::JobListDescriptor ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::S3Control::Model::JobListDescriptor::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ CreationTimeHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::CreationTimeHasBeenSet ( ) const
inline

A timestamp indicating when the specified job was created.

Definition at line 232 of file JobListDescriptor.h.

◆ DescriptionHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::DescriptionHasBeenSet ( ) const
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 96 of file JobListDescriptor.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::S3Control::Model::JobListDescriptor::GetCreationTime ( ) const
inline

A timestamp indicating when the specified job was created.

Definition at line 227 of file JobListDescriptor.h.

◆ GetDescription()

const Aws::String& Aws::S3Control::Model::JobListDescriptor::GetDescription ( ) const
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 90 of file JobListDescriptor.h.

◆ GetJobId()

const Aws::String& Aws::S3Control::Model::JobListDescriptor::GetJobId ( ) const
inline

The ID for the specified job.

Definition at line 48 of file JobListDescriptor.h.

◆ GetOperation()

const OperationName& Aws::S3Control::Model::JobListDescriptor::GetOperation ( ) const
inline

The operation that the specified job is configured to run on each object listed in the manifest.

Definition at line 139 of file JobListDescriptor.h.

◆ GetPriority()

int Aws::S3Control::Model::JobListDescriptor::GetPriority ( ) const
inline

The current priority for the specified job.

Definition at line 175 of file JobListDescriptor.h.

◆ GetProgressSummary()

const JobProgressSummary& Aws::S3Control::Model::JobListDescriptor::GetProgressSummary ( ) const
inline

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Definition at line 296 of file JobListDescriptor.h.

◆ GetStatus()

const JobStatus& Aws::S3Control::Model::JobListDescriptor::GetStatus ( ) const
inline

The specified job's current status.

Definition at line 196 of file JobListDescriptor.h.

◆ GetTerminationDate()

const Aws::Utils::DateTime& Aws::S3Control::Model::JobListDescriptor::GetTerminationDate ( ) const
inline

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

Definition at line 259 of file JobListDescriptor.h.

◆ JobIdHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::JobIdHasBeenSet ( ) const
inline

The ID for the specified job.

Definition at line 53 of file JobListDescriptor.h.

◆ OperationHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::OperationHasBeenSet ( ) const
inline

The operation that the specified job is configured to run on each object listed in the manifest.

Definition at line 145 of file JobListDescriptor.h.

◆ operator=()

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ PriorityHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::PriorityHasBeenSet ( ) const
inline

The current priority for the specified job.

Definition at line 180 of file JobListDescriptor.h.

◆ ProgressSummaryHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::ProgressSummaryHasBeenSet ( ) const
inline

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Definition at line 302 of file JobListDescriptor.h.

◆ SetCreationTime() [1/2]

void Aws::S3Control::Model::JobListDescriptor::SetCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp indicating when the specified job was created.

Definition at line 237 of file JobListDescriptor.h.

◆ SetCreationTime() [2/2]

void Aws::S3Control::Model::JobListDescriptor::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp indicating when the specified job was created.

Definition at line 242 of file JobListDescriptor.h.

◆ SetDescription() [1/3]

void Aws::S3Control::Model::JobListDescriptor::SetDescription ( const Aws::String value)
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 102 of file JobListDescriptor.h.

◆ SetDescription() [2/3]

void Aws::S3Control::Model::JobListDescriptor::SetDescription ( Aws::String &&  value)
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 108 of file JobListDescriptor.h.

◆ SetDescription() [3/3]

void Aws::S3Control::Model::JobListDescriptor::SetDescription ( const char *  value)
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 114 of file JobListDescriptor.h.

◆ SetJobId() [1/3]

void Aws::S3Control::Model::JobListDescriptor::SetJobId ( const Aws::String value)
inline

The ID for the specified job.

Definition at line 58 of file JobListDescriptor.h.

◆ SetJobId() [2/3]

void Aws::S3Control::Model::JobListDescriptor::SetJobId ( Aws::String &&  value)
inline

The ID for the specified job.

Definition at line 63 of file JobListDescriptor.h.

◆ SetJobId() [3/3]

void Aws::S3Control::Model::JobListDescriptor::SetJobId ( const char *  value)
inline

The ID for the specified job.

Definition at line 68 of file JobListDescriptor.h.

◆ SetOperation() [1/2]

void Aws::S3Control::Model::JobListDescriptor::SetOperation ( const OperationName value)
inline

The operation that the specified job is configured to run on each object listed in the manifest.

Definition at line 151 of file JobListDescriptor.h.

◆ SetOperation() [2/2]

void Aws::S3Control::Model::JobListDescriptor::SetOperation ( OperationName &&  value)
inline

The operation that the specified job is configured to run on each object listed in the manifest.

Definition at line 157 of file JobListDescriptor.h.

◆ SetPriority()

void Aws::S3Control::Model::JobListDescriptor::SetPriority ( int  value)
inline

The current priority for the specified job.

Definition at line 185 of file JobListDescriptor.h.

◆ SetProgressSummary() [1/2]

void Aws::S3Control::Model::JobListDescriptor::SetProgressSummary ( const JobProgressSummary value)
inline

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Definition at line 308 of file JobListDescriptor.h.

◆ SetProgressSummary() [2/2]

void Aws::S3Control::Model::JobListDescriptor::SetProgressSummary ( JobProgressSummary &&  value)
inline

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Definition at line 314 of file JobListDescriptor.h.

◆ SetStatus() [1/2]

void Aws::S3Control::Model::JobListDescriptor::SetStatus ( const JobStatus value)
inline

The specified job's current status.

Definition at line 206 of file JobListDescriptor.h.

◆ SetStatus() [2/2]

void Aws::S3Control::Model::JobListDescriptor::SetStatus ( JobStatus &&  value)
inline

The specified job's current status.

Definition at line 211 of file JobListDescriptor.h.

◆ SetTerminationDate() [1/2]

void Aws::S3Control::Model::JobListDescriptor::SetTerminationDate ( const Aws::Utils::DateTime value)
inline

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

Definition at line 271 of file JobListDescriptor.h.

◆ SetTerminationDate() [2/2]

void Aws::S3Control::Model::JobListDescriptor::SetTerminationDate ( Aws::Utils::DateTime &&  value)
inline

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

Definition at line 277 of file JobListDescriptor.h.

◆ StatusHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::StatusHasBeenSet ( ) const
inline

The specified job's current status.

Definition at line 201 of file JobListDescriptor.h.

◆ TerminationDateHasBeenSet()

bool Aws::S3Control::Model::JobListDescriptor::TerminationDateHasBeenSet ( ) const
inline

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

Definition at line 265 of file JobListDescriptor.h.

◆ WithCreationTime() [1/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp indicating when the specified job was created.

Definition at line 247 of file JobListDescriptor.h.

◆ WithCreationTime() [2/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp indicating when the specified job was created.

Definition at line 252 of file JobListDescriptor.h.

◆ WithDescription() [1/3]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithDescription ( const Aws::String value)
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 120 of file JobListDescriptor.h.

◆ WithDescription() [2/3]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithDescription ( Aws::String &&  value)
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 126 of file JobListDescriptor.h.

◆ WithDescription() [3/3]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithDescription ( const char *  value)
inline

The user-specified description that was included in the specified job's Create Job request.

Definition at line 132 of file JobListDescriptor.h.

◆ WithJobId() [1/3]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithJobId ( const Aws::String value)
inline

The ID for the specified job.

Definition at line 73 of file JobListDescriptor.h.

◆ WithJobId() [2/3]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithJobId ( Aws::String &&  value)
inline

The ID for the specified job.

Definition at line 78 of file JobListDescriptor.h.

◆ WithJobId() [3/3]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithJobId ( const char *  value)
inline

The ID for the specified job.

Definition at line 83 of file JobListDescriptor.h.

◆ WithOperation() [1/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithOperation ( const OperationName value)
inline

The operation that the specified job is configured to run on each object listed in the manifest.

Definition at line 163 of file JobListDescriptor.h.

◆ WithOperation() [2/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithOperation ( OperationName &&  value)
inline

The operation that the specified job is configured to run on each object listed in the manifest.

Definition at line 169 of file JobListDescriptor.h.

◆ WithPriority()

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithPriority ( int  value)
inline

The current priority for the specified job.

Definition at line 190 of file JobListDescriptor.h.

◆ WithProgressSummary() [1/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithProgressSummary ( const JobProgressSummary value)
inline

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Definition at line 320 of file JobListDescriptor.h.

◆ WithProgressSummary() [2/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithProgressSummary ( JobProgressSummary &&  value)
inline

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Definition at line 326 of file JobListDescriptor.h.

◆ WithStatus() [1/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithStatus ( const JobStatus value)
inline

The specified job's current status.

Definition at line 216 of file JobListDescriptor.h.

◆ WithStatus() [2/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithStatus ( JobStatus &&  value)
inline

The specified job's current status.

Definition at line 221 of file JobListDescriptor.h.

◆ WithTerminationDate() [1/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithTerminationDate ( const Aws::Utils::DateTime value)
inline

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

Definition at line 283 of file JobListDescriptor.h.

◆ WithTerminationDate() [2/2]

JobListDescriptor& Aws::S3Control::Model::JobListDescriptor::WithTerminationDate ( Aws::Utils::DateTime &&  value)
inline

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

Definition at line 289 of file JobListDescriptor.h.


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