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.
Enum Variants |
|
|---|---|
| Name | Description |
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 |
If set, the enum was initialized with an unknown value. Applications can examine the value using [PipelineState::value] or [PipelineState::name]. |
Implementations |
|
|---|---|
| Name | Description |
value |
Gets the enum value. Returns |
name |
Gets the enum value as a string. Returns |