Package com.google.bigtable.admin.v2

Class Table

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.bigtable.admin.v2.Table
All Implemented Interfaces:
TableOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Table extends com.google.protobuf.GeneratedMessageV3 implements TableOrBuilder
 A collection of user data indexed by row, column, and timestamp.
 Each table is served using the resources of its parent cluster.
Protobuf type google.bigtable.admin.v2.Table
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CLUSTER_STATES_FIELD_NUMBER

      public static final int CLUSTER_STATES_FIELD_NUMBER
      See Also:

    • COLUMN_FAMILIES_FIELD_NUMBER

      public static final int COLUMN_FAMILIES_FIELD_NUMBER
      See Also:

    • GRANULARITY_FIELD_NUMBER

      public static final int GRANULARITY_FIELD_NUMBER
      See Also:

    • RESTORE_INFO_FIELD_NUMBER

      public static final int RESTORE_INFO_FIELD_NUMBER
      See Also:

    • CHANGE_STREAM_CONFIG_FIELD_NUMBER

      public static final int CHANGE_STREAM_CONFIG_FIELD_NUMBER
      See Also:

    • DELETION_PROTECTION_FIELD_NUMBER

      public static final int DELETION_PROTECTION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public 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;
      Specified by:
      getName in interface TableOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface TableOrBuilder
      Returns:
      The bytes for name.

    • getClusterStatesCount

      public int getClusterStatesCount()
      Description copied from interface: TableOrBuilder
       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];
      Specified by:
      getClusterStatesCount in interface TableOrBuilder

    • containsClusterStates

      public 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];
      Specified by:
      containsClusterStates in interface TableOrBuilder

    • getClusterStates

      @Deprecated public Map<String,Table.ClusterState> getClusterStates()
      Deprecated.
      Use getClusterStatesMap() instead.
      Specified by:
      getClusterStates in interface TableOrBuilder

    • getClusterStatesMap

      public 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];
      Specified by:
      getClusterStatesMap in interface TableOrBuilder

    • getClusterStatesOrDefault

      public 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];
      Specified by:
      getClusterStatesOrDefault in interface TableOrBuilder

    • getClusterStatesOrThrow

      public 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];
      Specified by:
      getClusterStatesOrThrow in interface TableOrBuilder

    • getColumnFamiliesCount

      public int getColumnFamiliesCount()
      Description copied from interface: TableOrBuilder
       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;
      Specified by:
      getColumnFamiliesCount in interface TableOrBuilder

    • containsColumnFamilies

      public 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;
      Specified by:
      containsColumnFamilies in interface TableOrBuilder

    • getColumnFamilies

      @Deprecated public Map<String,ColumnFamily> getColumnFamilies()
      Deprecated.
      Use getColumnFamiliesMap() instead.
      Specified by:
      getColumnFamilies in interface TableOrBuilder

    • getColumnFamiliesMap

      public 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;
      Specified by:
      getColumnFamiliesMap in interface TableOrBuilder

    • getColumnFamiliesOrDefault

      public 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;
      Specified by:
      getColumnFamiliesOrDefault in interface TableOrBuilder

    • getColumnFamiliesOrThrow

      public 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;
      Specified by:
      getColumnFamiliesOrThrow in interface TableOrBuilder

    • getGranularityValue

      public 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];
      Specified by:
      getGranularityValue in interface TableOrBuilder
      Returns:
      The enum numeric value on the wire for granularity.

    • getGranularity

      public 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];
      Specified by:
      getGranularity in interface TableOrBuilder
      Returns:
      The granularity.

    • hasRestoreInfo

      public 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];
      Specified by:
      hasRestoreInfo in interface TableOrBuilder
      Returns:
      Whether the restoreInfo field is set.

    • getRestoreInfo

      public 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];
      Specified by:
      getRestoreInfo in interface TableOrBuilder
      Returns:
      The restoreInfo.

    • getRestoreInfoOrBuilder

      public 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];
      Specified by:
      getRestoreInfoOrBuilder in interface TableOrBuilder

    • hasChangeStreamConfig

      public 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;
      Specified by:
      hasChangeStreamConfig in interface TableOrBuilder
      Returns:
      Whether the changeStreamConfig field is set.

    • getChangeStreamConfig

      public 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;
      Specified by:
      getChangeStreamConfig in interface TableOrBuilder
      Returns:
      The changeStreamConfig.

    • getChangeStreamConfigOrBuilder

      public 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;
      Specified by:
      getChangeStreamConfigOrBuilder in interface TableOrBuilder

    • getDeletionProtection

      public 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;
      Specified by:
      getDeletionProtection in interface TableOrBuilder
      Returns:
      The deletionProtection.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Table parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Table parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Table parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Table parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Table parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Table parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Table parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Table parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Table parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Table parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Table parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Table parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Table.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Table.Builder newBuilder()

    • newBuilder

      public static Table.Builder newBuilder(Table prototype)

    • toBuilder

      public Table.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Table.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Table getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Table> parser()

    • getParserForType

      public com.google.protobuf.Parser<Table> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Table getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder