Struct BatchGetStepItem 

#[non_exhaustive]
pub struct BatchGetStepItem {

    pub farm_id: String,
    pub queue_id: String,
    pub job_id: String,
    pub step_id: String,
    pub name: String,
    pub lifecycle_status: StepLifecycleStatus,
    pub lifecycle_status_message: Option<String>,
    pub task_run_status: TaskRunStatus,
    pub task_run_status_counts: HashMap<TaskRunStatus, i32>,
    pub task_failure_retry_count: Option<i32>,
    pub target_task_run_status: Option<StepTargetTaskRunStatus>,
    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 dependency_counts: Option<DependencyCounts>,
    pub required_capabilities: Option<StepRequiredCapabilities>,
    pub parameter_space: Option<ParameterSpace>,
    pub description: Option<String>,
}

The details of a step returned in a batch get operation.

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.

farm_id: String

The farm ID of the step.

queue_id: String

The queue ID of the step.

job_id: String

The job ID of the step.

step_id: String

The step ID.

name: String

The name of the step.

lifecycle_status: StepLifecycleStatus

The life cycle status of the step.

lifecycle_status_message: Option<String>

A message that communicates the status of the life cycle.

task_run_status: TaskRunStatus

The task run status for the step.

task_run_status_counts: HashMap<TaskRunStatus, i32>

The number of tasks for each run status for the step.

task_failure_retry_count: Option<i32>

The number of times that tasks failed and were retried.

target_task_run_status: Option<StepTargetTaskRunStatus>

The task status to start with on the step.

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.

dependency_counts: Option<DependencyCounts>

The number of dependencies for the step.

required_capabilities: Option<StepRequiredCapabilities>

The required capabilities for the step.

parameter_space: Option<ParameterSpace>

The parameter space for the step.

description: Option<String>

The description of the step.

Implementations

impl BatchGetStepItem

pub fn farm_id(&self) -> &str

The farm ID of the step.

pub fn queue_id(&self) -> &str

The queue ID of the step.

pub fn job_id(&self) -> &str

The job ID of the step.

pub fn step_id(&self) -> &str

The step ID.

pub fn name(&self) -> &str

The name of the step.

pub fn lifecycle_status(&self) -> &StepLifecycleStatus

The life cycle status of the step.

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

A message that communicates the status of the life cycle.

pub fn task_run_status(&self) -> &TaskRunStatus

The task run status for the step.

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

The number of tasks for each run status for the step.

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

The number of times that tasks failed and were retried.

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

The task status to start with on the step.

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 dependency_counts(&self) -> Option<&DependencyCounts>

The number of dependencies for the step.

pub fn required_capabilities(&self) -> Option<&StepRequiredCapabilities>

The required capabilities for the step.

pub fn parameter_space(&self) -> Option<&ParameterSpace>

The parameter space for the step.

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

The description of the step.

impl BatchGetStepItem

pub fn builder() -> BatchGetStepItemBuilder

Creates a new builder-style object to manufacture BatchGetStepItem.

Trait Implementations

impl Clone for BatchGetStepItem

fn clone(&self) -> BatchGetStepItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchGetStepItem

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

Formats the value using the given formatter.

impl PartialEq for BatchGetStepItem

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