Class: Google::Apis::BigtableadminV2::Table

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigtableadmin_v2/classes.rb,
lib/google/apis/bigtableadmin_v2/representations.rb,
lib/google/apis/bigtableadmin_v2/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Table

Returns a new instance of Table.



2378
2379
2380
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2378

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cluster_states ⇒ Hash<String,Google::Apis::BigtableadminV2::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 Corresponds to the JSON property clusterStates

Returns:



2331
2332
2333
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2331

def cluster_states
  @cluster_states
end

#column_families ⇒ Hash<String,Google::Apis::BigtableadminV2::ColumnFamily>

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL Corresponds to the JSON property columnFamilies

Returns:



2337
2338
2339
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2337

def column_families
  @column_families
end

#deletion_protection ⇒ Boolean Also known as: deletion_protection?

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. Corresponds to the JSON property deletionProtection

Returns:

  • (Boolean) 


2345
2346
2347
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2345

def deletion_protection
  @deletion_protection
end

#granularity ⇒ String

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. Corresponds to the JSON property granularity

Returns:

  • (String) 


2354
2355
2356
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2354

def granularity
  @granularity
end

#name ⇒ String

The unique name of the table. Values are of the form projects/project/ instances/instance/tables/_a-zA-Z0-9*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, STATS_VIEW, FULL Corresponds to the JSON property name

Returns:

  • (String) 


2361
2362
2363
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2361

def name
  @name
end

#restore_info ⇒ Google::Apis::BigtableadminV2::RestoreInfo

Information about a table restore. Corresponds to the JSON property restoreInfo

Returns:



2366
2367
2368
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2366

def restore_info
  @restore_info
end

#stats ⇒ Google::Apis::BigtableadminV2::TableStats

Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified. Corresponds to the JSON property stats

Returns:



2376
2377
2378
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2376

def stats
  @stats
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2383
2384
2385
2386
2387
2388
2389
2390
2391
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2383

def update!(**args)
  @cluster_states = args[:cluster_states] if args.key?(:cluster_states)
  @column_families = args[:column_families] if args.key?(:column_families)
  @deletion_protection = args[:deletion_protection] if args.key?(:deletion_protection)
  @granularity = args[:granularity] if args.key?(:granularity)
  @name = args[:name] if args.key?(:name)
  @restore_info = args[:restore_info] if args.key?(:restore_info)
  @stats = args[:stats] if args.key?(:stats)
end