Package com.google.bigtable.admin.v2
Class Table.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
com.google.bigtable.admin.v2.Table.Builder
- All Implemented Interfaces:
TableOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- Table
public static final class Table.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
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-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()If specified, automated backups are enabled for this table.If specified, enable the change stream on this table.Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The tableclearField(com.google.protobuf.Descriptors.FieldDescriptor field) Immutable.The unique name of the table.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Output only.The row key schema for this table.clone()booleanOutput only.booleanThe column families configured for this table, mapped by column family ID.If specified, automated backups are enabled for this table.If specified, automated backups are enabled for this table.If specified, automated backups are enabled for this table.If specified, enable the change stream on this table.If specified, enable the change stream on this table.If specified, enable the change stream on this table.Deprecated.intOutput only.Output only.getClusterStatesOrDefault(String key, Table.ClusterState defaultValue) Output only.Output only.Deprecated.intThe column families configured for this table, mapped by column family ID.The column families configured for this table, mapped by column family ID.getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue) The column families configured for this table, mapped by column family ID.The column families configured for this table, mapped by column family ID.booleanSet to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The tablestatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorImmutable.intImmutable.Deprecated.Deprecated.getName()The unique name of the table.com.google.protobuf.ByteStringThe unique name of the table.Output only.Output only.Output only.The row key schema for this table.The row key schema for this table.The row key schema for this table.booleanIf specified, automated backups are enabled for this table.booleanIf specified, enable the change stream on this table.booleanOutput only.booleanThe row key schema for this table.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) protected com.google.protobuf.MapFieldReflectionAccessorinternalGetMutableMapFieldReflection(int number) final booleanIf specified, automated backups are enabled for this table.If specified, enable the change stream on this table.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeRestoreInfo(RestoreInfo value) Output only.mergeRowKeySchema(Type.Struct value) The row key schema for this table.final Table.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) putAllClusterStates(Map<String, Table.ClusterState> values) Output only.putAllColumnFamilies(Map<String, ColumnFamily> values) The column families configured for this table, mapped by column family ID.putClusterStates(String key, Table.ClusterState value) Output only.Output only.putColumnFamilies(String key, ColumnFamily value) The column families configured for this table, mapped by column family ID.The column families configured for this table, mapped by column family ID.Output only.The column families configured for this table, mapped by column family ID.If specified, automated backups are enabled for this table.setAutomatedBackupPolicy(Table.AutomatedBackupPolicy.Builder builderForValue) If specified, automated backups are enabled for this table.If specified, enable the change stream on this table.setChangeStreamConfig(ChangeStreamConfig.Builder builderForValue) If specified, enable the change stream on this table.setDeletionProtection(boolean value) Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The tableImmutable.setGranularityValue(int value) Immutable.The unique name of the table.setNameBytes(com.google.protobuf.ByteString value) The unique name of the table.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRestoreInfo(RestoreInfo value) Output only.setRestoreInfo(RestoreInfo.Builder builderForValue) Output only.setRowKeySchema(Type.Struct value) The row key schema for this table.setRowKeySchema(Type.Struct.Builder builderForValue) The row key schema for this table.final Table.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
internalGetMutableMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) - Overrides:
internalGetMutableMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
setField
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
setRepeatedField
public Table.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
addRepeatedField
public Table.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Table.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
mergeFrom
public Table.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Table.Builder>- Throws:
IOException
-
getAutomatedBackupConfigCase
- Specified by:
getAutomatedBackupConfigCasein interfaceTableOrBuilder
-
clearAutomatedBackupConfig
-
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:
getNamein interfaceTableOrBuilder- 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:
getNameBytesin interfaceTableOrBuilder- Returns:
- The bytes for name.
-
setName
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;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
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:
- This builder for chaining.
-
setNameBytes
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;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getClusterStatesCount
public int getClusterStatesCount()Description copied from interface:TableOrBuilderOutput 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:
getClusterStatesCountin interfaceTableOrBuilder
-
containsClusterStates
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:
containsClusterStatesin interfaceTableOrBuilder
-
getClusterStates
Deprecated.UsegetClusterStatesMap()instead.- Specified by:
getClusterStatesin interfaceTableOrBuilder
-
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:
getClusterStatesMapin interfaceTableOrBuilder
-
getClusterStatesOrDefault
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:
getClusterStatesOrDefaultin interfaceTableOrBuilder
-
getClusterStatesOrThrow
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:
getClusterStatesOrThrowin interfaceTableOrBuilder
-
clearClusterStates
-
removeClusterStates
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]; -
getMutableClusterStates
Deprecated.Use alternate mutation accessors instead. -
putClusterStates
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]; -
putAllClusterStates
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]; -
putClusterStatesBuilderIfAbsent
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
public int getColumnFamiliesCount()Description copied from interface:TableOrBuilderThe 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:
getColumnFamiliesCountin interfaceTableOrBuilder
-
containsColumnFamilies
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:
containsColumnFamiliesin interfaceTableOrBuilder
-
getColumnFamilies
Deprecated.UsegetColumnFamiliesMap()instead.- Specified by:
getColumnFamiliesin interfaceTableOrBuilder
-
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:
getColumnFamiliesMapin interfaceTableOrBuilder
-
getColumnFamiliesOrDefault
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:
getColumnFamiliesOrDefaultin interfaceTableOrBuilder
-
getColumnFamiliesOrThrow
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:
getColumnFamiliesOrThrowin interfaceTableOrBuilder
-
clearColumnFamilies
-
removeColumnFamilies
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; -
getMutableColumnFamilies
Deprecated.Use alternate mutation accessors instead. -
putColumnFamilies
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; -
putAllColumnFamilies
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; -
putColumnFamiliesBuilderIfAbsent
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
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:
getGranularityValuein interfaceTableOrBuilder- Returns:
- The enum numeric value on the wire for granularity.
-
setGranularityValue
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];- Parameters:
value- The enum numeric value on the wire for granularity to set.- Returns:
- This builder for chaining.
-
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:
getGranularityin interfaceTableOrBuilder- Returns:
- The granularity.
-
setGranularity
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];- Parameters:
value- The granularity to set.- Returns:
- This builder for chaining.
-
clearGranularity
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:
- This builder for chaining.
-
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:
hasRestoreInfoin interfaceTableOrBuilder- Returns:
- Whether the restoreInfo field is set.
-
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:
getRestoreInfoin interfaceTableOrBuilder- Returns:
- The restoreInfo.
-
setRestoreInfo
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]; -
setRestoreInfo
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]; -
mergeRestoreInfo
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]; -
clearRestoreInfo
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]; -
getRestoreInfoBuilder
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]; -
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:
getRestoreInfoOrBuilderin interfaceTableOrBuilder
-
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:
hasChangeStreamConfigin interfaceTableOrBuilder- Returns:
- Whether the changeStreamConfig field is set.
-
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:
getChangeStreamConfigin interfaceTableOrBuilder- Returns:
- The changeStreamConfig.
-
setChangeStreamConfig
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; -
setChangeStreamConfig
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; -
mergeChangeStreamConfig
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; -
clearChangeStreamConfig
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; -
getChangeStreamConfigBuilder
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; -
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:
getChangeStreamConfigOrBuilderin interfaceTableOrBuilder
-
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:
getDeletionProtectionin interfaceTableOrBuilder- Returns:
- The deletionProtection.
-
setDeletionProtection
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;- Parameters:
value- The deletionProtection to set.- Returns:
- This builder for chaining.
-
clearDeletionProtection
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:
- This builder for chaining.
-
hasAutomatedBackupPolicy
public 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;- Specified by:
hasAutomatedBackupPolicyin interfaceTableOrBuilder- Returns:
- Whether the automatedBackupPolicy field is set.
-
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;- Specified by:
getAutomatedBackupPolicyin interfaceTableOrBuilder- Returns:
- The automatedBackupPolicy.
-
setAutomatedBackupPolicy
If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.
.google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13; -
setAutomatedBackupPolicy
If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.
.google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13; -
mergeAutomatedBackupPolicy
If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.
.google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13; -
clearAutomatedBackupPolicy
If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.
.google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13; -
getAutomatedBackupPolicyBuilder
If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled.
.google.bigtable.admin.v2.Table.AutomatedBackupPolicy automated_backup_policy = 13; -
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;- Specified by:
getAutomatedBackupPolicyOrBuilderin interfaceTableOrBuilder
-
hasRowKeySchema
public 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;- Specified by:
hasRowKeySchemain interfaceTableOrBuilder- Returns:
- Whether the rowKeySchema field is set.
-
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;- Specified by:
getRowKeySchemain interfaceTableOrBuilder- Returns:
- The rowKeySchema.
-
setRowKeySchema
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; -
setRowKeySchema
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; -
mergeRowKeySchema
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; -
clearRowKeySchema
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; -
getRowKeySchemaBuilder
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; -
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;- Specified by:
getRowKeySchemaOrBuilderin interfaceTableOrBuilder
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Table.Builder>
-