Class: Google::Bigtable::Admin::V2::Table
- Inherits:
-
Object
- Object
- Google::Bigtable::Admin::V2::Table
- Defined in:
- lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb
Overview
A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Defined Under Namespace
Modules: TimestampGranularity, View Classes: ClusterState
Instance Attribute Summary collapse
-
#cluster_states ⇒ Hash{String => Google::Bigtable::Admin::V2::Table::ClusterState}
Output only.
-
#column_families ⇒ Hash{String => Google::Bigtable::Admin::V2::ColumnFamily}
(
CreationOnly
) The column families configured for this table, mapped by column family ID. -
#granularity ⇒ Google::Bigtable::Admin::V2::Table::TimestampGranularity
(
CreationOnly
) The granularity (i.e.MILLIS
) at which timestamps are stored in this table. -
#name ⇒ String
Output only.
-
#restore_info ⇒ Google::Bigtable::Admin::V2::RestoreInfo
Output only.
Instance Attribute Details
#cluster_states ⇒ Hash{String => Google::Bigtable::Admin::V2::Table::ClusterState}
Returns 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
, FULL
.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 60 class Table # The state of a table's data in a particular cluster. # @!attribute [rw] replication_state # @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState] # Output only. The state of replication for the table in this cluster. class ClusterState # 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 # Possible timestamp granularities to use when keeping multiple versions # of data in a table. module TimestampGranularity # The user did not specify a granularity. Should not be returned. # When specified during table creation, MILLIS will be used. TIMESTAMP_GRANULARITY_UNSPECIFIED = 0 # The table keeps data versioned at a granularity of 1ms. MILLIS = 1 end # Defines a view over a table's fields. module View # Uses the default view for each method as documented in its request. VIEW_UNSPECIFIED = 0 # Only populates `name`. NAME_ONLY = 1 # Only populates `name` and fields related to the table's schema. SCHEMA_VIEW = 2 # Only populates `name` and fields related to the table's replication # state. REPLICATION_VIEW = 3 # Populates all fields. FULL = 4 end end |
#column_families ⇒ Hash{String => Google::Bigtable::Admin::V2::ColumnFamily}
Returns (CreationOnly
)
The column families configured for this table, mapped by column family ID.
Views: SCHEMA_VIEW
, FULL
.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 60 class Table # The state of a table's data in a particular cluster. # @!attribute [rw] replication_state # @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState] # Output only. The state of replication for the table in this cluster. class ClusterState # 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 # Possible timestamp granularities to use when keeping multiple versions # of data in a table. module TimestampGranularity # The user did not specify a granularity. Should not be returned. # When specified during table creation, MILLIS will be used. TIMESTAMP_GRANULARITY_UNSPECIFIED = 0 # The table keeps data versioned at a granularity of 1ms. MILLIS = 1 end # Defines a view over a table's fields. module View # Uses the default view for each method as documented in its request. VIEW_UNSPECIFIED = 0 # Only populates `name`. NAME_ONLY = 1 # Only populates `name` and fields related to the table's schema. SCHEMA_VIEW = 2 # Only populates `name` and fields related to the table's replication # state. REPLICATION_VIEW = 3 # Populates all fields. FULL = 4 end end |
#granularity ⇒ Google::Bigtable::Admin::V2::Table::TimestampGranularity
Returns (CreationOnly
)
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
.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 60 class Table # The state of a table's data in a particular cluster. # @!attribute [rw] replication_state # @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState] # Output only. The state of replication for the table in this cluster. class ClusterState # 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 # Possible timestamp granularities to use when keeping multiple versions # of data in a table. module TimestampGranularity # The user did not specify a granularity. Should not be returned. # When specified during table creation, MILLIS will be used. TIMESTAMP_GRANULARITY_UNSPECIFIED = 0 # The table keeps data versioned at a granularity of 1ms. MILLIS = 1 end # Defines a view over a table's fields. module View # Uses the default view for each method as documented in its request. VIEW_UNSPECIFIED = 0 # Only populates `name`. NAME_ONLY = 1 # Only populates `name` and fields related to the table's schema. SCHEMA_VIEW = 2 # Only populates `name` and fields related to the table's replication # state. REPLICATION_VIEW = 3 # Populates all fields. FULL = 4 end end |
#name ⇒ String
Returns Output only. 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
.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 60 class Table # The state of a table's data in a particular cluster. # @!attribute [rw] replication_state # @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState] # Output only. The state of replication for the table in this cluster. class ClusterState # 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 # Possible timestamp granularities to use when keeping multiple versions # of data in a table. module TimestampGranularity # The user did not specify a granularity. Should not be returned. # When specified during table creation, MILLIS will be used. TIMESTAMP_GRANULARITY_UNSPECIFIED = 0 # The table keeps data versioned at a granularity of 1ms. MILLIS = 1 end # Defines a view over a table's fields. module View # Uses the default view for each method as documented in its request. VIEW_UNSPECIFIED = 0 # Only populates `name`. NAME_ONLY = 1 # Only populates `name` and fields related to the table's schema. SCHEMA_VIEW = 2 # Only populates `name` and fields related to the table's replication # state. REPLICATION_VIEW = 3 # Populates all fields. FULL = 4 end end |
#restore_info ⇒ Google::Bigtable::Admin::V2::RestoreInfo
Returns 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.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 60 class Table # The state of a table's data in a particular cluster. # @!attribute [rw] replication_state # @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState] # Output only. The state of replication for the table in this cluster. class ClusterState # 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 # Possible timestamp granularities to use when keeping multiple versions # of data in a table. module TimestampGranularity # The user did not specify a granularity. Should not be returned. # When specified during table creation, MILLIS will be used. TIMESTAMP_GRANULARITY_UNSPECIFIED = 0 # The table keeps data versioned at a granularity of 1ms. MILLIS = 1 end # Defines a view over a table's fields. module View # Uses the default view for each method as documented in its request. VIEW_UNSPECIFIED = 0 # Only populates `name`. NAME_ONLY = 1 # Only populates `name` and fields related to the table's schema. SCHEMA_VIEW = 2 # Only populates `name` and fields related to the table's replication # state. REPLICATION_VIEW = 3 # Populates all fields. FULL = 4 end end |