Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Table (v1.2.0)

Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::Table.

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#automated_backup_policy

def automated_backup_policy() -> ::Google::Cloud::Bigtable::Admin::V2::Table::AutomatedBackupPolicy
Returns

#automated_backup_policy=

def automated_backup_policy=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Table::AutomatedBackupPolicy
Parameter
Returns

#change_stream_config

def change_stream_config() -> ::Google::Cloud::Bigtable::Admin::V2::ChangeStreamConfig
Returns

#change_stream_config=

def change_stream_config=(value) -> ::Google::Cloud::Bigtable::Admin::V2::ChangeStreamConfig
Parameter
Returns

#cluster_states

def cluster_states() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::Table::ClusterState}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::Table::ClusterState}) — Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN replication_status. Views: REPLICATION_VIEW, ENCRYPTION_VIEW, FULL

#column_families

def column_families() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily}) — The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL

#column_families=

def column_families=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily}) — The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily}) — The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL

#deletion_protection

def deletion_protection() -> ::Boolean
Returns
  • (::Boolean) — Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited:

    • The table.
    • The column families in the table.
    • The instance containing the table.

    Note one can still delete the data stored in the table through Data APIs.

#deletion_protection=

def deletion_protection=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited:

    • The table.
    • The column families in the table.
    • The instance containing the table.

    Note one can still delete the data stored in the table through Data APIs.

Returns
  • (::Boolean) — Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited:

    • The table.
    • The column families in the table.
    • The instance containing the table.

    Note one can still delete the data stored in the table through Data APIs.

#granularity

def granularity() -> ::Google::Cloud::Bigtable::Admin::V2::Table::TimestampGranularity
Returns

#granularity=

def granularity=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Table::TimestampGranularity
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL
Returns
  • (::String) — The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

#restore_info

def restore_info() -> ::Google::Cloud::Bigtable::Admin::V2::RestoreInfo
Returns