Package com.google.bigtable.admin.v2

Interface TableOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Table, Table.Builder
public interface TableOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       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`
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       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`
      string name = 1;
      Returns:
      The bytes for name.

    • getClusterStatesCount

      int getClusterStatesCount()
       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`
      map<string, .google.bigtable.admin.v2.Table.ClusterState> cluster_states = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • containsClusterStates

      boolean containsClusterStates(String key)
       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`
      map<string, .google.bigtable.admin.v2.Table.ClusterState> cluster_states = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getClusterStates

      @Deprecated Map<String,Table.ClusterState> getClusterStates()
      Deprecated.
      Use getClusterStatesMap() instead.

    • getClusterStatesMap

      Map<String,Table.ClusterState> getClusterStatesMap()
       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`
      map<string, .google.bigtable.admin.v2.Table.ClusterState> cluster_states = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getClusterStatesOrDefault

      Table.ClusterState getClusterStatesOrDefault(String key, Table.ClusterState defaultValue)
       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`
      map<string, .google.bigtable.admin.v2.Table.ClusterState> cluster_states = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getClusterStatesOrThrow

      Table.ClusterState getClusterStatesOrThrow(String key)
       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`
      map<string, .google.bigtable.admin.v2.Table.ClusterState> cluster_states = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getColumnFamiliesCount

      int getColumnFamiliesCount()
       The column families configured for this table, mapped by column family ID.
 Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
      map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

    • containsColumnFamilies

      boolean containsColumnFamilies(String key)
       The column families configured for this table, mapped by column family ID.
 Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
      map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

    • getColumnFamilies

      @Deprecated Map<String,ColumnFamily> getColumnFamilies()
      Deprecated.
      Use getColumnFamiliesMap() instead.

    • getColumnFamiliesMap

      Map<String,ColumnFamily> getColumnFamiliesMap()
       The column families configured for this table, mapped by column family ID.
 Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
      map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

    • getColumnFamiliesOrDefault

      ColumnFamily getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue)
       The column families configured for this table, mapped by column family ID.
 Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
      map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

    • getColumnFamiliesOrThrow

      ColumnFamily getColumnFamiliesOrThrow(String key)
       The column families configured for this table, mapped by column family ID.
 Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
      map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

    • getGranularityValue

      int getGranularityValue()
       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`.
      .google.bigtable.admin.v2.Table.TimestampGranularity granularity = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for granularity.

    • getGranularity

      Table.TimestampGranularity getGranularity()
       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`.
      .google.bigtable.admin.v2.Table.TimestampGranularity granularity = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The granularity.

    • hasRestoreInfo

      boolean hasRestoreInfo()
       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.
      .google.bigtable.admin.v2.RestoreInfo restore_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the restoreInfo field is set.

    • getRestoreInfo

      RestoreInfo getRestoreInfo()
       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.
      .google.bigtable.admin.v2.RestoreInfo restore_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The restoreInfo.

    • getRestoreInfoOrBuilder

      RestoreInfoOrBuilder getRestoreInfoOrBuilder()
       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.
      .google.bigtable.admin.v2.RestoreInfo restore_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasChangeStreamConfig

      boolean hasChangeStreamConfig()
       If specified, enable the change stream on this table.
 Otherwise, the change stream is disabled and the change stream is not
 retained.
      .google.bigtable.admin.v2.ChangeStreamConfig change_stream_config = 8;
      Returns:
      Whether the changeStreamConfig field is set.

    • getChangeStreamConfig

      ChangeStreamConfig getChangeStreamConfig()
       If specified, enable the change stream on this table.
 Otherwise, the change stream is disabled and the change stream is not
 retained.
      .google.bigtable.admin.v2.ChangeStreamConfig change_stream_config = 8;
      Returns:
      The changeStreamConfig.

    • getChangeStreamConfigOrBuilder

      ChangeStreamConfigOrBuilder getChangeStreamConfigOrBuilder()
       If specified, enable the change stream on this table.
 Otherwise, the change stream is disabled and the change stream is not
 retained.
      .google.bigtable.admin.v2.ChangeStreamConfig change_stream_config = 8;

    • getDeletionProtection

      boolean getDeletionProtection()
       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.
      bool deletion_protection = 9;
      Returns:
      The deletionProtection.

    • hasAutomatedBackupPolicy

      boolean hasAutomatedBackupPolicy()
       If specified, automated backups are enabled for this table.
 Otherwise, automated backups are disabled.
      .google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13;
      Returns:
      Whether the automatedBackupPolicy field is set.

    • getAutomatedBackupPolicy

      Table.AutomatedBackupPolicy getAutomatedBackupPolicy()
       If specified, automated backups are enabled for this table.
 Otherwise, automated backups are disabled.
      .google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13;
      Returns:
      The automatedBackupPolicy.

    • getAutomatedBackupPolicyOrBuilder

      Table.AutomatedBackupPolicyOrBuilder getAutomatedBackupPolicyOrBuilder()
       If specified, automated backups are enabled for this table.
 Otherwise, automated backups are disabled.
      .google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13;

    • hasRowKeySchema

      boolean hasRowKeySchema()
       The row key schema for this table. The schema is used to decode the raw row
 key bytes into a structured format. The order of field declarations in this
 schema is important, as it reflects how the raw row key bytes are
 structured. Currently, this only affects how the key is read via a
 GoogleSQL query from the ExecuteQuery API.

 For a SQL query, the _key column is still read as raw bytes. But queries
 can reference the key fields by name, which will be decoded from _key using
 provided type and encoding. Queries that reference key fields will fail if
 they encounter an invalid row key.

 For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the
 following schema:
 {
   fields {
     field_name: "id"
     type { string { encoding: utf8_bytes {} } }
   }
   fields {
     field_name: "date"
     type { string { encoding: utf8_bytes {} } }
   }
   fields {
     field_name: "product_code"
     type { int64 { encoding: big_endian_bytes {} } }
   }
   encoding { delimited_bytes { delimiter: "#" } }
 }

 The decoded key parts would be:
   id = "some_id", date = "2024-04-30", product_code = 1245427
 The query "SELECT _key, product_code FROM table" will return two columns:
 /------------------------------------------------------\
 |              _key                     | product_code |
 | --------------------------------------|--------------|
 | "some_id#2024-04-30#\x00\x13\x00\xf3" |   1245427    |
 \------------------------------------------------------/

 The schema has the following invariants:
 (1) The decoded field values are order-preserved. For read, the field
 values will be decoded in sorted mode from the raw bytes.
 (2) Every field in the schema must specify a non-empty name.
 (3) Every field must specify a type with an associated encoding. The type
 is limited to scalar types only: Array, Map, Aggregate, and Struct are not
 allowed.
 (4) The field names must not collide with existing column family
 names and reserved keywords "_key" and "_timestamp".

 The following update operations are allowed for row_key_schema:
 - Update from an empty schema to a new schema.
 - Remove the existing schema. This operation requires setting the
   `ignore_warnings` flag to `true`, since it might be a backward
   incompatible change. Without the flag, the update request will fail with
   an INVALID_ARGUMENT error.
 Any other row key schema update operation (e.g. update existing schema
 columns names or types) is currently unsupported.
      .google.bigtable.admin.v2.Type.Struct row_key_schema = 15;
      Returns:
      Whether the rowKeySchema field is set.

    • getRowKeySchema

      Type.Struct getRowKeySchema()
       The row key schema for this table. The schema is used to decode the raw row
 key bytes into a structured format. The order of field declarations in this
 schema is important, as it reflects how the raw row key bytes are
 structured. Currently, this only affects how the key is read via a
 GoogleSQL query from the ExecuteQuery API.

 For a SQL query, the _key column is still read as raw bytes. But queries
 can reference the key fields by name, which will be decoded from _key using
 provided type and encoding. Queries that reference key fields will fail if
 they encounter an invalid row key.

 For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the
 following schema:
 {
   fields {
     field_name: "id"
     type { string { encoding: utf8_bytes {} } }
   }
   fields {
     field_name: "date"
     type { string { encoding: utf8_bytes {} } }
   }
   fields {
     field_name: "product_code"
     type { int64 { encoding: big_endian_bytes {} } }
   }
   encoding { delimited_bytes { delimiter: "#" } }
 }

 The decoded key parts would be:
   id = "some_id", date = "2024-04-30", product_code = 1245427
 The query "SELECT _key, product_code FROM table" will return two columns:
 /------------------------------------------------------\
 |              _key                     | product_code |
 | --------------------------------------|--------------|
 | "some_id#2024-04-30#\x00\x13\x00\xf3" |   1245427    |
 \------------------------------------------------------/

 The schema has the following invariants:
 (1) The decoded field values are order-preserved. For read, the field
 values will be decoded in sorted mode from the raw bytes.
 (2) Every field in the schema must specify a non-empty name.
 (3) Every field must specify a type with an associated encoding. The type
 is limited to scalar types only: Array, Map, Aggregate, and Struct are not
 allowed.
 (4) The field names must not collide with existing column family
 names and reserved keywords "_key" and "_timestamp".

 The following update operations are allowed for row_key_schema:
 - Update from an empty schema to a new schema.
 - Remove the existing schema. This operation requires setting the
   `ignore_warnings` flag to `true`, since it might be a backward
   incompatible change. Without the flag, the update request will fail with
   an INVALID_ARGUMENT error.
 Any other row key schema update operation (e.g. update existing schema
 columns names or types) is currently unsupported.
      .google.bigtable.admin.v2.Type.Struct row_key_schema = 15;
      Returns:
      The rowKeySchema.

    • getRowKeySchemaOrBuilder

      Type.StructOrBuilder getRowKeySchemaOrBuilder()
       The row key schema for this table. The schema is used to decode the raw row
 key bytes into a structured format. The order of field declarations in this
 schema is important, as it reflects how the raw row key bytes are
 structured. Currently, this only affects how the key is read via a
 GoogleSQL query from the ExecuteQuery API.

 For a SQL query, the _key column is still read as raw bytes. But queries
 can reference the key fields by name, which will be decoded from _key using
 provided type and encoding. Queries that reference key fields will fail if
 they encounter an invalid row key.

 For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the
 following schema:
 {
   fields {
     field_name: "id"
     type { string { encoding: utf8_bytes {} } }
   }
   fields {
     field_name: "date"
     type { string { encoding: utf8_bytes {} } }
   }
   fields {
     field_name: "product_code"
     type { int64 { encoding: big_endian_bytes {} } }
   }
   encoding { delimited_bytes { delimiter: "#" } }
 }

 The decoded key parts would be:
   id = "some_id", date = "2024-04-30", product_code = 1245427
 The query "SELECT _key, product_code FROM table" will return two columns:
 /------------------------------------------------------\
 |              _key                     | product_code |
 | --------------------------------------|--------------|
 | "some_id#2024-04-30#\x00\x13\x00\xf3" |   1245427    |
 \------------------------------------------------------/

 The schema has the following invariants:
 (1) The decoded field values are order-preserved. For read, the field
 values will be decoded in sorted mode from the raw bytes.
 (2) Every field in the schema must specify a non-empty name.
 (3) Every field must specify a type with an associated encoding. The type
 is limited to scalar types only: Array, Map, Aggregate, and Struct are not
 allowed.
 (4) The field names must not collide with existing column family
 names and reserved keywords "_key" and "_timestamp".

 The following update operations are allowed for row_key_schema:
 - Update from an empty schema to a new schema.
 - Remove the existing schema. This operation requires setting the
   `ignore_warnings` flag to `true`, since it might be a backward
   incompatible change. Without the flag, the update request will fail with
   an INVALID_ARGUMENT error.
 Any other row key schema update operation (e.g. update existing schema
 columns names or types) is currently unsupported.
      .google.bigtable.admin.v2.Type.Struct row_key_schema = 15;

    • getAutomatedBackupConfigCase

      Table.AutomatedBackupConfigCase getAutomatedBackupConfigCase()