Struct JobDescriptor

#[non_exhaustive]
pub struct JobDescriptor {

    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>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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

impl JobDescriptor

pub fn job_id(&self) -> Option<&str>

The ID for the specified job.

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.

pub fn description(&self) -> Option<&str>

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

pub fn job_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for this job.

pub fn status(&self) -> Option<&JobStatus>

The current status of the specified job.

pub fn manifest(&self) -> Option<&JobManifest>

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

pub fn operation(&self) -> Option<&JobOperation>

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

pub fn priority(&self) -> i32

The priority of the specified job.

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.

pub fn status_update_reason(&self) -> Option<&str>

The reason for updating the job.

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().

pub fn report(&self) -> Option<&JobReport>

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

pub fn creation_time(&self) -> Option<&DateTime>

A timestamp indicating when this job was created.

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.

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.

pub fn suspended_date(&self) -> Option<&DateTime>

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

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.

pub fn manifest_generator(&self) -> Option<&JobManifestGenerator>

The manifest generator that was used to generate a job manifest for this job.

pub fn generated_manifest_descriptor( &self, ) -> Option<&S3GeneratedManifestDescriptor>

The attribute of the JobDescriptor containing details about the job's generated manifest.

impl JobDescriptor

pub fn builder() -> JobDescriptorBuilder

Creates a new builder-style object to manufacture JobDescriptor.

Trait Implementations

impl Clone for JobDescriptor

fn clone(&self) -> JobDescriptor

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JobDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for JobDescriptor

fn eq(&self, other: &JobDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JobDescriptor