Struct aws_sdk_s3control::types::JobDescriptor
source · #[non_exhaustive]pub struct JobDescriptor {Show 19 fields
pub job_id: Option<String>,
pub confirmation_required: Option<bool>,
pub description: Option<String>,
pub job_arn: Option<String>,
pub status: Option<JobStatus>,
pub manifest: Option<JobManifest>,
pub operation: Option<JobOperation>,
pub priority: i32,
pub progress_summary: Option<JobProgressSummary>,
pub status_update_reason: Option<String>,
pub failure_reasons: Option<Vec<JobFailure>>,
pub report: Option<JobReport>,
pub creation_time: Option<DateTime>,
pub termination_date: Option<DateTime>,
pub role_arn: Option<String>,
pub suspended_date: Option<DateTime>,
pub suspended_cause: Option<String>,
pub manifest_generator: Option<JobManifestGenerator>,
pub generated_manifest_descriptor: Option<S3GeneratedManifestDescriptor>,
}
Expand description
A container element for the job configuration and status information returned by a Describe Job
request.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.job_id: Option<String>
The ID for the specified job.
confirmation_required: Option<bool>
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.
description: Option<String>
The description for this job, if one was provided in this job's Create Job
request.
job_arn: Option<String>
The Amazon Resource Name (ARN) for this job.
status: Option<JobStatus>
The current status of the specified job.
manifest: Option<JobManifest>
The configuration information for the specified job's manifest object.
operation: Option<JobOperation>
The operation that the specified job is configured to run on the objects listed in the manifest.
priority: i32
The priority of the specified job.
progress_summary: Option<JobProgressSummary>
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.
status_update_reason: Option<String>
The reason for updating the job.
failure_reasons: Option<Vec<JobFailure>>
If the specified job failed, this field contains information describing the failure.
report: Option<JobReport>
Contains the configuration information for the job-completion report if you requested one in the Create Job
request.
creation_time: Option<DateTime>
A timestamp indicating when this job was created.
termination_date: Option<DateTime>
A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
role_arn: Option<String>
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.
suspended_date: Option<DateTime>
The timestamp when this job was suspended, if it has been suspended.
suspended_cause: Option<String>
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.
manifest_generator: Option<JobManifestGenerator>
The manifest generator that was used to generate a job manifest for this job.
generated_manifest_descriptor: Option<S3GeneratedManifestDescriptor>
The attribute of the JobDescriptor containing details about the job's generated manifest.
Implementations§
source§impl JobDescriptor
impl JobDescriptor
sourcepub fn confirmation_required(&self) -> Option<bool>
pub fn confirmation_required(&self) -> Option<bool>
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.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description for this job, if one was provided in this job's Create Job
request.
sourcepub fn manifest(&self) -> Option<&JobManifest>
pub fn manifest(&self) -> Option<&JobManifest>
The configuration information for the specified job's manifest object.
sourcepub fn operation(&self) -> Option<&JobOperation>
pub fn operation(&self) -> Option<&JobOperation>
The operation that the specified job is configured to run on the objects listed in the manifest.
sourcepub fn progress_summary(&self) -> Option<&JobProgressSummary>
pub fn progress_summary(&self) -> Option<&JobProgressSummary>
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.
sourcepub fn status_update_reason(&self) -> Option<&str>
pub fn status_update_reason(&self) -> Option<&str>
The reason for updating the job.
sourcepub fn failure_reasons(&self) -> &[JobFailure]
pub fn failure_reasons(&self) -> &[JobFailure]
If the specified job failed, this field contains information describing the failure.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .failure_reasons.is_none()
.
sourcepub fn report(&self) -> Option<&JobReport>
pub fn report(&self) -> Option<&JobReport>
Contains the configuration information for the job-completion report if you requested one in the Create Job
request.
sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
A timestamp indicating when this job was created.
sourcepub fn termination_date(&self) -> Option<&DateTime>
pub fn termination_date(&self) -> Option<&DateTime>
A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.
sourcepub fn suspended_date(&self) -> Option<&DateTime>
pub fn suspended_date(&self) -> Option<&DateTime>
The timestamp when this job was suspended, if it has been suspended.
sourcepub fn suspended_cause(&self) -> Option<&str>
pub fn suspended_cause(&self) -> Option<&str>
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.
sourcepub fn manifest_generator(&self) -> Option<&JobManifestGenerator>
pub fn manifest_generator(&self) -> Option<&JobManifestGenerator>
The manifest generator that was used to generate a job manifest for this job.
sourcepub fn generated_manifest_descriptor(
&self
) -> Option<&S3GeneratedManifestDescriptor>
pub fn generated_manifest_descriptor( &self ) -> Option<&S3GeneratedManifestDescriptor>
The attribute of the JobDescriptor containing details about the job's generated manifest.
source§impl JobDescriptor
impl JobDescriptor
sourcepub fn builder() -> JobDescriptorBuilder
pub fn builder() -> JobDescriptorBuilder
Creates a new builder-style object to manufacture JobDescriptor
.
Trait Implementations§
source§impl Clone for JobDescriptor
impl Clone for JobDescriptor
source§fn clone(&self) -> JobDescriptor
fn clone(&self) -> JobDescriptor
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for JobDescriptor
impl Debug for JobDescriptor
source§impl PartialEq for JobDescriptor
impl PartialEq for JobDescriptor
source§fn eq(&self, other: &JobDescriptor) -> bool
fn eq(&self, other: &JobDescriptor) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for JobDescriptor
Auto Trait Implementations§
impl Freeze for JobDescriptor
impl RefUnwindSafe for JobDescriptor
impl Send for JobDescriptor
impl Sync for JobDescriptor
impl Unpin for JobDescriptor
impl UnwindSafe for JobDescriptor
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more