Struct StepSearchSummary 

#[non_exhaustive]
pub struct StepSearchSummary {

    pub step_id: Option<String>,
    pub job_id: Option<String>,
    pub queue_id: Option<String>,
    pub name: Option<String>,
    pub lifecycle_status: Option<StepLifecycleStatus>,
    pub lifecycle_status_message: Option<String>,
    pub task_run_status: Option<TaskRunStatus>,
    pub target_task_run_status: Option<StepTargetTaskRunStatus>,
    pub task_run_status_counts: Option<HashMap<TaskRunStatus, i32>>,
    pub task_failure_retry_count: Option<i32>,
    pub created_at: Option<DateTime>,
    pub created_by: Option<String>,
    pub started_at: Option<DateTime>,
    pub ended_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub updated_by: Option<String>,
    pub parameter_space: Option<ParameterSpace>,
}

The details of a step 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.

step_id: Option<String>

The step ID.

job_id: Option<String>

The job ID.

queue_id: Option<String>

The queue ID.

name: Option<String>

The step name.

lifecycle_status: Option<StepLifecycleStatus>

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<StepTargetTaskRunStatus>

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.

task_failure_retry_count: Option<i32>

The total number of times tasks from the step failed and were retried.

created_at: Option<DateTime>

The date and time the resource was created.

created_by: Option<String>

The user or system that created 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.

updated_at: Option<DateTime>

The date and time the resource was updated.

updated_by: Option<String>

The user or system that updated this resource.

parameter_space: Option<ParameterSpace>

The parameters and combination expressions for the search.

Implementations

impl StepSearchSummary

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

The step ID.

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 step name.

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

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<&StepTargetTaskRunStatus>

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

The total number of times tasks from the step failed and were retried.

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

The date and time the resource was created.

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

The user or system that created 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 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 parameter_space(&self) -> Option<&ParameterSpace>

The parameters and combination expressions for the search.

impl StepSearchSummary

pub fn builder() -> StepSearchSummaryBuilder

Creates a new builder-style object to manufacture StepSearchSummary.

Trait Implementations

impl Clone for StepSearchSummary

fn clone(&self) -> StepSearchSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepSearchSummary

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

Formats the value using the given formatter.

impl PartialEq for StepSearchSummary

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