Reference documentation and code samples for the Cloud Bigtable V2 Client class State.
Possible states of a cluster.
Protobuf type google.bigtable.admin.v2.Cluster.State
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2 \ Cluster
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
STATE_NOT_KNOWN
Value: 0
The state of the cluster could not be determined.
Generated from protobuf enum STATE_NOT_KNOWN = 0;
READY
Value: 1
The cluster has been successfully created and is ready to serve requests.
Generated from protobuf enum READY = 1;
CREATING
Value: 2
The cluster is currently being created, and may be destroyed
if the creation process encounters an error.
A cluster may not be able to serve requests while being created.
Generated from protobuf enum CREATING = 2;
RESIZING
Value: 3
The cluster is currently being resized, and may revert to its previous
node count if the process encounters an error.
A cluster is still capable of serving requests while being resized,
but may exhibit performance as if its number of allocated nodes is
between the starting and requested states.
Generated from protobuf enum RESIZING = 3;
DISABLED
Value: 4
The cluster has no backing nodes. The data (tables) still
exist, but no operations can be performed on the cluster.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class State (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Cluster.State)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.Cluster.State)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.Cluster.State)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.Cluster.State)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.Cluster.State)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.Cluster.State)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.Cluster.State)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.Cluster.State)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.Cluster.State)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.Cluster.State)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.Cluster.State)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.Cluster.State)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.Cluster.State)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.Cluster.State)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.Cluster.State)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.Cluster.State)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.Cluster.State)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.Cluster.State)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.Cluster.State)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.Cluster.State)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.Cluster.State)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.Cluster.State)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.Cluster.State)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.Cluster.State)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.Cluster.State)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.Cluster.State)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.Cluster.State)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.Cluster.State)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.Cluster.State)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.Cluster.State)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.Cluster.State) \nReference documentation and code samples for the Cloud Bigtable V2 Client class State.\n\nPossible states of a cluster.\n\nProtobuf type `google.bigtable.admin.v2.Cluster.State`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2 \\\\ Cluster\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### STATE_NOT_KNOWN\n\n Value: 0\n\nThe state of the cluster could not be determined.\n\nGenerated from protobuf enum `STATE_NOT_KNOWN = 0;`\n\n### READY\n\n Value: 1\n\nThe cluster has been successfully created and is ready to serve requests.\n\nGenerated from protobuf enum `READY = 1;`\n\n### CREATING\n\n Value: 2\n\nThe cluster is currently being created, and may be destroyed\nif the creation process encounters an error.\n\nA cluster may not be able to serve requests while being created.\n\nGenerated from protobuf enum `CREATING = 2;`\n\n### RESIZING\n\n Value: 3\n\nThe cluster is currently being resized, and may revert to its previous\nnode count if the process encounters an error.\n\nA cluster is still capable of serving requests while being resized,\nbut may exhibit performance as if its number of allocated nodes is\nbetween the starting and requested states.\n\nGenerated from protobuf enum `RESIZING = 3;`\n\n### DISABLED\n\n Value: 4\n\nThe cluster has no backing nodes. The data (tables) still\nexist, but no operations can be performed on the cluster.\n\nGenerated from protobuf enum `DISABLED = 4;`"]]