PipelineState

Required. 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.

Entries

Link copied to clipboard

The pipeline state isn't specified.

Link copied to clipboard

The pipeline is getting started or resumed. When finished, the pipeline state will be 'PIPELINE_STATE_ACTIVE'.

Link copied to clipboard

The pipeline is actively running.

Link copied to clipboard

The pipeline is in the process of stopping. When finished, the pipeline state will be 'PIPELINE_STATE_ARCHIVED'.

Link copied to clipboard

The pipeline has been stopped. This is a terminal state and cannot be undone.

Link copied to clipboard

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.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun toJava(): PipelineState
Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.

Properties

Link copied to clipboard
val javaValue: PipelineState
Link copied to clipboard
Link copied to clipboard