Struct PipelineExecutionSummary

#[non_exhaustive]
pub struct PipelineExecutionSummary {
    pub pipeline_execution_id: Option<String>,
    pub status: Option<PipelineExecutionStatus>,
    pub status_summary: Option<String>,
    pub start_time: Option<DateTime>,
    pub last_update_time: Option<DateTime>,
    pub source_revisions: Option<Vec<SourceRevision>>,
    pub trigger: Option<ExecutionTrigger>,
    pub stop_trigger: Option<StopExecutionTrigger>,
    pub execution_mode: Option<ExecutionMode>,
    pub execution_type: Option<ExecutionType>,
    pub rollback_metadata: Option<PipelineRollbackMetadata>,
}

Summary information about a pipeline execution.

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.

pipeline_execution_id: Option<String>

The ID of the pipeline execution.

status: Option<PipelineExecutionStatus>

The status of the pipeline execution.

• InProgress: The pipeline execution is currently running.

• Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

• Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

• Succeeded: The pipeline execution was completed successfully.

• Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

• Failed: The pipeline execution was not completed successfully.

status_summary: Option<String>

Status summary for the pipeline.

start_time: Option<DateTime>

The date and time when the pipeline execution began, in timestamp format.

last_update_time: Option<DateTime>

The date and time of the last change to the pipeline execution, in timestamp format.

source_revisions: Option<Vec<SourceRevision>>

A list of the source artifact revisions that initiated a pipeline execution.

trigger: Option<ExecutionTrigger>

The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.

stop_trigger: Option<StopExecutionTrigger>

The interaction that stopped a pipeline execution.

execution_mode: Option<ExecutionMode>

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

execution_type: Option<ExecutionType>

Type of the pipeline execution.

rollback_metadata: Option<PipelineRollbackMetadata>

The metadata for the stage execution to be rolled back.

Implementations

impl PipelineExecutionSummary

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

The ID of the pipeline execution.

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

The status of the pipeline execution.

• InProgress: The pipeline execution is currently running.

• Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

• Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

• Succeeded: The pipeline execution was completed successfully.

• Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

• Failed: The pipeline execution was not completed successfully.

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

Status summary for the pipeline.

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

The date and time when the pipeline execution began, in timestamp format.

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

The date and time of the last change to the pipeline execution, in timestamp format.

pub fn source_revisions(&self) -> &[SourceRevision]

A list of the source artifact revisions that initiated a pipeline execution.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .source_revisions.is_none().

pub fn trigger(&self) -> Option<&ExecutionTrigger>

The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.

pub fn stop_trigger(&self) -> Option<&StopExecutionTrigger>

The interaction that stopped a pipeline execution.

pub fn execution_mode(&self) -> Option<&ExecutionMode>

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

pub fn execution_type(&self) -> Option<&ExecutionType>

Type of the pipeline execution.

pub fn rollback_metadata(&self) -> Option<&PipelineRollbackMetadata>

The metadata for the stage execution to be rolled back.

impl PipelineExecutionSummary

pub fn builder() -> PipelineExecutionSummaryBuilder

Creates a new builder-style object to manufacture PipelineExecutionSummary.

Trait Implementations

impl Clone for PipelineExecutionSummary

fn clone(&self) -> PipelineExecutionSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineExecutionSummary

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

Formats the value using the given formatter.

impl PartialEq for PipelineExecutionSummary

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