Reference documentation and code samples for the Google Cloud Datastream V1 Client class State.
Stream state.
Protobuf type google.cloud.datastream.v1.Stream.State
Methods
name
Parameter | |
---|---|
Name | Description |
value |
mixed
|
value
Parameter | |
---|---|
Name | Description |
name |
mixed
|
Constants
STATE_UNSPECIFIED
Value: 0
Unspecified stream state.
Generated from protobuf enum STATE_UNSPECIFIED = 0;
NOT_STARTED
Value: 1
The stream has been created but has not yet started streaming data.
Generated from protobuf enum NOT_STARTED = 1;
RUNNING
Value: 2
The stream is running.
Generated from protobuf enum RUNNING = 2;
PAUSED
Value: 3
The stream is paused.
Generated from protobuf enum PAUSED = 3;
MAINTENANCE
Value: 4
The stream is in maintenance mode.
Updates are rejected on the resource in this state.
Generated from protobuf enum MAINTENANCE = 4;
FAILED
Value: 5
The stream is experiencing an error that is preventing data from being streamed.
Generated from protobuf enum FAILED = 5;
FAILED_PERMANENTLY
Value: 6
The stream has experienced a terminal failure.
Generated from protobuf enum FAILED_PERMANENTLY = 6;
STARTING
Value: 7
The stream is starting, but not yet running.
Generated from protobuf enum STARTING = 7;
DRAINING
Value: 8
The Stream is no longer reading new events, but still writing events in the buffer.
Generated from protobuf enum DRAINING = 8;