Class: Google::Cloud::Bigtable::Admin::V2::Table::ClusterState

Inherits:

Object

Object
Google::Cloud::Bigtable::Admin::V2::Table::ClusterState

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/bigtable/admin/v2/table.rb

Overview

The state of a table's data in a particular cluster.

Defined Under Namespace

Modules: ReplicationState

Instance Attribute Summary collapse

#encryption_info ⇒ ::Array<::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo> readonly
Output only.
#replication_state ⇒ ::Google::Cloud::Bigtable::Admin::V2::Table::ClusterState::ReplicationState readonly
Output only.

Instance Attribute Details

#encryption_info ⇒ `::Array<::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo>` (readonly)

Returns Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.

Returns:

(::Array<::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo>) —
Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.

# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 113

class ClusterState
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Table replication states.
  module ReplicationState
    # The replication state of the table is unknown in this cluster.
    STATE_NOT_KNOWN = 0

    # 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 Data API requests.
    INITIALIZING = 1

    # The table is temporarily unable to serve Data API requests from this
    # cluster due to planned internal maintenance.
    PLANNED_MAINTENANCE = 2

    # The table is temporarily unable to serve Data API requests from this
    # cluster due to unplanned or emergency maintenance.
    UNPLANNED_MAINTENANCE = 3

    # The table can serve Data API requests from this cluster. Depending on
    # replication delay, reads may not immediately reflect the state of the
    # table in other clusters.
    READY = 4

    # 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.
    READY_OPTIMIZING = 5
  end
end

#replication_state ⇒ `::Google::Cloud::Bigtable::Admin::V2::Table::ClusterState::ReplicationState` (readonly)

Returns Output only. The state of replication for the table in this cluster.