Cloud Bigtable V2 Client - Class Cluster (1.23.0)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\Bigtable\Admin\V2\Cluster\ClusterConfig

Configuration for this cluster.

↳ 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]*.

Returns
TypeDescription
string

setName

The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The current state of the cluster.

Returns
TypeDescription
int

setState

Output only. The current state of the cluster.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getServeNodes

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

Returns
TypeDescription
int

setServeNodes

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getClusterConfig

Configuration for this cluster.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\Cluster\ClusterConfig|null

hasClusterConfig

setClusterConfig

Configuration for this cluster.

Parameter
NameDescription
var Google\Cloud\Bigtable\Admin\V2\Cluster\ClusterConfig
Returns
TypeDescription
$this

getDefaultStorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

Returns
TypeDescription
int

setDefaultStorageType

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEncryptionConfig

Immutable. The encryption configuration for CMEK-protected clusters.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\Cluster\EncryptionConfig|null

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig

Immutable. The encryption configuration for CMEK-protected clusters.

Parameter
NameDescription
var Google\Cloud\Bigtable\Admin\V2\Cluster\EncryptionConfig
Returns
TypeDescription
$this

getConfig

Returns
TypeDescription
string