/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include A container element for the job configuration and status information returned
* by a Describe Job
request.See Also:
AWS
* API Reference
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 JobDescriptor& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *The ID for the specified job.
*/ inline JobDescriptor& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *The ID for the specified job.
*/ inline JobDescriptor& WithJobId(const char* value) { SetJobId(value); return *this;} /** *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.
*/ inline bool GetConfirmationRequired() const{ return m_confirmationRequired; } /** *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.
*/ inline bool ConfirmationRequiredHasBeenSet() const { return m_confirmationRequiredHasBeenSet; } /** *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.
*/ inline void SetConfirmationRequired(bool value) { m_confirmationRequiredHasBeenSet = true; m_confirmationRequired = value; } /** *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.
*/ inline JobDescriptor& WithConfirmationRequired(bool value) { SetConfirmationRequired(value); return *this;} /** *The description for this job, if one was provided in this job's Create
* Job
request.
The description for this job, if one was provided in this job's Create
* Job
request.
The description for this job, if one was provided in this job's Create
* Job
request.
The description for this job, if one was provided in this job's Create
* Job
request.
The description for this job, if one was provided in this job's Create
* Job
request.
The description for this job, if one was provided in this job's Create
* Job
request.
The description for this job, if one was provided in this job's Create
* Job
request.
The description for this job, if one was provided in this job's Create
* Job
request.
The Amazon Resource Name (ARN) for this job.
*/ inline const Aws::String& GetJobArn() const{ return m_jobArn; } /** *The Amazon Resource Name (ARN) for this job.
*/ inline bool JobArnHasBeenSet() const { return m_jobArnHasBeenSet; } /** *The Amazon Resource Name (ARN) for this job.
*/ inline void SetJobArn(const Aws::String& value) { m_jobArnHasBeenSet = true; m_jobArn = value; } /** *The Amazon Resource Name (ARN) for this job.
*/ inline void SetJobArn(Aws::String&& value) { m_jobArnHasBeenSet = true; m_jobArn = std::move(value); } /** *The Amazon Resource Name (ARN) for this job.
*/ inline void SetJobArn(const char* value) { m_jobArnHasBeenSet = true; m_jobArn.assign(value); } /** *The Amazon Resource Name (ARN) for this job.
*/ inline JobDescriptor& WithJobArn(const Aws::String& value) { SetJobArn(value); return *this;} /** *The Amazon Resource Name (ARN) for this job.
*/ inline JobDescriptor& WithJobArn(Aws::String&& value) { SetJobArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) for this job.
*/ inline JobDescriptor& WithJobArn(const char* value) { SetJobArn(value); return *this;} /** *The current status of the specified job.
*/ inline const JobStatus& GetStatus() const{ return m_status; } /** *The current status of the specified job.
*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *The current status of the specified job.
*/ inline void SetStatus(const JobStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *The current status of the specified job.
*/ inline void SetStatus(JobStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *The current status of the specified job.
*/ inline JobDescriptor& WithStatus(const JobStatus& value) { SetStatus(value); return *this;} /** *The current status of the specified job.
*/ inline JobDescriptor& WithStatus(JobStatus&& value) { SetStatus(std::move(value)); return *this;} /** *The configuration information for the specified job's manifest object.
*/ inline const JobManifest& GetManifest() const{ return m_manifest; } /** *The configuration information for the specified job's manifest object.
*/ inline bool ManifestHasBeenSet() const { return m_manifestHasBeenSet; } /** *The configuration information for the specified job's manifest object.
*/ inline void SetManifest(const JobManifest& value) { m_manifestHasBeenSet = true; m_manifest = value; } /** *The configuration information for the specified job's manifest object.
*/ inline void SetManifest(JobManifest&& value) { m_manifestHasBeenSet = true; m_manifest = std::move(value); } /** *The configuration information for the specified job's manifest object.
*/ inline JobDescriptor& WithManifest(const JobManifest& value) { SetManifest(value); return *this;} /** *The configuration information for the specified job's manifest object.
*/ inline JobDescriptor& WithManifest(JobManifest&& value) { SetManifest(std::move(value)); return *this;} /** *The operation that the specified job is configured to run on the objects * listed in the manifest.
*/ inline const JobOperation& GetOperation() const{ return m_operation; } /** *The operation that the specified job is configured to run on the objects * listed in the manifest.
*/ inline bool OperationHasBeenSet() const { return m_operationHasBeenSet; } /** *The operation that the specified job is configured to run on the objects * listed in the manifest.
*/ inline void SetOperation(const JobOperation& value) { m_operationHasBeenSet = true; m_operation = value; } /** *The operation that the specified job is configured to run on the objects * listed in the manifest.
*/ inline void SetOperation(JobOperation&& value) { m_operationHasBeenSet = true; m_operation = std::move(value); } /** *The operation that the specified job is configured to run on the objects * listed in the manifest.
*/ inline JobDescriptor& WithOperation(const JobOperation& value) { SetOperation(value); return *this;} /** *The operation that the specified job is configured to run on the objects * listed in the manifest.
*/ inline JobDescriptor& WithOperation(JobOperation&& value) { SetOperation(std::move(value)); return *this;} /** *The priority of the specified job.
*/ inline int GetPriority() const{ return m_priority; } /** *The priority of the specified job.
*/ inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; } /** *The priority of the specified job.
*/ inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; } /** *The priority of the specified job.
*/ inline JobDescriptor& WithPriority(int value) { SetPriority(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 JobDescriptor& 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 JobDescriptor& WithProgressSummary(JobProgressSummary&& value) { SetProgressSummary(std::move(value)); return *this;} /** *The reason for updating the job.
*/ inline const Aws::String& GetStatusUpdateReason() const{ return m_statusUpdateReason; } /** *The reason for updating the job.
*/ inline bool StatusUpdateReasonHasBeenSet() const { return m_statusUpdateReasonHasBeenSet; } /** *The reason for updating the job.
*/ inline void SetStatusUpdateReason(const Aws::String& value) { m_statusUpdateReasonHasBeenSet = true; m_statusUpdateReason = value; } /** *The reason for updating the job.
*/ inline void SetStatusUpdateReason(Aws::String&& value) { m_statusUpdateReasonHasBeenSet = true; m_statusUpdateReason = std::move(value); } /** *The reason for updating the job.
*/ inline void SetStatusUpdateReason(const char* value) { m_statusUpdateReasonHasBeenSet = true; m_statusUpdateReason.assign(value); } /** *The reason for updating the job.
*/ inline JobDescriptor& WithStatusUpdateReason(const Aws::String& value) { SetStatusUpdateReason(value); return *this;} /** *The reason for updating the job.
*/ inline JobDescriptor& WithStatusUpdateReason(Aws::String&& value) { SetStatusUpdateReason(std::move(value)); return *this;} /** *The reason for updating the job.
*/ inline JobDescriptor& WithStatusUpdateReason(const char* value) { SetStatusUpdateReason(value); return *this;} /** *If the specified job failed, this field contains information describing the * failure.
*/ inline const Aws::VectorIf the specified job failed, this field contains information describing the * failure.
*/ inline bool FailureReasonsHasBeenSet() const { return m_failureReasonsHasBeenSet; } /** *If the specified job failed, this field contains information describing the * failure.
*/ inline void SetFailureReasons(const Aws::VectorIf the specified job failed, this field contains information describing the * failure.
*/ inline void SetFailureReasons(Aws::VectorIf the specified job failed, this field contains information describing the * failure.
*/ inline JobDescriptor& WithFailureReasons(const Aws::VectorIf the specified job failed, this field contains information describing the * failure.
*/ inline JobDescriptor& WithFailureReasons(Aws::VectorIf the specified job failed, this field contains information describing the * failure.
*/ inline JobDescriptor& AddFailureReasons(const JobFailure& value) { m_failureReasonsHasBeenSet = true; m_failureReasons.push_back(value); return *this; } /** *If the specified job failed, this field contains information describing the * failure.
*/ inline JobDescriptor& AddFailureReasons(JobFailure&& value) { m_failureReasonsHasBeenSet = true; m_failureReasons.push_back(std::move(value)); return *this; } /** *Contains the configuration information for the job-completion report if you
* requested one in the Create Job
request.
Contains the configuration information for the job-completion report if you
* requested one in the Create Job
request.
Contains the configuration information for the job-completion report if you
* requested one in the Create Job
request.
Contains the configuration information for the job-completion report if you
* requested one in the Create Job
request.
Contains the configuration information for the job-completion report if you
* requested one in the Create Job
request.
Contains the configuration information for the job-completion report if you
* requested one in the Create Job
request.
A timestamp indicating when this job was created.
*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *A timestamp indicating when this job was created.
*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *A timestamp indicating when this job was created.
*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *A timestamp indicating when this job was created.
*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *A timestamp indicating when this job was created.
*/ inline JobDescriptor& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *A timestamp indicating when this job was created.
*/ inline JobDescriptor& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *A timestamp indicating when this 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 this 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 this 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 this 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 this job terminated. A job's termination date is * the date and time when it succeeded, failed, or was canceled.
*/ inline JobDescriptor& WithTerminationDate(const Aws::Utils::DateTime& value) { SetTerminationDate(value); return *this;} /** *A timestamp indicating when this job terminated. A job's termination date is * the date and time when it succeeded, failed, or was canceled.
*/ inline JobDescriptor& WithTerminationDate(Aws::Utils::DateTime&& value) { SetTerminationDate(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline JobDescriptor& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline JobDescriptor& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) * role assigned to run the tasks for this job.
*/ inline JobDescriptor& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *The timestamp when this job was suspended, if it has been suspended.
*/ inline const Aws::Utils::DateTime& GetSuspendedDate() const{ return m_suspendedDate; } /** *The timestamp when this job was suspended, if it has been suspended.
*/ inline bool SuspendedDateHasBeenSet() const { return m_suspendedDateHasBeenSet; } /** *The timestamp when this job was suspended, if it has been suspended.
*/ inline void SetSuspendedDate(const Aws::Utils::DateTime& value) { m_suspendedDateHasBeenSet = true; m_suspendedDate = value; } /** *The timestamp when this job was suspended, if it has been suspended.
*/ inline void SetSuspendedDate(Aws::Utils::DateTime&& value) { m_suspendedDateHasBeenSet = true; m_suspendedDate = std::move(value); } /** *The timestamp when this job was suspended, if it has been suspended.
*/ inline JobDescriptor& WithSuspendedDate(const Aws::Utils::DateTime& value) { SetSuspendedDate(value); return *this;} /** *The timestamp when this job was suspended, if it has been suspended.
*/ inline JobDescriptor& WithSuspendedDate(Aws::Utils::DateTime&& value) { SetSuspendedDate(std::move(value)); return *this;} /** *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.
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.
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.
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.
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.
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.
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.
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.
The manifest generator that was used to generate a job manifest for this * job.
*/ inline const JobManifestGenerator& GetManifestGenerator() const{ return m_manifestGenerator; } /** *The manifest generator that was used to generate a job manifest for this * job.
*/ inline bool ManifestGeneratorHasBeenSet() const { return m_manifestGeneratorHasBeenSet; } /** *The manifest generator that was used to generate a job manifest for this * job.
*/ inline void SetManifestGenerator(const JobManifestGenerator& value) { m_manifestGeneratorHasBeenSet = true; m_manifestGenerator = value; } /** *The manifest generator that was used to generate a job manifest for this * job.
*/ inline void SetManifestGenerator(JobManifestGenerator&& value) { m_manifestGeneratorHasBeenSet = true; m_manifestGenerator = std::move(value); } /** *The manifest generator that was used to generate a job manifest for this * job.
*/ inline JobDescriptor& WithManifestGenerator(const JobManifestGenerator& value) { SetManifestGenerator(value); return *this;} /** *The manifest generator that was used to generate a job manifest for this * job.
*/ inline JobDescriptor& WithManifestGenerator(JobManifestGenerator&& value) { SetManifestGenerator(std::move(value)); return *this;} /** *The attribute of the JobDescriptor containing details about the job's * generated manifest.
*/ inline const S3GeneratedManifestDescriptor& GetGeneratedManifestDescriptor() const{ return m_generatedManifestDescriptor; } /** *The attribute of the JobDescriptor containing details about the job's * generated manifest.
*/ inline bool GeneratedManifestDescriptorHasBeenSet() const { return m_generatedManifestDescriptorHasBeenSet; } /** *The attribute of the JobDescriptor containing details about the job's * generated manifest.
*/ inline void SetGeneratedManifestDescriptor(const S3GeneratedManifestDescriptor& value) { m_generatedManifestDescriptorHasBeenSet = true; m_generatedManifestDescriptor = value; } /** *The attribute of the JobDescriptor containing details about the job's * generated manifest.
*/ inline void SetGeneratedManifestDescriptor(S3GeneratedManifestDescriptor&& value) { m_generatedManifestDescriptorHasBeenSet = true; m_generatedManifestDescriptor = std::move(value); } /** *The attribute of the JobDescriptor containing details about the job's * generated manifest.
*/ inline JobDescriptor& WithGeneratedManifestDescriptor(const S3GeneratedManifestDescriptor& value) { SetGeneratedManifestDescriptor(value); return *this;} /** *The attribute of the JobDescriptor containing details about the job's * generated manifest.
*/ inline JobDescriptor& WithGeneratedManifestDescriptor(S3GeneratedManifestDescriptor&& value) { SetGeneratedManifestDescriptor(std::move(value)); return *this;} private: Aws::String m_jobId; bool m_jobIdHasBeenSet = false; bool m_confirmationRequired; bool m_confirmationRequiredHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_jobArn; bool m_jobArnHasBeenSet = false; JobStatus m_status; bool m_statusHasBeenSet = false; JobManifest m_manifest; bool m_manifestHasBeenSet = false; JobOperation m_operation; bool m_operationHasBeenSet = false; int m_priority; bool m_priorityHasBeenSet = false; JobProgressSummary m_progressSummary; bool m_progressSummaryHasBeenSet = false; Aws::String m_statusUpdateReason; bool m_statusUpdateReasonHasBeenSet = false; Aws::Vector