Struct WorkflowStepMetadata

#[non_exhaustive]
pub struct WorkflowStepMetadata {
    pub step_execution_id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub action: Option<String>,
    pub status: Option<WorkflowStepExecutionStatus>,
    pub rollback_status: Option<WorkflowStepExecutionRollbackStatus>,
    pub message: Option<String>,
    pub inputs: Option<String>,
    pub outputs: Option<String>,
    pub start_time: Option<String>,
    pub end_time: Option<String>,
}

Runtime details and status for the workflow step.

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

A unique identifier for the workflow step, assigned at runtime.

name: Option<String>

The name of the workflow step.

description: Option<String>

Description of the workflow step.

action: Option<String>

The step action name.

status: Option<WorkflowStepExecutionStatus>

Runtime status for the workflow step.

rollback_status: Option<WorkflowStepExecutionRollbackStatus>

Reports on the rollback status of the step, if applicable.

message: Option<String>

Detailed output message that the workflow step provides at runtime.

inputs: Option<String>

Input parameters that Image Builder provides for the workflow step.

outputs: Option<String>

The file names that the workflow step created as output for this runtime instance of the workflow.

start_time: Option<String>

The timestamp when the workflow step started.

end_time: Option<String>

The timestamp when the workflow step finished.

Implementations

impl WorkflowStepMetadata

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

A unique identifier for the workflow step, assigned at runtime.

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

The name of the workflow step.

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

Description of the workflow step.

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

The step action name.

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

Runtime status for the workflow step.

pub fn rollback_status(&self) -> Option<&WorkflowStepExecutionRollbackStatus>

Reports on the rollback status of the step, if applicable.

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

Detailed output message that the workflow step provides at runtime.

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

Input parameters that Image Builder provides for the workflow step.

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

The file names that the workflow step created as output for this runtime instance of the workflow.

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

The timestamp when the workflow step started.

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

The timestamp when the workflow step finished.

impl WorkflowStepMetadata

pub fn builder() -> WorkflowStepMetadataBuilder

Creates a new builder-style object to manufacture WorkflowStepMetadata.

Trait Implementations

impl Clone for WorkflowStepMetadata

fn clone(&self) -> WorkflowStepMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowStepMetadata

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

Formats the value using the given formatter.

impl PartialEq for WorkflowStepMetadata

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