Struct PipelineExecution

#[non_exhaustive]
pub struct PipelineExecution {
    pub pipeline_name: Option<String>,
    pub pipeline_version: Option<i32>,
    pub pipeline_execution_id: Option<String>,
    pub status: Option<PipelineExecutionStatus>,
    pub status_summary: Option<String>,
    pub artifact_revisions: Option<Vec<ArtifactRevision>>,
    pub variables: Option<Vec<ResolvedPipelineVariable>>,
    pub trigger: Option<ExecutionTrigger>,
    pub execution_mode: Option<ExecutionMode>,
    pub execution_type: Option<ExecutionType>,
    pub rollback_metadata: Option<PipelineRollbackMetadata>,
}

Represents information about an execution of a pipeline.

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

The name of the pipeline with the specified pipeline execution.

pipeline_version: Option<i32>

The version number of the pipeline with the specified pipeline execution.

pipeline_execution_id: Option<String>

The ID of the pipeline execution.

status: Option<PipelineExecutionStatus>

The status of the pipeline execution.

• Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

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

A summary that contains a description of the pipeline execution status.

artifact_revisions: Option<Vec<ArtifactRevision>>

A list of ArtifactRevision objects included in a pipeline execution.

variables: Option<Vec<ResolvedPipelineVariable>>

A list of pipeline variables used for the pipeline execution.

trigger: Option<ExecutionTrigger>

The interaction or event that started 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>

The type of the pipeline execution.

rollback_metadata: Option<PipelineRollbackMetadata>

The metadata about the execution pertaining to stage rollback.

Implementations

impl PipelineExecution

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

The name of the pipeline with the specified pipeline execution.

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

The version number of the pipeline with the specified pipeline execution.

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.

• Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

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

A summary that contains a description of the pipeline execution status.

pub fn artifact_revisions(&self) -> &[ArtifactRevision]

A list of ArtifactRevision objects included in 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 .artifact_revisions.is_none().

pub fn variables(&self) -> &[ResolvedPipelineVariable]

A list of pipeline variables used for the 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 .variables.is_none().

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

The interaction or event that started 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>

The type of the pipeline execution.

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

The metadata about the execution pertaining to stage rollback.

impl PipelineExecution

pub fn builder() -> PipelineExecutionBuilder

Creates a new builder-style object to manufacture PipelineExecution.

Trait Implementations

impl Clone for PipelineExecution

fn clone(&self) -> PipelineExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineExecution

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

Formats the value using the given formatter.

impl PartialEq for PipelineExecution

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