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.GeneratedMessage.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.GeneratedMessage.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 Type	Method and Description
Table	build()
Table	buildPartial()
Table.Builder	clear()
Table.Builder	clearAutomatedBackupConfig()
Table.Builder	clearAutomatedBackupPolicy() If specified, automated backups are enabled for this table.
Table.Builder	clearChangeStreamConfig() If specified, enable the change stream on this table.
Table.Builder	clearClusterStates()
Table.Builder	clearColumnFamilies()
Table.Builder	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
Table.Builder	clearGranularity() Immutable.
Table.Builder	clearName() The unique name of the table.
Table.Builder	clearRestoreInfo() Output only.
Table.Builder	clearRowKeySchema() The row key schema for this table.
Table.Builder	clearTieredStorageConfig() Rules to specify what data is stored in each storage tier.
boolean	containsClusterStates(String key) Output only.
boolean	containsColumnFamilies(String key) The column families configured for this table, mapped by column family ID.
Table.AutomatedBackupConfigCase	getAutomatedBackupConfigCase()
Table.AutomatedBackupPolicy	getAutomatedBackupPolicy() If specified, automated backups are enabled for this table.
Table.AutomatedBackupPolicy.Builder	getAutomatedBackupPolicyBuilder() If specified, automated backups are enabled for this table.
Table.AutomatedBackupPolicyOrBuilder	getAutomatedBackupPolicyOrBuilder() If specified, automated backups are enabled for this table.
ChangeStreamConfig	getChangeStreamConfig() If specified, enable the change stream on this table.
ChangeStreamConfig.Builder	getChangeStreamConfigBuilder() If specified, enable the change stream on this table.
ChangeStreamConfigOrBuilder	getChangeStreamConfigOrBuilder() If specified, enable the change stream on this table.
Map<String,Table.ClusterState>	getClusterStates() Deprecated.
int	getClusterStatesCount() Output only.
Map<String,Table.ClusterState>	getClusterStatesMap() Output only.
Table.ClusterState	getClusterStatesOrDefault(String key, Table.ClusterState defaultValue) Output only.
Table.ClusterState	getClusterStatesOrThrow(String key) Output only.
Map<String,ColumnFamily>	getColumnFamilies() Deprecated.
int	getColumnFamiliesCount() The column families configured for this table, mapped by column family ID.
Map<String,ColumnFamily>	getColumnFamiliesMap() The column families configured for this table, mapped by column family ID.
ColumnFamily	getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue) The column families configured for this table, mapped by column family ID.
ColumnFamily	getColumnFamiliesOrThrow(String key) The column families configured for this table, mapped by column family ID.
Table	getDefaultInstanceForType()
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
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Table.TimestampGranularity	getGranularity() Immutable.
int	getGranularityValue() Immutable.
Map<String,Table.ClusterState>	getMutableClusterStates() Deprecated.
Map<String,ColumnFamily>	getMutableColumnFamilies() Deprecated.
String	getName() The unique name of the table.
com.google.protobuf.ByteString	getNameBytes() The unique name of the table.
RestoreInfo	getRestoreInfo() Output only.
RestoreInfo.Builder	getRestoreInfoBuilder() Output only.
RestoreInfoOrBuilder	getRestoreInfoOrBuilder() Output only.
Type.Struct	getRowKeySchema() The row key schema for this table.
Type.Struct.Builder	getRowKeySchemaBuilder() The row key schema for this table.
Type.StructOrBuilder	getRowKeySchemaOrBuilder() The row key schema for this table.
TieredStorageConfig	getTieredStorageConfig() Rules to specify what data is stored in each storage tier.
TieredStorageConfig.Builder	getTieredStorageConfigBuilder() Rules to specify what data is stored in each storage tier.
TieredStorageConfigOrBuilder	getTieredStorageConfigOrBuilder() Rules to specify what data is stored in each storage tier.
boolean	hasAutomatedBackupPolicy() If specified, automated backups are enabled for this table.
boolean	hasChangeStreamConfig() If specified, enable the change stream on this table.
boolean	hasRestoreInfo() Output only.
boolean	hasRowKeySchema() The row key schema for this table.
boolean	hasTieredStorageConfig() Rules to specify what data is stored in each storage tier.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)
boolean	isInitialized()
Table.Builder	mergeAutomatedBackupPolicy(Table.AutomatedBackupPolicy value) If specified, automated backups are enabled for this table.
Table.Builder	mergeChangeStreamConfig(ChangeStreamConfig value) If specified, enable the change stream on this table.
Table.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Table.Builder	mergeFrom(com.google.protobuf.Message other)
Table.Builder	mergeFrom(Table other)
Table.Builder	mergeRestoreInfo(RestoreInfo value) Output only.
Table.Builder	mergeRowKeySchema(Type.Struct value) The row key schema for this table.
Table.Builder	mergeTieredStorageConfig(TieredStorageConfig value) Rules to specify what data is stored in each storage tier.
Table.Builder	putAllClusterStates(Map<String,Table.ClusterState> values) Output only.
Table.Builder	putAllColumnFamilies(Map<String,ColumnFamily> values) The column families configured for this table, mapped by column family ID.
Table.Builder	putClusterStates(String key, Table.ClusterState value) Output only.
Table.ClusterState.Builder	putClusterStatesBuilderIfAbsent(String key) Output only.
Table.Builder	putColumnFamilies(String key, ColumnFamily value) The column families configured for this table, mapped by column family ID.
ColumnFamily.Builder	putColumnFamiliesBuilderIfAbsent(String key) The column families configured for this table, mapped by column family ID.
Table.Builder	removeClusterStates(String key) Output only.
Table.Builder	removeColumnFamilies(String key) The column families configured for this table, mapped by column family ID.
Table.Builder	setAutomatedBackupPolicy(Table.AutomatedBackupPolicy.Builder builderForValue) If specified, automated backups are enabled for this table.
Table.Builder	setAutomatedBackupPolicy(Table.AutomatedBackupPolicy value) If specified, automated backups are enabled for this table.
Table.Builder	setChangeStreamConfig(ChangeStreamConfig.Builder builderForValue) If specified, enable the change stream on this table.
Table.Builder	setChangeStreamConfig(ChangeStreamConfig value) If specified, enable the change stream on this table.
Table.Builder	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 table
Table.Builder	setGranularity(Table.TimestampGranularity value) Immutable.
Table.Builder	setGranularityValue(int value) Immutable.
Table.Builder	setName(String value) The unique name of the table.
Table.Builder	setNameBytes(com.google.protobuf.ByteString value) The unique name of the table.
Table.Builder	setRestoreInfo(RestoreInfo.Builder builderForValue) Output only.
Table.Builder	setRestoreInfo(RestoreInfo value) Output only.
Table.Builder	setRowKeySchema(Type.Struct.Builder builderForValue) The row key schema for this table.
Table.Builder	setRowKeySchema(Type.Struct value) The row key schema for this table.
Table.Builder	setTieredStorageConfig(TieredStorageConfig.Builder builderForValue) Rules to specify what data is stored in each storage tier.
Table.Builder	setTieredStorageConfig(TieredStorageConfig value) Rules to specify what data is stored in each storage tier.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Table.Builder>

internalGetMutableMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Table.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Table.Builder>

clear

public Table.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Table.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Table.Builder>

getDefaultInstanceForType

public Table getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Table build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Table buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Table.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Table.Builder>

mergeFrom

public Table.Builder mergeFrom(Table other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Table.Builder>

mergeFrom

public Table.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Table.Builder>

Throws:

IOException

getAutomatedBackupConfigCase

public Table.AutomatedBackupConfigCase getAutomatedBackupConfigCase()

Specified by:

getAutomatedBackupConfigCase in interface TableOrBuilder

clearAutomatedBackupConfig

public Table.Builder clearAutomatedBackupConfig()

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.

setName

public Table.Builder setName(String value)

 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

public Table.Builder 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

public Table.Builder setNameBytes(com.google.protobuf.ByteString value)

 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: 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

clearClusterStates

public Table.Builder clearClusterStates()

removeClusterStates

public Table.Builder removeClusterStates(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];

getMutableClusterStates

@Deprecated
public Map<String,Table.ClusterState> getMutableClusterStates()

Deprecated.

Use alternate mutation accessors instead.

putClusterStates

public Table.Builder putClusterStates(String key,
                                      Table.ClusterState value)

 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

public Table.Builder putAllClusterStates(Map<String,Table.ClusterState> values)

 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

public Table.ClusterState.Builder putClusterStatesBuilderIfAbsent(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

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

clearColumnFamilies

public Table.Builder clearColumnFamilies()

removeColumnFamilies

public Table.Builder removeColumnFamilies(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;

getMutableColumnFamilies

@Deprecated
public Map<String,ColumnFamily> getMutableColumnFamilies()

Deprecated.

Use alternate mutation accessors instead.

putColumnFamilies

public Table.Builder putColumnFamilies(String key,
                                       ColumnFamily value)

 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

public Table.Builder putAllColumnFamilies(Map<String,ColumnFamily> values)

 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

public ColumnFamily.Builder putColumnFamiliesBuilderIfAbsent(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

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.

setGranularityValue

public Table.Builder setGranularityValue(int value)

 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

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.

setGranularity

public Table.Builder setGranularity(Table.TimestampGranularity value)

 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

public Table.Builder 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:

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.

setRestoreInfo

public Table.Builder setRestoreInfo(RestoreInfo value)

 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

public Table.Builder setRestoreInfo(RestoreInfo.Builder builderForValue)

 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

public Table.Builder mergeRestoreInfo(RestoreInfo value)

 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

public Table.Builder 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

public RestoreInfo.Builder 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

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.

setChangeStreamConfig

public Table.Builder setChangeStreamConfig(ChangeStreamConfig value)

 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

public Table.Builder setChangeStreamConfig(ChangeStreamConfig.Builder builderForValue)

 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

public Table.Builder mergeChangeStreamConfig(ChangeStreamConfig value)

 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

public Table.Builder 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

public ChangeStreamConfig.Builder 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

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.

setDeletionProtection

public Table.Builder 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 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

public Table.Builder 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:

hasAutomatedBackupPolicy in interface TableOrBuilder

Returns:

Whether the automatedBackupPolicy field is set.

getAutomatedBackupPolicy

public 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;

Specified by:

getAutomatedBackupPolicy in interface TableOrBuilder

Returns:

The automatedBackupPolicy.

setAutomatedBackupPolicy

public Table.Builder setAutomatedBackupPolicy(Table.AutomatedBackupPolicy value)

 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

public Table.Builder setAutomatedBackupPolicy(Table.AutomatedBackupPolicy.Builder builderForValue)

 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

public Table.Builder mergeAutomatedBackupPolicy(Table.AutomatedBackupPolicy value)

 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

public Table.Builder 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

public Table.AutomatedBackupPolicy.Builder 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

public 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;

Specified by:

getAutomatedBackupPolicyOrBuilder in interface TableOrBuilder

hasTieredStorageConfig

public boolean hasTieredStorageConfig()

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

Specified by:

hasTieredStorageConfig in interface TableOrBuilder

Returns:

Whether the tieredStorageConfig field is set.

getTieredStorageConfig

public TieredStorageConfig getTieredStorageConfig()

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

Specified by:

getTieredStorageConfig in interface TableOrBuilder

Returns:

The tieredStorageConfig.

setTieredStorageConfig

public Table.Builder setTieredStorageConfig(TieredStorageConfig value)

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

setTieredStorageConfig

public Table.Builder setTieredStorageConfig(TieredStorageConfig.Builder builderForValue)

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

mergeTieredStorageConfig

public Table.Builder mergeTieredStorageConfig(TieredStorageConfig value)

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

clearTieredStorageConfig

public Table.Builder clearTieredStorageConfig()

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

getTieredStorageConfigBuilder

public TieredStorageConfig.Builder getTieredStorageConfigBuilder()

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

getTieredStorageConfigOrBuilder

public TieredStorageConfigOrBuilder getTieredStorageConfigOrBuilder()

 Rules to specify what data is stored in each storage tier.
 Different tiers store data differently, providing different trade-offs
 between cost and performance. Different parts of a table can be stored
 separately on different tiers.
 If a config is specified, tiered storage is enabled for this table.
 Otherwise, tiered storage is disabled.
 Only SSD instances can configure tiered storage.
 

.google.bigtable.admin.v2.TieredStorageConfig tiered_storage_config = 14;

Specified by:

getTieredStorageConfigOrBuilder in interface TableOrBuilder

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:

hasRowKeySchema in interface TableOrBuilder

Returns:

Whether the rowKeySchema field is set.

getRowKeySchema

public 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;

Specified by:

getRowKeySchema in interface TableOrBuilder

Returns:

The rowKeySchema.

setRowKeySchema

public Table.Builder setRowKeySchema(Type.Struct value)

 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

public Table.Builder setRowKeySchema(Type.Struct.Builder builderForValue)

 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

public Table.Builder mergeRowKeySchema(Type.Struct value)

 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

public Table.Builder 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

public Type.Struct.Builder 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

public 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;

Specified by:

getRowKeySchemaOrBuilder in interface TableOrBuilder