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
- (::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig) — Configuration for this cluster.
#cluster_config=
def cluster_config=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig
Parameter
- value (::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig) — Configuration for this cluster.
Returns
- (::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig) — Configuration for this cluster.
#default_storage_type
def default_storage_type() -> ::Google::Cloud::Bigtable::Admin::V2::StorageType
Returns
- (::Google::Cloud::Bigtable::Admin::V2::StorageType) — Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
#default_storage_type=
def default_storage_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::StorageType
Parameter
- value (::Google::Cloud::Bigtable::Admin::V2::StorageType) — Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
Returns
- (::Google::Cloud::Bigtable::Admin::V2::StorageType) — Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
#encryption_config
def encryption_config() -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig
Returns
- (::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig) — Immutable. The encryption configuration for CMEK-protected clusters.
#encryption_config=
def encryption_config=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig
Parameter
- value (::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig) — Immutable. The encryption configuration for CMEK-protected clusters.
Returns
- (::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig) — Immutable. The encryption configuration for CMEK-protected clusters.
#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]*.
#node_scaling_factor
def node_scaling_factor() -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::NodeScalingFactor
Returns
- (::Google::Cloud::Bigtable::Admin::V2::Cluster::NodeScalingFactor) — Immutable. The node scaling factor of this cluster.
#node_scaling_factor=
def node_scaling_factor=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster::NodeScalingFactor
Parameter
- value (::Google::Cloud::Bigtable::Admin::V2::Cluster::NodeScalingFactor) — Immutable. The node scaling factor of this cluster.
Returns
- (::Google::Cloud::Bigtable::Admin::V2::Cluster::NodeScalingFactor) — Immutable. The node scaling factor of this cluster.
#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
- (::Google::Cloud::Bigtable::Admin::V2::Cluster::State) — Output only. The current state of the cluster.