Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Cluster (v1.3.0)

Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::Cluster.

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cluster_config

def cluster_config() -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig
Returns

#cluster_config=

def cluster_config=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig
Parameter
Returns

#default_storage_type

def default_storage_type() -> ::Google::Cloud::Bigtable::Admin::V2::StorageType
Returns

#default_storage_type=

def default_storage_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::StorageType
Parameter
Returns

#encryption_config

def encryption_config() -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig
Returns

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig
Parameter
Returns

#location

def location() -> ::String
Returns
  • (::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}.

#location=

def location=(value) -> ::String
Parameter
  • value (::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}.
Returns
  • (::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}.

#name

def name() -> ::String
Returns
  • (::String) — The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.
Returns
  • (::String) — The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.

#serve_nodes

def serve_nodes() -> ::Integer
Returns
  • (::Integer) — The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

#serve_nodes=

def serve_nodes=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
Returns
  • (::Integer) — The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

#state

def state() -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::State
Returns