Enum ResourcesStatus 

pub enum ResourcesStatus {
    Stopped,
    Provisioning,
    Provisioned,
    Stopping,
}

Pipeline resources status.

/start (early start failed)
┌───────────────────┐
│                   ▼
Stopped ◄────────── Stopping
/start │                   ▲
│                   │ /stop?force=true
│                   │ OR: timeout (from Provisioning)
▼                   │ OR: fatal runtime or resource error
⌛Provisioning ────────────│ OR: runtime status is Suspended
│                   │
│                   │
▼                   │
Provisioned ─────────────┘

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: the desired status, which represents what the user would like the pipeline to do, and the current status, which represents the actual (last observed) status of the pipeline. The pipeline runner service continuously monitors the desired status field to decide where to steer the pipeline towards.

There are two desired statuses:

• Provisioned (set by invoking /start)
• Stopped (set by invoking /stop?force=true)

The user can monitor the current status of the pipeline via the GET /v0/pipelines/{name} endpoint. In a typical scenario, the user first sets the desired status, 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_resources_status attribute changes to Provisioned indicating that the pipeline has been successfully provisioned, or Stopped with deployment_error being set.

JSON schema

{
 "description": "Pipeline resources status.\n\n```text\n/start (early start failed)\n┌───────────────────┐\n│                   ▼\nStopped ◄────────── Stopping\n/start │                   ▲\n│                   │ /stop?force=true\n│                   │ OR: timeout (from Provisioning)\n▼                   │ OR: fatal runtime or resource error\n⌛Provisioning ────────────│ OR: runtime status is Suspended\n│                   │\n│                   │\n▼                   │\nProvisioned ─────────────┘\n```\n\n### Desired and actual status\n\nWe use the desired state model to manage the lifecycle of a pipeline. In this model, the\npipeline has two status attributes associated with it: the **desired** status, which represents\nwhat the user would like the pipeline to do, and the **current** status, which represents the\nactual (last observed) status of the pipeline. The pipeline runner service continuously monitors\nthe desired status field to decide where to steer the pipeline towards.\n\nThere are two desired statuses:\n- `Provisioned` (set by invoking `/start`)\n- `Stopped` (set by invoking `/stop?force=true`)\n\nThe user can monitor the current status of the pipeline via the `GET /v0/pipelines/{name}`\nendpoint. In a typical scenario, the user first sets the desired status, e.g., by invoking the\n`/start` endpoint, and then polls the `GET /v0/pipelines/{name}` endpoint to monitor the actual\nstatus of the pipeline until its `deployment_resources_status` attribute changes to\n`Provisioned` indicating that the pipeline has been successfully provisioned, or `Stopped` with\n`deployment_error` being set.",
 "type": "string",
 "enum": [
   "Stopped",
   "Provisioning",
   "Provisioned",
   "Stopping"
 ]
}

Variants

Stopped

Provisioning

Provisioned

Stopping

Trait Implementations

impl Clone for ResourcesStatus

fn clone(&self) -> ResourcesStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourcesStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourcesStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ResourcesStatus> for ResourcesStatus

fn from(value: &ResourcesStatus) -> Self

Converts to this type from the input type.

impl FromStr for ResourcesStatus

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 ResourcesStatus

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 ResourcesStatus

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

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

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

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 ResourcesStatus

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<&String> for ResourcesStatus

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 ResourcesStatus

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 ResourcesStatus

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 ResourcesStatus

impl Eq for ResourcesStatus

impl StructuralPartialEq for ResourcesStatus