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

#include <JobDescriptor.h>

Public Member Functions

 JobDescriptor ()
 
 JobDescriptor (const Aws::Utils::Xml::XmlNode &xmlNode)
 
JobDescriptoroperator= (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)
 
JobDescriptorWithJobId (const Aws::String &value)
 
JobDescriptorWithJobId (Aws::String &&value)
 
JobDescriptorWithJobId (const char *value)
 
bool GetConfirmationRequired () const
 
bool ConfirmationRequiredHasBeenSet () const
 
void SetConfirmationRequired (bool value)
 
JobDescriptorWithConfirmationRequired (bool value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
JobDescriptorWithDescription (const Aws::String &value)
 
JobDescriptorWithDescription (Aws::String &&value)
 
JobDescriptorWithDescription (const char *value)
 
const Aws::StringGetJobArn () const
 
bool JobArnHasBeenSet () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
JobDescriptorWithJobArn (const Aws::String &value)
 
JobDescriptorWithJobArn (Aws::String &&value)
 
JobDescriptorWithJobArn (const char *value)
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
JobDescriptorWithStatus (const JobStatus &value)
 
JobDescriptorWithStatus (JobStatus &&value)
 
const JobManifestGetManifest () const
 
bool ManifestHasBeenSet () const
 
void SetManifest (const JobManifest &value)
 
void SetManifest (JobManifest &&value)
 
JobDescriptorWithManifest (const JobManifest &value)
 
JobDescriptorWithManifest (JobManifest &&value)
 
const JobOperationGetOperation () const
 
bool OperationHasBeenSet () const
 
void SetOperation (const JobOperation &value)
 
void SetOperation (JobOperation &&value)
 
JobDescriptorWithOperation (const JobOperation &value)
 
JobDescriptorWithOperation (JobOperation &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
JobDescriptorWithPriority (int value)
 
const JobProgressSummaryGetProgressSummary () const
 
bool ProgressSummaryHasBeenSet () const
 
void SetProgressSummary (const JobProgressSummary &value)
 
void SetProgressSummary (JobProgressSummary &&value)
 
JobDescriptorWithProgressSummary (const JobProgressSummary &value)
 
JobDescriptorWithProgressSummary (JobProgressSummary &&value)
 
const Aws::StringGetStatusUpdateReason () const
 
bool StatusUpdateReasonHasBeenSet () const
 
void SetStatusUpdateReason (const Aws::String &value)
 
void SetStatusUpdateReason (Aws::String &&value)
 
void SetStatusUpdateReason (const char *value)
 
JobDescriptorWithStatusUpdateReason (const Aws::String &value)
 
JobDescriptorWithStatusUpdateReason (Aws::String &&value)
 
JobDescriptorWithStatusUpdateReason (const char *value)
 
const Aws::Vector< JobFailure > & GetFailureReasons () const
 
bool FailureReasonsHasBeenSet () const
 
void SetFailureReasons (const Aws::Vector< JobFailure > &value)
 
void SetFailureReasons (Aws::Vector< JobFailure > &&value)
 
JobDescriptorWithFailureReasons (const Aws::Vector< JobFailure > &value)
 
JobDescriptorWithFailureReasons (Aws::Vector< JobFailure > &&value)
 
JobDescriptorAddFailureReasons (const JobFailure &value)
 
JobDescriptorAddFailureReasons (JobFailure &&value)
 
const JobReportGetReport () const
 
bool ReportHasBeenSet () const
 
void SetReport (const JobReport &value)
 
void SetReport (JobReport &&value)
 
JobDescriptorWithReport (const JobReport &value)
 
JobDescriptorWithReport (JobReport &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
JobDescriptorWithCreationTime (const Aws::Utils::DateTime &value)
 
JobDescriptorWithCreationTime (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)
 
JobDescriptorWithTerminationDate (const Aws::Utils::DateTime &value)
 
JobDescriptorWithTerminationDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
JobDescriptorWithRoleArn (const Aws::String &value)
 
JobDescriptorWithRoleArn (Aws::String &&value)
 
JobDescriptorWithRoleArn (const char *value)
 
const Aws::Utils::DateTimeGetSuspendedDate () const
 
bool SuspendedDateHasBeenSet () const
 
void SetSuspendedDate (const Aws::Utils::DateTime &value)
 
void SetSuspendedDate (Aws::Utils::DateTime &&value)
 
JobDescriptorWithSuspendedDate (const Aws::Utils::DateTime &value)
 
JobDescriptorWithSuspendedDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetSuspendedCause () const
 
bool SuspendedCauseHasBeenSet () const
 
void SetSuspendedCause (const Aws::String &value)
 
void SetSuspendedCause (Aws::String &&value)
 
void SetSuspendedCause (const char *value)
 
JobDescriptorWithSuspendedCause (const Aws::String &value)
 
JobDescriptorWithSuspendedCause (Aws::String &&value)
 
JobDescriptorWithSuspendedCause (const char *value)
 

Detailed Description

A container element for the job configuration and status information returned by a Describe Job request.

See Also:

AWS API Reference

Definition at line 39 of file JobDescriptor.h.

Constructor & Destructor Documentation

◆ JobDescriptor() [1/2]

Aws::S3Control::Model::JobDescriptor::JobDescriptor ( )

◆ JobDescriptor() [2/2]

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

Member Function Documentation

◆ AddFailureReasons() [1/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::AddFailureReasons ( const JobFailure value)
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 447 of file JobDescriptor.h.

◆ AddFailureReasons() [2/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::AddFailureReasons ( JobFailure &&  value)
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 453 of file JobDescriptor.h.

◆ AddToNode()

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

◆ ConfirmationRequiredHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::ConfirmationRequiredHasBeenSet ( ) const
inline

Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

Definition at line 102 of file JobDescriptor.h.

◆ CreationTimeHasBeenSet()

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

A timestamp indicating when this job was created.

Definition at line 501 of file JobDescriptor.h.

◆ DescriptionHasBeenSet()

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 129 of file JobDescriptor.h.

◆ FailureReasonsHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::FailureReasonsHasBeenSet ( ) const
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 417 of file JobDescriptor.h.

◆ GetConfirmationRequired()

bool Aws::S3Control::Model::JobDescriptor::GetConfirmationRequired ( ) const
inline

Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

Definition at line 95 of file JobDescriptor.h.

◆ GetCreationTime()

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

A timestamp indicating when this job was created.

Definition at line 496 of file JobDescriptor.h.

◆ GetDescription()

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 123 of file JobDescriptor.h.

◆ GetFailureReasons()

const Aws::Vector<JobFailure>& Aws::S3Control::Model::JobDescriptor::GetFailureReasons ( ) const
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 411 of file JobDescriptor.h.

◆ GetJobArn()

const Aws::String& Aws::S3Control::Model::JobDescriptor::GetJobArn ( ) const
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 171 of file JobDescriptor.h.

◆ GetJobId()

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

The ID for the specified job.

Definition at line 52 of file JobDescriptor.h.

◆ GetManifest()

const JobManifest& Aws::S3Control::Model::JobDescriptor::GetManifest ( ) const
inline

The configuration information for the specified job's manifest object.

Definition at line 243 of file JobDescriptor.h.

◆ GetOperation()

const JobOperation& Aws::S3Control::Model::JobDescriptor::GetOperation ( ) const
inline

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

Definition at line 275 of file JobDescriptor.h.

◆ GetPriority()

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

The priority of the specified job.

Definition at line 311 of file JobDescriptor.h.

◆ GetProgressSummary()

const JobProgressSummary& Aws::S3Control::Model::JobDescriptor::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 333 of file JobDescriptor.h.

◆ GetReport()

const JobReport& Aws::S3Control::Model::JobDescriptor::GetReport ( ) const
inline

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Definition at line 460 of file JobDescriptor.h.

◆ GetRoleArn()

const Aws::String& Aws::S3Control::Model::JobDescriptor::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 565 of file JobDescriptor.h.

◆ GetStatus()

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

The current status of the specified job.

Definition at line 212 of file JobDescriptor.h.

◆ GetStatusUpdateReason()

const Aws::String& Aws::S3Control::Model::JobDescriptor::GetStatusUpdateReason ( ) const
inline

The reason for updating the job.

Definition at line 369 of file JobDescriptor.h.

◆ GetSuspendedCause()

const Aws::String& Aws::S3Control::Model::JobDescriptor::GetSuspendedCause ( ) const
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 647 of file JobDescriptor.h.

◆ GetSuspendedDate()

const Aws::Utils::DateTime& Aws::S3Control::Model::JobDescriptor::GetSuspendedDate ( ) const
inline

The timestamp when this job was suspended, if it has been suspended.

Definition at line 613 of file JobDescriptor.h.

◆ GetTerminationDate()

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

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

Definition at line 528 of file JobDescriptor.h.

◆ JobArnHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::JobArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 176 of file JobDescriptor.h.

◆ JobIdHasBeenSet()

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

The ID for the specified job.

Definition at line 57 of file JobDescriptor.h.

◆ ManifestHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::ManifestHasBeenSet ( ) const
inline

The configuration information for the specified job's manifest object.

Definition at line 248 of file JobDescriptor.h.

◆ OperationHasBeenSet()

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

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

Definition at line 281 of file JobDescriptor.h.

◆ operator=()

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

◆ PriorityHasBeenSet()

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

The priority of the specified job.

Definition at line 316 of file JobDescriptor.h.

◆ ProgressSummaryHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::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 339 of file JobDescriptor.h.

◆ ReportHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::ReportHasBeenSet ( ) const
inline

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Definition at line 466 of file JobDescriptor.h.

◆ RoleArnHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::RoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 571 of file JobDescriptor.h.

◆ SetConfirmationRequired()

void Aws::S3Control::Model::JobDescriptor::SetConfirmationRequired ( bool  value)
inline

Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

Definition at line 109 of file JobDescriptor.h.

◆ SetCreationTime() [1/2]

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

A timestamp indicating when this job was created.

Definition at line 506 of file JobDescriptor.h.

◆ SetCreationTime() [2/2]

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

A timestamp indicating when this job was created.

Definition at line 511 of file JobDescriptor.h.

◆ SetDescription() [1/3]

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 135 of file JobDescriptor.h.

◆ SetDescription() [2/3]

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 141 of file JobDescriptor.h.

◆ SetDescription() [3/3]

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 147 of file JobDescriptor.h.

◆ SetFailureReasons() [1/2]

void Aws::S3Control::Model::JobDescriptor::SetFailureReasons ( const Aws::Vector< JobFailure > &  value)
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 423 of file JobDescriptor.h.

◆ SetFailureReasons() [2/2]

void Aws::S3Control::Model::JobDescriptor::SetFailureReasons ( Aws::Vector< JobFailure > &&  value)
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 429 of file JobDescriptor.h.

◆ SetJobArn() [1/3]

void Aws::S3Control::Model::JobDescriptor::SetJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 181 of file JobDescriptor.h.

◆ SetJobArn() [2/3]

void Aws::S3Control::Model::JobDescriptor::SetJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 186 of file JobDescriptor.h.

◆ SetJobArn() [3/3]

void Aws::S3Control::Model::JobDescriptor::SetJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 191 of file JobDescriptor.h.

◆ SetJobId() [1/3]

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

The ID for the specified job.

Definition at line 62 of file JobDescriptor.h.

◆ SetJobId() [2/3]

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

The ID for the specified job.

Definition at line 67 of file JobDescriptor.h.

◆ SetJobId() [3/3]

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

The ID for the specified job.

Definition at line 72 of file JobDescriptor.h.

◆ SetManifest() [1/2]

void Aws::S3Control::Model::JobDescriptor::SetManifest ( const JobManifest value)
inline

The configuration information for the specified job's manifest object.

Definition at line 253 of file JobDescriptor.h.

◆ SetManifest() [2/2]

void Aws::S3Control::Model::JobDescriptor::SetManifest ( JobManifest &&  value)
inline

The configuration information for the specified job's manifest object.

Definition at line 258 of file JobDescriptor.h.

◆ SetOperation() [1/2]

void Aws::S3Control::Model::JobDescriptor::SetOperation ( const JobOperation value)
inline

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

Definition at line 287 of file JobDescriptor.h.

◆ SetOperation() [2/2]

void Aws::S3Control::Model::JobDescriptor::SetOperation ( JobOperation &&  value)
inline

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

Definition at line 293 of file JobDescriptor.h.

◆ SetPriority()

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

The priority of the specified job.

Definition at line 321 of file JobDescriptor.h.

◆ SetProgressSummary() [1/2]

void Aws::S3Control::Model::JobDescriptor::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 345 of file JobDescriptor.h.

◆ SetProgressSummary() [2/2]

void Aws::S3Control::Model::JobDescriptor::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 351 of file JobDescriptor.h.

◆ SetReport() [1/2]

void Aws::S3Control::Model::JobDescriptor::SetReport ( const JobReport value)
inline

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Definition at line 472 of file JobDescriptor.h.

◆ SetReport() [2/2]

void Aws::S3Control::Model::JobDescriptor::SetReport ( JobReport &&  value)
inline

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Definition at line 478 of file JobDescriptor.h.

◆ SetRoleArn() [1/3]

void Aws::S3Control::Model::JobDescriptor::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 577 of file JobDescriptor.h.

◆ SetRoleArn() [2/3]

void Aws::S3Control::Model::JobDescriptor::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 583 of file JobDescriptor.h.

◆ SetRoleArn() [3/3]

void Aws::S3Control::Model::JobDescriptor::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 589 of file JobDescriptor.h.

◆ SetStatus() [1/2]

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

The current status of the specified job.

Definition at line 222 of file JobDescriptor.h.

◆ SetStatus() [2/2]

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

The current status of the specified job.

Definition at line 227 of file JobDescriptor.h.

◆ SetStatusUpdateReason() [1/3]

void Aws::S3Control::Model::JobDescriptor::SetStatusUpdateReason ( const Aws::String value)
inline

The reason for updating the job.

Definition at line 379 of file JobDescriptor.h.

◆ SetStatusUpdateReason() [2/3]

void Aws::S3Control::Model::JobDescriptor::SetStatusUpdateReason ( Aws::String &&  value)
inline

The reason for updating the job.

Definition at line 384 of file JobDescriptor.h.

◆ SetStatusUpdateReason() [3/3]

void Aws::S3Control::Model::JobDescriptor::SetStatusUpdateReason ( const char *  value)
inline

The reason for updating the job.

Definition at line 389 of file JobDescriptor.h.

◆ SetSuspendedCause() [1/3]

void Aws::S3Control::Model::JobDescriptor::SetSuspendedCause ( const Aws::String value)
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 663 of file JobDescriptor.h.

◆ SetSuspendedCause() [2/3]

void Aws::S3Control::Model::JobDescriptor::SetSuspendedCause ( Aws::String &&  value)
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 671 of file JobDescriptor.h.

◆ SetSuspendedCause() [3/3]

void Aws::S3Control::Model::JobDescriptor::SetSuspendedCause ( const char *  value)
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 679 of file JobDescriptor.h.

◆ SetSuspendedDate() [1/2]

void Aws::S3Control::Model::JobDescriptor::SetSuspendedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when this job was suspended, if it has been suspended.

Definition at line 623 of file JobDescriptor.h.

◆ SetSuspendedDate() [2/2]

void Aws::S3Control::Model::JobDescriptor::SetSuspendedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when this job was suspended, if it has been suspended.

Definition at line 628 of file JobDescriptor.h.

◆ SetTerminationDate() [1/2]

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

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

Definition at line 540 of file JobDescriptor.h.

◆ SetTerminationDate() [2/2]

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

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

Definition at line 546 of file JobDescriptor.h.

◆ StatusHasBeenSet()

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

The current status of the specified job.

Definition at line 217 of file JobDescriptor.h.

◆ StatusUpdateReasonHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::StatusUpdateReasonHasBeenSet ( ) const
inline

The reason for updating the job.

Definition at line 374 of file JobDescriptor.h.

◆ SuspendedCauseHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::SuspendedCauseHasBeenSet ( ) const
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 655 of file JobDescriptor.h.

◆ SuspendedDateHasBeenSet()

bool Aws::S3Control::Model::JobDescriptor::SuspendedDateHasBeenSet ( ) const
inline

The timestamp when this job was suspended, if it has been suspended.

Definition at line 618 of file JobDescriptor.h.

◆ TerminationDateHasBeenSet()

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

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

Definition at line 534 of file JobDescriptor.h.

◆ WithConfirmationRequired()

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithConfirmationRequired ( bool  value)
inline

Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

Definition at line 116 of file JobDescriptor.h.

◆ WithCreationTime() [1/2]

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

A timestamp indicating when this job was created.

Definition at line 516 of file JobDescriptor.h.

◆ WithCreationTime() [2/2]

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

A timestamp indicating when this job was created.

Definition at line 521 of file JobDescriptor.h.

◆ WithDescription() [1/3]

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 153 of file JobDescriptor.h.

◆ WithDescription() [2/3]

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 159 of file JobDescriptor.h.

◆ WithDescription() [3/3]

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

The description for this job, if one was provided in this job's Create Job request.

Definition at line 165 of file JobDescriptor.h.

◆ WithFailureReasons() [1/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithFailureReasons ( const Aws::Vector< JobFailure > &  value)
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 435 of file JobDescriptor.h.

◆ WithFailureReasons() [2/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithFailureReasons ( Aws::Vector< JobFailure > &&  value)
inline

If the specified job failed, this field contains information describing the failure.

Definition at line 441 of file JobDescriptor.h.

◆ WithJobArn() [1/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 196 of file JobDescriptor.h.

◆ WithJobArn() [2/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 201 of file JobDescriptor.h.

◆ WithJobArn() [3/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for this job.

Definition at line 206 of file JobDescriptor.h.

◆ WithJobId() [1/3]

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

The ID for the specified job.

Definition at line 77 of file JobDescriptor.h.

◆ WithJobId() [2/3]

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

The ID for the specified job.

Definition at line 82 of file JobDescriptor.h.

◆ WithJobId() [3/3]

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

The ID for the specified job.

Definition at line 87 of file JobDescriptor.h.

◆ WithManifest() [1/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithManifest ( const JobManifest value)
inline

The configuration information for the specified job's manifest object.

Definition at line 263 of file JobDescriptor.h.

◆ WithManifest() [2/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithManifest ( JobManifest &&  value)
inline

The configuration information for the specified job's manifest object.

Definition at line 268 of file JobDescriptor.h.

◆ WithOperation() [1/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithOperation ( const JobOperation value)
inline

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

Definition at line 299 of file JobDescriptor.h.

◆ WithOperation() [2/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithOperation ( JobOperation &&  value)
inline

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

Definition at line 305 of file JobDescriptor.h.

◆ WithPriority()

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

The priority of the specified job.

Definition at line 326 of file JobDescriptor.h.

◆ WithProgressSummary() [1/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::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 357 of file JobDescriptor.h.

◆ WithProgressSummary() [2/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::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 363 of file JobDescriptor.h.

◆ WithReport() [1/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithReport ( const JobReport value)
inline

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Definition at line 484 of file JobDescriptor.h.

◆ WithReport() [2/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithReport ( JobReport &&  value)
inline

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Definition at line 490 of file JobDescriptor.h.

◆ WithRoleArn() [1/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 595 of file JobDescriptor.h.

◆ WithRoleArn() [2/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 601 of file JobDescriptor.h.

◆ WithRoleArn() [3/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Definition at line 607 of file JobDescriptor.h.

◆ WithStatus() [1/2]

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

The current status of the specified job.

Definition at line 232 of file JobDescriptor.h.

◆ WithStatus() [2/2]

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

The current status of the specified job.

Definition at line 237 of file JobDescriptor.h.

◆ WithStatusUpdateReason() [1/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithStatusUpdateReason ( const Aws::String value)
inline

The reason for updating the job.

Definition at line 394 of file JobDescriptor.h.

◆ WithStatusUpdateReason() [2/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithStatusUpdateReason ( Aws::String &&  value)
inline

The reason for updating the job.

Definition at line 399 of file JobDescriptor.h.

◆ WithStatusUpdateReason() [3/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithStatusUpdateReason ( const char *  value)
inline

The reason for updating the job.

Definition at line 404 of file JobDescriptor.h.

◆ WithSuspendedCause() [1/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithSuspendedCause ( const Aws::String value)
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 687 of file JobDescriptor.h.

◆ WithSuspendedCause() [2/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithSuspendedCause ( Aws::String &&  value)
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 695 of file JobDescriptor.h.

◆ WithSuspendedCause() [3/3]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithSuspendedCause ( const char *  value)
inline

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Definition at line 703 of file JobDescriptor.h.

◆ WithSuspendedDate() [1/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithSuspendedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when this job was suspended, if it has been suspended.

Definition at line 633 of file JobDescriptor.h.

◆ WithSuspendedDate() [2/2]

JobDescriptor& Aws::S3Control::Model::JobDescriptor::WithSuspendedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when this job was suspended, if it has been suspended.

Definition at line 638 of file JobDescriptor.h.

◆ WithTerminationDate() [1/2]

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

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

Definition at line 552 of file JobDescriptor.h.

◆ WithTerminationDate() [2/2]

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

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

Definition at line 558 of file JobDescriptor.h.


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