/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace S3Control { namespace Model { /** *

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

See Also:

AWS * API Reference

*/ class JobListDescriptor { public: AWS_S3CONTROL_API JobListDescriptor(); AWS_S3CONTROL_API JobListDescriptor(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_S3CONTROL_API JobListDescriptor& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_S3CONTROL_API void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const; /** *

The ID for the specified job.

*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *

The ID for the specified job.

*/ inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; } /** *

The ID for the specified job.

*/ inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; } /** *

The ID for the specified job.

*/ inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); } /** *

The ID for the specified job.

*/ inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); } /** *

The ID for the specified job.

*/ inline JobListDescriptor& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *

The ID for the specified job.

*/ inline JobListDescriptor& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *

The ID for the specified job.

*/ inline JobListDescriptor& WithJobId(const char* value) { SetJobId(value); return *this;} /** *

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

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

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

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

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

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

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

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

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

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

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

*/ inline JobListDescriptor& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

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

*/ inline JobListDescriptor& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

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

*/ inline JobListDescriptor& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

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

*/ inline const OperationName& GetOperation() const{ return m_operation; } /** *

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

*/ inline bool OperationHasBeenSet() const { return m_operationHasBeenSet; } /** *

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

*/ inline void SetOperation(const OperationName& value) { m_operationHasBeenSet = true; m_operation = value; } /** *

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

*/ inline void SetOperation(OperationName&& value) { m_operationHasBeenSet = true; m_operation = std::move(value); } /** *

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

*/ inline JobListDescriptor& WithOperation(const OperationName& value) { SetOperation(value); return *this;} /** *

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

*/ inline JobListDescriptor& WithOperation(OperationName&& value) { SetOperation(std::move(value)); return *this;} /** *

The current priority for the specified job.

*/ inline int GetPriority() const{ return m_priority; } /** *

The current priority for the specified job.

*/ inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; } /** *

The current priority for the specified job.

*/ inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; } /** *

The current priority for the specified job.

*/ inline JobListDescriptor& WithPriority(int value) { SetPriority(value); return *this;} /** *

The specified job's current status.

*/ inline const JobStatus& GetStatus() const{ return m_status; } /** *

The specified job's current status.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The specified job's current status.

*/ inline void SetStatus(const JobStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The specified job's current status.

*/ inline void SetStatus(JobStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The specified job's current status.

*/ inline JobListDescriptor& WithStatus(const JobStatus& value) { SetStatus(value); return *this;} /** *

The specified job's current status.

*/ inline JobListDescriptor& WithStatus(JobStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

A timestamp indicating when the specified job was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

A timestamp indicating when the specified job was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

A timestamp indicating when the specified job was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

A timestamp indicating when the specified job was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

A timestamp indicating when the specified job was created.

*/ inline JobListDescriptor& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

A timestamp indicating when the specified job was created.

*/ inline JobListDescriptor& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetTerminationDate() const{ return m_terminationDate; } /** *

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.

*/ inline bool TerminationDateHasBeenSet() const { return m_terminationDateHasBeenSet; } /** *

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.

*/ inline void SetTerminationDate(const Aws::Utils::DateTime& value) { m_terminationDateHasBeenSet = true; m_terminationDate = value; } /** *

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.

*/ inline void SetTerminationDate(Aws::Utils::DateTime&& value) { m_terminationDateHasBeenSet = true; m_terminationDate = std::move(value); } /** *

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.

*/ inline JobListDescriptor& WithTerminationDate(const Aws::Utils::DateTime& value) { SetTerminationDate(value); return *this;} /** *

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.

*/ inline JobListDescriptor& WithTerminationDate(Aws::Utils::DateTime&& value) { SetTerminationDate(std::move(value)); return *this;} /** *

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.

*/ inline const JobProgressSummary& GetProgressSummary() const{ return m_progressSummary; } /** *

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.

*/ inline bool ProgressSummaryHasBeenSet() const { return m_progressSummaryHasBeenSet; } /** *

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.

*/ inline void SetProgressSummary(const JobProgressSummary& value) { m_progressSummaryHasBeenSet = true; m_progressSummary = value; } /** *

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.

*/ inline void SetProgressSummary(JobProgressSummary&& value) { m_progressSummaryHasBeenSet = true; m_progressSummary = std::move(value); } /** *

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.

*/ inline JobListDescriptor& WithProgressSummary(const JobProgressSummary& value) { SetProgressSummary(value); return *this;} /** *

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.

*/ inline JobListDescriptor& WithProgressSummary(JobProgressSummary&& value) { SetProgressSummary(std::move(value)); return *this;} private: Aws::String m_jobId; bool m_jobIdHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; OperationName m_operation; bool m_operationHasBeenSet = false; int m_priority; bool m_priorityHasBeenSet = false; JobStatus m_status; bool m_statusHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_terminationDate; bool m_terminationDateHasBeenSet = false; JobProgressSummary m_progressSummary; bool m_progressSummaryHasBeenSet = false; }; } // namespace Model } // namespace S3Control } // namespace Aws