Struct JobSearchSummary

#[non_exhaustive]
pub struct JobSearchSummary {

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

The details of a job search.

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 job ID.

queue_id: Option<String>

The queue ID.

name: Option<String>

The job name.

lifecycle_status: Option<JobLifecycleStatus>

The life cycle status.

lifecycle_status_message: Option<String>

The life cycle status message.

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.

priority: Option<i32>

The job priority.

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.

created_by: Option<String>

The user or system that created this resource.

created_at: Option<DateTime>

The date and time the resource was created.

ended_at: Option<DateTime>

The date and time the resource ended running.

started_at: Option<DateTime>

The date and time the resource started running.

job_parameters: Option<HashMap<String, JobParameter>>

The job parameters.

source_job_id: Option<String>

The job ID for the source job.

Implementations

impl JobSearchSummary

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

The job ID.

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

The queue ID.

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

The job name.

pub fn lifecycle_status(&self) -> Option<&JobLifecycleStatus>

The life cycle status.

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

The life cycle status message.

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 priority(&self) -> Option<i32>

The job priority.

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 created_by(&self) -> Option<&str>

The user or system that created this resource.

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

The date and time the resource was created.

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

The date and time the resource ended running.

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

The date and time the resource started running.

pub fn job_parameters(&self) -> Option<&HashMap<String, JobParameter>>

The job parameters.

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

The job ID for the source job.

impl JobSearchSummary

pub fn builder() -> JobSearchSummaryBuilder

Creates a new builder-style object to manufacture JobSearchSummary.

Trait Implementations

impl Clone for JobSearchSummary

fn clone(&self) -> JobSearchSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobSearchSummary

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

Formats the value using the given formatter.

impl PartialEq for JobSearchSummary

fn eq(&self, other: &JobSearchSummary) -> 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 JobSearchSummary