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 all Tables in the parent Instance .
Generated from protobuf message google.bigtable.admin.v2.Cluster
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique name of the cluster. Values are of the form projects/{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 form projects/{project}/locations/{zone}
.
↳ state
int
Output only. The current state of the cluster.
↳ serve_nodes
int
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
↳ cluster_config
↳ default_storage_type
int
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
↳ encryption_config
Google\Cloud\Bigtable\Admin\V2\Cluster\EncryptionConfig
Immutable. The encryption configuration for CMEK-protected clusters.
getName
The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*
.
string
setName
The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*
.
var
string
$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
form projects/{project}/locations/{zone}
.
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
form projects/{project}/locations/{zone}
.
var
string
$this
getState
Output only. The current state of the cluster.
int
setState
Output only. The current state of the cluster.
var
int
$this
getServeNodes
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
int
setServeNodes
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
var
int
$this
getClusterConfig
Configuration for this cluster.
hasClusterConfig
setClusterConfig
Configuration for this cluster.
$this
getDefaultStorageType
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
int
setDefaultStorageType
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
var
int
$this
getEncryptionConfig
Immutable. The encryption configuration for CMEK-protected clusters.
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Immutable. The encryption configuration for CMEK-protected clusters.
$this
getConfig
string
