Enum PipelineStatus

pub enum PipelineStatus {
    Stopped,
    Provisioning,
    Initializing,
    Paused,
    Running,
    Unavailable,
    Suspending,
    Stopping,
}

Pipeline status.

This type represents the state of the pipeline tracked by the pipeline runner and observed by the API client via the GET /v0/pipelines/{name} endpoint.

The lifecycle of a pipeline

The following automaton captures the lifecycle of the pipeline. Individual states and transitions of the automaton are described below.

• States labeled with the hourglass symbol (⌛) are timed states. The automaton stays in timed state until the corresponding operation completes or until it transitions to become failed after the pre-defined timeout period expires.

• State transitions labeled with API endpoint names (/start, /pause, /stop) are triggered by invoking corresponding endpoint, e.g., POST /v0/pipelines/{name}/start. Note that these only express desired state, and are applied asynchronously by the automata.

Stopped ◄─────────── Stopping ◄───── All states can transition
│                    ▲            to Stopping by either:
/start or /pause │                    │            (1) user calling /stop?force=true, or;
▼                    │            (2) pipeline encountering a fatal
⌛Provisioning          Suspending            resource or runtime error,
│                    ▲                having the system call /stop?force=true
▼                    │ /stop          effectively
⌛Initializing ──────────────┤  ?force=false
│                    │
┌─────────┼────────────────────┴─────┐
│         ▼                          │
│       Paused  ◄──────► Unavailable │
│        │   ▲                ▲      │
│ /start │   │  /pause        │      │
│        ▼   │                │      │
│       Running ◄─────────────┘      │
└────────────────────────────────────┘

Desired and actual status

We use the desired state model to manage the lifecycle of a pipeline. In this model, the pipeline has two status attributes associated with it at runtime: the desired status, which represents what the user would like the pipeline to do, and the current status, which represents the actual state of the pipeline. The pipeline runner service continuously monitors both fields and steers the pipeline towards the desired state specified by the user.

Only four of the states in the pipeline automaton above can be used as desired statuses: Paused, Running, Suspended and Stopped. These statuses are selected by invoking REST endpoints shown in the diagram (respectively, /pause, /start, and /stop).

The user can monitor the current state of the pipeline via the GET /v0/pipelines/{name} endpoint. In a typical scenario, the user first sets the desired state, e.g., by invoking the /start endpoint, and then polls the GET /v0/pipelines/{name} endpoint to monitor the actual status of the pipeline until its deployment_status attribute changes to Running indicating that the pipeline has been successfully initialized and is processing data, or Stopped with deployment_error being set.

JSON schema

{
 "description": "Pipeline status.\n\nThis type represents the state of the pipeline tracked by the pipeline\nrunner and observed by the API client via the `GET /v0/pipelines/{name}` endpoint.\n\n### The lifecycle of a pipeline\n\nThe following automaton captures the lifecycle of the pipeline.\nIndividual states and transitions of the automaton are described below.\n\n* States labeled with the hourglass symbol (⌛) are **timed** states. The\nautomaton stays in timed state until the corresponding operation completes\nor until it transitions to become failed after the pre-defined timeout\nperiod expires.\n\n* State transitions labeled with API endpoint names (`/start`, `/pause`,\n`/stop`) are triggered by invoking corresponding endpoint,\ne.g., `POST /v0/pipelines/{name}/start`. Note that these only express\ndesired state, and are applied asynchronously by the automata.\n\n```text\nStopped ◄─────────── Stopping ◄───── All states can transition\n│                    ▲            to Stopping by either:\n/start or /pause │                    │            (1) user calling /stop?force=true, or;\n▼                    │            (2) pipeline encountering a fatal\n⌛Provisioning          Suspending            resource or runtime error,\n│                    ▲                having the system call /stop?force=true\n▼                    │ /stop          effectively\n⌛Initializing ──────────────┤  ?force=false\n│                    │\n┌─────────┼────────────────────┴─────┐\n│         ▼                          │\n│       Paused  ◄──────► Unavailable │\n│        │   ▲                ▲      │\n│ /start │   │  /pause        │      │\n│        ▼   │                │      │\n│       Running ◄─────────────┘      │\n└────────────────────────────────────┘\n```\n\n### Desired and actual status\n\nWe use the desired state model to manage the lifecycle of a pipeline.\nIn this model, the pipeline has two status attributes associated with\nit at runtime: the **desired** status, which represents what the user\nwould like the pipeline to do, and the **current** status, which\nrepresents the actual state of the pipeline.  The pipeline runner\nservice continuously monitors both fields and steers the pipeline\ntowards the desired state specified by the user.\n\nOnly four of the states in the pipeline automaton above can be\nused as desired statuses: `Paused`, `Running`, `Suspended` and\n`Stopped`. These statuses are selected by invoking REST endpoints\nshown in the diagram (respectively, `/pause`, `/start`, and `/stop`).\n\nThe user can monitor the current state of the pipeline via the\n`GET /v0/pipelines/{name}` endpoint. In a typical scenario,\nthe user first sets the desired state, e.g., by invoking the\n`/start` endpoint, and then polls the `GET /v0/pipelines/{name}`\nendpoint to monitor the actual status of the pipeline until its\n`deployment_status` attribute changes to `Running` indicating\nthat the pipeline has been successfully initialized and is\nprocessing data, or `Stopped` with `deployment_error` being set.",
 "type": "string",
 "enum": [
   "Stopped",
   "Provisioning",
   "Initializing",
   "Paused",
   "Running",
   "Unavailable",
   "Suspending",
   "Stopping"
 ]
}

Variants

Stopped

Provisioning

Initializing

Paused

Running

Unavailable

Suspending

Stopping

Trait Implementations

impl Clone for PipelineStatus

fn clone(&self) -> PipelineStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PipelineStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PipelineStatus> for PipelineStatus

fn from(value: &PipelineStatus) -> Self

Converts to this type from the input type.

impl FromStr for PipelineStatus

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, ConversionError>

Parses a string s to return a value of this type.

impl Hash for PipelineStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PipelineStatus

fn cmp(&self, other: &PipelineStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PipelineStatus

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

fn partial_cmp(&self, other: &PipelineStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PipelineStatus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToString for PipelineStatus

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<&String> for PipelineStatus

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<&str> for PipelineStatus

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<String> for PipelineStatus

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, ConversionError>

Performs the conversion.

impl Copy for PipelineStatus

impl Eq for PipelineStatus

impl StructuralPartialEq for PipelineStatus