Enum PipelineState

#[non_exhaustive]
pub enum PipelineState {
    Unspecified,
    Queued,
    Pending,
    Running,
    Succeeded,
    Failed,
    Cancelling,
    Cancelled,
    Paused,
    UnknownValue(UnknownValue),
}

Describes the state of a pipeline.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

The pipeline state is unspecified.

Queued

The pipeline has been created or resumed, and processing has not yet begun.

Pending

The service is preparing to run the pipeline.

Running

The pipeline is in progress.

Succeeded

The pipeline completed successfully.

Failed

The pipeline failed.

Cancelling

The pipeline is being cancelled. From this state, the pipeline may only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED.

Cancelled

The pipeline has been cancelled.

Paused

The pipeline has been stopped, and can be resumed.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using PipelineState::value or PipelineState::name.

Implementations

impl PipelineState

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

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

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

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for PipelineState

fn clone(&self) -> PipelineState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineState

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

Formats the value using the given formatter.

impl Default for PipelineState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PipelineState

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PipelineState

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

Formats the value using the given formatter.

impl From<&str> for PipelineState

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for PipelineState

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for PipelineState

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PipelineState