Reference documentation and code samples for the Cloud Bigtable API class Google::Cloud::Bigtable::Table::ClusterState.
Table::ClusterState is the state of a table's data in a particular cluster.
Inherits
- Object
Example
Retrieve a table with cluster states.
require "google/cloud/bigtable" bigtable = Google::Cloud::Bigtable.new table = bigtable.table "my-instance", "my-table", view: :FULL, perform_lookup: true table.cluster_states.each do |cs| puts cs.cluster_name puts cs.replication_state puts cs.encryption_infos.first.encryption_type end
Methods
#cluster_name
def cluster_name() -> String
The name of the cluster.
- (String) — the current value of cluster_name
#cluster_name=
def cluster_name=(value) -> String
The name of the cluster.
- value (String) — the newly set value
- (String) — the newly set value
#encryption_infos
def encryption_infos() -> Array<Google::Cloud::Bigtable::EncryptionInfo>
The encryption info value objects for the table in this cluster. The encryption info
is only present when the table view is ENCRYPTION_VIEW
or FULL
. See also
Instance::ClusterMap#add.
- (Array<Google::Cloud::Bigtable::EncryptionInfo>) — The array of encryption info value objects, or an empty array if none are present.
#initializing?
def initializing?() -> Boolean
The cluster was recently created, and the table must finish copying over pre-existing data from other clusters before it can begin receiving live replication updates and serving.
-
(Boolean) —
true
if the value of #replication_state isINITIALIZING
,false
otherwise.
#planned_maintenance?
def planned_maintenance?() -> Boolean
The table is temporarily unable to serve requests from this cluster due to planned internal maintenance.
-
(Boolean) —
true
if the value of #replication_state isPLANNED_MAINTENANCE
,false
otherwise.
#ready?
def ready?() -> Boolean
The table can serve requests from this cluster. Depending on replication delay, reads may not immediately reflect the state of the table in other clusters.
-
(Boolean) —
true
if the value of #replication_state isREADY
,false
otherwise.
#ready_optimizing?
def ready_optimizing?() -> Boolean
The table is fully created and ready for use after a
restore, and is being optimized for performance. When
optimizations are complete, the table will transition to READY
state.
-
(Boolean) —
true
if the value of #replication_state isREADY_OPTIMIZING
,false
otherwise.
#replication_state
def replication_state() -> Symbol
The state of replication for the table in this cluster. Valid values include:
:INITIALIZING
- The cluster was recently created.:PLANNED_MAINTENANCE
- The table is temporarily unable to serve.:UNPLANNED_MAINTENANCE
- The table is temporarily unable to serve.:READY
- The table can serve.:READY_OPTIMIZING
- The table is fully created and ready for use after a restore, and is being optimized for performance. When optimizations are complete, the table will transition toREADY
state.:STATE_NOT_KNOWN
- If replication state is not present in the object because the table view is notREPLICATION_VIEW
orFULL
.:UNKNOWN
- If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable.)
- (Symbol) — The state of replication.
#unplanned_maintenance?
def unplanned_maintenance?() -> Boolean
The table is temporarily unable to serve requests from this cluster due to unplanned or emergency maintenance.
-
(Boolean) —
true
if the value of #replication_state isUNPLANNED_MAINTENANCE
,false
otherwise.