Class: Google::Cloud::Bigtable::Admin::V2::Cluster
- Inherits:
-
Object
- Object
- Google::Cloud::Bigtable::Admin::V2::Cluster
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/bigtable/admin/v2/instance.rb
Overview
Defined Under Namespace
Modules: State
Instance Attribute Summary collapse
-
#default_storage_type ⇒ ::Google::Cloud::Bigtable::Admin::V2::StorageType
(
CreationOnly
) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. -
#location ⇒ ::String
(
CreationOnly
) The location where this cluster's nodes and storage reside. -
#name ⇒ ::String
readonly
The unique name of the cluster.
-
#serve_nodes ⇒ ::Integer
Required.
-
#state ⇒ ::Google::Cloud::Bigtable::Admin::V2::Cluster::State
readonly
The current state of the cluster.
Instance Attribute Details
#default_storage_type ⇒ ::Google::Cloud::Bigtable::Admin::V2::StorageType
Returns (CreationOnly
)
The type of storage used by this cluster to serve its
parent instance's tables, unless explicitly overridden.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 133 class Cluster include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Possible states of a cluster. module State # The state of the cluster could not be determined. STATE_NOT_KNOWN = 0 # The cluster has been successfully created and is ready to serve requests. READY = 1 # The cluster is currently being created, and may be destroyed # if the creation process encounters an error. # A cluster may not be able to serve requests while being created. CREATING = 2 # The cluster is currently being resized, and may revert to its previous # node count if the process encounters an error. # A cluster is still capable of serving requests while being resized, # but may exhibit performance as if its number of allocated nodes is # between the starting and requested states. RESIZING = 3 # The cluster has no backing nodes. The data (tables) still # exist, but no operations can be performed on the cluster. DISABLED = 4 end end |
#location ⇒ ::String
Returns (CreationOnly
)
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}
.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 133 class Cluster include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Possible states of a cluster. module State # The state of the cluster could not be determined. STATE_NOT_KNOWN = 0 # The cluster has been successfully created and is ready to serve requests. READY = 1 # The cluster is currently being created, and may be destroyed # if the creation process encounters an error. # A cluster may not be able to serve requests while being created. CREATING = 2 # The cluster is currently being resized, and may revert to its previous # node count if the process encounters an error. # A cluster is still capable of serving requests while being resized, # but may exhibit performance as if its number of allocated nodes is # between the starting and requested states. RESIZING = 3 # The cluster has no backing nodes. The data (tables) still # exist, but no operations can be performed on the cluster. DISABLED = 4 end end |
#name ⇒ ::String (readonly)
Returns The unique name of the cluster. Values are of the form
projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*
.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 133 class Cluster include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Possible states of a cluster. module State # The state of the cluster could not be determined. STATE_NOT_KNOWN = 0 # The cluster has been successfully created and is ready to serve requests. READY = 1 # The cluster is currently being created, and may be destroyed # if the creation process encounters an error. # A cluster may not be able to serve requests while being created. CREATING = 2 # The cluster is currently being resized, and may revert to its previous # node count if the process encounters an error. # A cluster is still capable of serving requests while being resized, # but may exhibit performance as if its number of allocated nodes is # between the starting and requested states. RESIZING = 3 # The cluster has no backing nodes. The data (tables) still # exist, but no operations can be performed on the cluster. DISABLED = 4 end end |
#serve_nodes ⇒ ::Integer
Returns Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 133 class Cluster include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Possible states of a cluster. module State # The state of the cluster could not be determined. STATE_NOT_KNOWN = 0 # The cluster has been successfully created and is ready to serve requests. READY = 1 # The cluster is currently being created, and may be destroyed # if the creation process encounters an error. # A cluster may not be able to serve requests while being created. CREATING = 2 # The cluster is currently being resized, and may revert to its previous # node count if the process encounters an error. # A cluster is still capable of serving requests while being resized, # but may exhibit performance as if its number of allocated nodes is # between the starting and requested states. RESIZING = 3 # The cluster has no backing nodes. The data (tables) still # exist, but no operations can be performed on the cluster. DISABLED = 4 end end |
#state ⇒ ::Google::Cloud::Bigtable::Admin::V2::Cluster::State (readonly)
Returns The current state of the cluster.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'proto_docs/google/bigtable/admin/v2/instance.rb', line 133 class Cluster include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Possible states of a cluster. module State # The state of the cluster could not be determined. STATE_NOT_KNOWN = 0 # The cluster has been successfully created and is ready to serve requests. READY = 1 # The cluster is currently being created, and may be destroyed # if the creation process encounters an error. # A cluster may not be able to serve requests while being created. CREATING = 2 # The cluster is currently being resized, and may revert to its previous # node count if the process encounters an error. # A cluster is still capable of serving requests while being resized, # but may exhibit performance as if its number of allocated nodes is # between the starting and requested states. RESIZING = 3 # The cluster has no backing nodes. The data (tables) still # exist, but no operations can be performed on the cluster. DISABLED = 4 end end |