state property

String? state
getter/setter pair

The state of the pipeline.

When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.

Required. Possible string values are:

  • "STATE_UNSPECIFIED" : The pipeline state isn't specified.
  • "STATE_RESUMING" : The pipeline is getting started or resumed. When finished, the pipeline state will be 'PIPELINE_STATE_ACTIVE'.
  • "STATE_ACTIVE" : The pipeline is actively running.
  • "STATE_STOPPING" : The pipeline is in the process of stopping. When finished, the pipeline state will be 'PIPELINE_STATE_ARCHIVED'.
  • "STATE_ARCHIVED" : The pipeline has been stopped. This is a terminal state and cannot be undone.
  • "STATE_PAUSED" : The pipeline is paused. This is a non-terminal state. When the pipeline is paused, it will hold processing jobs, but can be resumed later. For a batch pipeline, this means pausing the scheduler job. For a streaming pipeline, creating a job snapshot to resume from will give the same effect.

Implementation

core.String? state;