Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1beta Client class State.
Cluster State
Protobuf type google.cloud.alloydb.v1beta.Cluster.State
Methods
name
Parameter | |
---|---|
Name | Description |
value |
mixed
|
value
Parameter | |
---|---|
Name | Description |
name |
mixed
|
Constants
STATE_UNSPECIFIED
Value: 0
The state of the cluster is unknown.
Generated from protobuf enum STATE_UNSPECIFIED = 0;
READY
Value: 1
The cluster is active and running.
Generated from protobuf enum READY = 1;
STOPPED
Value: 2
The cluster is stopped. All instances in the cluster are stopped.
Customers can start a stopped cluster at any point and all their instances will come back to life with same names and IP resources. In this state, customer pays for storage. Associated backups could also be present in a stopped cluster.
Generated from protobuf enum STOPPED = 2;
PBEMPTY
Value: 3
The cluster is empty and has no associated resources.
All instances, associated storage and backups have been deleted.
Generated from protobuf enum EMPTY = 3;
CREATING
Value: 4
The cluster is being created.
Generated from protobuf enum CREATING = 4;
DELETING
Value: 5
The cluster is being deleted.
Generated from protobuf enum DELETING = 5;
FAILED
Value: 6
The creation of the cluster failed.
Generated from protobuf enum FAILED = 6;
BOOTSTRAPPING
Value: 7
The cluster is bootstrapping with data from some other source.
Direct mutations to the cluster (e.g. adding read pool) are not allowed.
Generated from protobuf enum BOOTSTRAPPING = 7;
MAINTENANCE
Value: 8
The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.
Generated from protobuf enum MAINTENANCE = 8;
PROMOTING
Value: 9
The cluster is being promoted.
Generated from protobuf enum PROMOTING = 9;