Class: Google::Cloud::Bigtable::Table::ClusterState

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/table/cluster_state.rb

Overview

Table::ClusterState is the state of a table's data in a particular cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#cluster_name ⇒ Object (readonly)

Returns the value of attribute cluster_name.



25
26
27
 
# File 'lib/google/cloud/bigtable/table/cluster_state.rb', line 25

def cluster_name
  @cluster_name
end

Instance Method Details

#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.

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/google/cloud/bigtable/table/cluster_state.rb', line 54

def initializing?
  replication_state == :INITIALIZING
end

#planned_maintenance? ⇒ Boolean

The table is temporarily unable to serve requests from this cluster due to planned internal maintenance.

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/google/cloud/bigtable/table/cluster_state.rb', line 63

def planned_maintenance?
  replication_state == :PLANNED_MAINTENANCE
end

#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.

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/google/cloud/bigtable/table/cluster_state.rb', line 82

def ready?
  replication_state == :READY
end

#replication_state ⇒ Symbol

The state of replication for the table in this cluster. Valid values are:

  • :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.

Returns:

  • (Symbol) 


44
45
46
 
# File 'lib/google/cloud/bigtable/table/cluster_state.rb', line 44

def replication_state
  @grpc.replication_state
end

#unplanned_maintenance? ⇒ Boolean

The table is temporarily unable to serve requests from this cluster due to unplanned or emergency maintenance.

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/google/cloud/bigtable/table/cluster_state.rb', line 72

def unplanned_maintenance?
  replication_state == :UNPLANNED_MAINTENANCE
end