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.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ name | stringThe unique name of the cluster. Values are of the form |
↳ location | stringImmutable. 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 |
↳ state | intOutput only. The current state of the cluster. |
↳ serve_nodes | intThe number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. |
↳ node_scaling_factor | intImmutable. The node scaling factor of this cluster. |
↳ cluster_config | Google\Cloud\Bigtable\Admin\V2\Cluster\ClusterConfigConfiguration for this cluster. |
↳ default_storage_type | intImmutable. 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\EncryptionConfigImmutable. 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]*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The unique name of the cluster. Values are of the form projects/{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 form projects/{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 form projects/{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 allocated to this cluster. More nodes enable higher throughput and more consistent performance.
| Returns | |
|---|---|
| Type | Description |
int | |
setServeNodes
The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterConfig
Configuration for this cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\Cluster\ClusterConfig|null | |
hasClusterConfig
setClusterConfig
Configuration for this cluster.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Cluster\ClusterConfig |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDefaultStorageType
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
| Returns | |
|---|---|
| Type | Description |
int | |
setDefaultStorageType
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptionConfig
Immutable. The encryption configuration for CMEK-protected clusters.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\Cluster\EncryptionConfig|null | |
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Immutable. The encryption configuration for CMEK-protected clusters.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Bigtable\Admin\V2\Cluster\EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
$this | |
getConfig
| Returns | |
|---|---|
| Type | Description |
string | |