Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Table (v0.22.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

#change_stream_config

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

Returns

(::Google::Cloud::Bigtable::Admin::V2::ChangeStreamConfig) — If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.

#change_stream_config=

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

Parameter

value (::Google::Cloud::Bigtable::Admin::V2::ChangeStreamConfig) — If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.

Returns

(::Google::Cloud::Bigtable::Admin::V2::ChangeStreamConfig) — If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.

#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

(::Google::Cloud::Bigtable::Admin::V2::Table::TimestampGranularity) — Immutable. The granularity (i.e. MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to MILLIS. Views: SCHEMA_VIEW, FULL.

#granularity=

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

Parameter

value (::Google::Cloud::Bigtable::Admin::V2::Table::TimestampGranularity) — Immutable. The granularity (i.e. MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to MILLIS. Views: SCHEMA_VIEW, FULL.

Returns

(::Google::Cloud::Bigtable::Admin::V2::Table::TimestampGranularity) — Immutable. The granularity (i.e. MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to MILLIS. Views: SCHEMA_VIEW, FULL.

#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

(::Google::Cloud::Bigtable::Admin::V2::RestoreInfo) — Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.