Struct JobSummary

#[non_exhaustive]
pub struct JobSummary {

    pub job_id: String,
    pub name: String,
    pub lifecycle_status: JobLifecycleStatus,
    pub lifecycle_status_message: String,
    pub priority: i32,
    pub created_at: DateTime,
    pub created_by: String,
    pub updated_at: Option<DateTime>,
    pub updated_by: Option<String>,
    pub started_at: Option<DateTime>,
    pub ended_at: Option<DateTime>,
    pub task_run_status: Option<TaskRunStatus>,
    pub target_task_run_status: Option<JobTargetTaskRunStatus>,
    pub task_run_status_counts: Option<HashMap<TaskRunStatus, i32>>,
    pub max_failed_tasks_count: Option<i32>,
    pub max_retries_per_task: Option<i32>,
    pub source_job_id: Option<String>,
}

A summary of job details.

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: String

The job ID.

name: String

The job name.

lifecycle_status: JobLifecycleStatus

The life cycle status.

lifecycle_status_message: String

The life cycle status message.

priority: i32

The job priority.

created_at: DateTime

The date and time the resource was created.

created_by: String

The user or system that created this resource.

updated_at: Option<DateTime>

The date and time the resource was updated.

updated_by: Option<String>

The user or system that updated this resource.

started_at: Option<DateTime>

The date and time the resource started running.

ended_at: Option<DateTime>

The date and time the resource ended running.

task_run_status: Option<TaskRunStatus>

The task run status for the job.

• PENDING–pending and waiting for resources.

• READY–ready to be processed.

• ASSIGNED–assigned and will run next on a worker.

• SCHEDULED–scheduled to be run on a worker.

• INTERRUPTING–being interrupted.

• RUNNING–running on a worker.

• SUSPENDED–the task is suspended.

• CANCELED–the task has been canceled.

• FAILED–the task has failed.

• SUCCEEDED–the task has succeeded.

target_task_run_status: Option<JobTargetTaskRunStatus>

The task status to start with on the job.

task_run_status_counts: Option<HashMap<TaskRunStatus, i32>>

The number of tasks running on the job.

max_failed_tasks_count: Option<i32>

The number of task failures before the job stops running and is marked as FAILED.

max_retries_per_task: Option<i32>

The maximum number of retries for a job.

source_job_id: Option<String>

The job ID for the source job.

Implementations

impl JobSummary

pub fn job_id(&self) -> &str

The job ID.

pub fn name(&self) -> &str

The job name.

pub fn lifecycle_status(&self) -> &JobLifecycleStatus

The life cycle status.

pub fn lifecycle_status_message(&self) -> &str

The life cycle status message.

pub fn priority(&self) -> i32

The job priority.

pub fn created_at(&self) -> &DateTime

The date and time the resource was created.

pub fn created_by(&self) -> &str

The user or system that created this resource.

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

The date and time the resource was updated.

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

The user or system that updated this resource.

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

The date and time the resource started running.

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

The date and time the resource ended running.

pub fn task_run_status(&self) -> Option<&TaskRunStatus>

The task run status for the job.

• PENDING–pending and waiting for resources.

• READY–ready to be processed.

• ASSIGNED–assigned and will run next on a worker.

• SCHEDULED–scheduled to be run on a worker.

• INTERRUPTING–being interrupted.

• RUNNING–running on a worker.

• SUSPENDED–the task is suspended.

• CANCELED–the task has been canceled.

• FAILED–the task has failed.

• SUCCEEDED–the task has succeeded.

pub fn target_task_run_status(&self) -> Option<&JobTargetTaskRunStatus>

The task status to start with on the job.

pub fn task_run_status_counts(&self) -> Option<&HashMap<TaskRunStatus, i32>>

The number of tasks running on the job.

pub fn max_failed_tasks_count(&self) -> Option<i32>

The number of task failures before the job stops running and is marked as FAILED.

pub fn max_retries_per_task(&self) -> Option<i32>

The maximum number of retries for a job.

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

The job ID for the source job.

impl JobSummary

pub fn builder() -> JobSummaryBuilder

Creates a new builder-style object to manufacture JobSummary.

Trait Implementations

impl Clone for JobSummary

fn clone(&self) -> JobSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobSummary

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

Formats the value using the given formatter.

impl PartialEq for JobSummary

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

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

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 JobSummary