Reference documentation and code samples for the Cloud Bigtable V2 Client class Cluster.
A resizable group of nodes in a particular cloud location, capable
of serving allTablesin the parentInstance.
Generated from protobuf messagegoogle.bigtable.admin.v2.Cluster
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique name of the cluster. Values are of the formprojects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.
↳ location
string
Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the formprojects/{project}/locations/{zone}.
↳ state
int
Output only. The current state of the cluster.
↳ serve_nodes
int
The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
↳ node_scaling_factor
int
Immutable. The node scaling factor of this cluster.
Immutable. The encryption configuration for CMEK-protected clusters.
getName
The unique name of the cluster. Values are of the formprojects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.
Returns
Type
Description
string
setName
The unique name of the cluster. Values are of the formprojects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLocation
Immutable. The location where this cluster's nodes and storage reside. For
best performance, clients should be located as close as possible to this
cluster. Currently only zones are supported, so values should be of the
formprojects/{project}/locations/{zone}.
Returns
Type
Description
string
setLocation
Immutable. The location where this cluster's nodes and storage reside. For
best performance, clients should be located as close as possible to this
cluster. Currently only zones are supported, so values should be of the
formprojects/{project}/locations/{zone}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getState
Output only. The current state of the cluster.
Returns
Type
Description
int
setState
Output only. The current state of the cluster.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getServeNodes
The number of nodes in the cluster. If no value is set,
Cloud Bigtable automatically allocates nodes based on your data footprint
and optimized for 50% storage utilization.
Returns
Type
Description
int
setServeNodes
The number of nodes in the cluster. If no value is set,
Cloud Bigtable automatically allocates nodes based on your data footprint
and optimized for 50% storage utilization.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getNodeScalingFactor
Immutable. The node scaling factor of this cluster.
Returns
Type
Description
int
setNodeScalingFactor
Immutable. The node scaling factor of this 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-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class Cluster (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Cluster)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.Cluster)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.Cluster)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.Cluster)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.Cluster)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.Cluster)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.Cluster)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.Cluster)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.Cluster)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.Cluster)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.Cluster)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.Cluster)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.Cluster)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.Cluster)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.Cluster)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.Cluster)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.Cluster)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.Cluster)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.Cluster)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.Cluster)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.Cluster)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.Cluster)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.Cluster)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.Cluster)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.Cluster)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.Cluster)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.Cluster)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.Cluster)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.Cluster)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.Cluster)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.Cluster) \nReference documentation and code samples for the Cloud Bigtable V2 Client class Cluster.\n\nA resizable group of nodes in a particular cloud location, capable\nof serving all [Tables](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Table) in the parent\n[Instance](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Instance).\n\nGenerated from protobuf message `google.bigtable.admin.v2.Cluster`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique name of the cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.\n\n### setName\n\nThe unique name of the cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.\n\n### getLocation\n\nImmutable. The location where this cluster's nodes and storage reside. For\nbest performance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/{project}/locations/{zone}`.\n\n### setLocation\n\nImmutable. The location where this cluster's nodes and storage reside. For\nbest performance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/{project}/locations/{zone}`.\n\n### getState\n\nOutput only. The current state of the cluster.\n\n### setState\n\nOutput only. The current state of the cluster.\n\n### getServeNodes\n\nThe number of nodes in the cluster. If no value is set,\nCloud Bigtable automatically allocates nodes based on your data footprint\nand optimized for 50% storage utilization.\n\n### setServeNodes\n\nThe number of nodes in the cluster. If no value is set,\nCloud Bigtable automatically allocates nodes based on your data footprint\nand optimized for 50% storage utilization.\n\n### getNodeScalingFactor\n\nImmutable. The node scaling factor of this cluster.\n\n### setNodeScalingFactor\n\nImmutable. The node scaling factor of this cluster.\n\n### getClusterConfig\n\nConfiguration for this cluster.\n\n### hasClusterConfig\n\n### setClusterConfig\n\nConfiguration for this cluster.\n\n### getDefaultStorageType\n\nImmutable. The type of storage used by this cluster to serve its\nparent instance's tables, unless explicitly overridden.\n\n### setDefaultStorageType\n\nImmutable. The type of storage used by this cluster to serve its\nparent instance's tables, unless explicitly overridden.\n\n### getEncryptionConfig\n\nImmutable. The encryption configuration for CMEK-protected clusters.\n\n### hasEncryptionConfig\n\n### clearEncryptionConfig\n\n### setEncryptionConfig\n\nImmutable. The encryption configuration for CMEK-protected clusters.\n\n### getConfig"]]
