Class Table.Builder (2.17.1)

public static final class Table.Builder extends 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

Implements

TableOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Table.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Table.Builder
Overrides

build()

public Table build()
Returns
TypeDescription
Table

buildPartial()

public Table buildPartial()
Returns
TypeDescription
Table

clear()

public Table.Builder clear()
Returns
TypeDescription
Table.Builder
Overrides

clearClusterStates()

public Table.Builder clearClusterStates()
Returns
TypeDescription
Table.Builder

clearColumnFamilies()

public Table.Builder clearColumnFamilies()
Returns
TypeDescription
Table.Builder

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Table.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Table.Builder
Overrides

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

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*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

string name = 1;

Returns
TypeDescription
Table.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Table.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Table.Builder
Overrides

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

Returns
TypeDescription
Table.Builder

clone()

public Table.Builder clone()
Returns
TypeDescription
Table.Builder
Overrides

containsClusterStates(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsColumnFamilies(String key)

public boolean containsColumnFamilies(String key)

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getClusterStates()

public Map<String,Table.ClusterState> getClusterStates()
Returns
TypeDescription
Map<String,ClusterState>

getClusterStatesCount()

public int getClusterStatesCount()

Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN replication_status. Views: REPLICATION_VIEW, ENCRYPTION_VIEW, FULL

map<string, .google.bigtable.admin.v2.Table.ClusterState> cluster_states = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

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

Returns
TypeDescription
Map<String,ClusterState>

getClusterStatesOrDefault(String key, Table.ClusterState defaultValue)

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

Parameters
NameDescription
keyString
defaultValueTable.ClusterState
Returns
TypeDescription
Table.ClusterState

getClusterStatesOrThrow(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Table.ClusterState

getColumnFamilies()

public Map<String,ColumnFamily> getColumnFamilies()
Returns
TypeDescription
Map<String,ColumnFamily>

getColumnFamiliesCount()

public int getColumnFamiliesCount()

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Returns
TypeDescription
int

getColumnFamiliesMap()

public Map<String,ColumnFamily> getColumnFamiliesMap()

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Returns
TypeDescription
Map<String,ColumnFamily>

getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue)

public ColumnFamily getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue)

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Parameters
NameDescription
keyString
defaultValueColumnFamily
Returns
TypeDescription
ColumnFamily

getColumnFamiliesOrThrow(String key)

public ColumnFamily getColumnFamiliesOrThrow(String key)

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
ColumnFamily

getDefaultInstanceForType()

public Table getDefaultInstanceForType()
Returns
TypeDescription
Table

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;

Returns
TypeDescription
boolean

The deletionProtection.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

Returns
TypeDescription
Table.TimestampGranularity

The granularity.

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

Returns
TypeDescription
int

The enum numeric value on the wire for granularity.

getMutableClusterStates()

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

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,ClusterState>

getMutableColumnFamilies()

public Map<String,ColumnFamily> getMutableColumnFamilies()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,ColumnFamily>

getName()

public String getName()

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

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

Returns
TypeDescription
RestoreInfo

The restoreInfo.

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

Returns
TypeDescription
RestoreInfo.Builder

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

Returns
TypeDescription
RestoreInfoOrBuilder

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

Returns
TypeDescription
boolean

Whether the restoreInfo field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Table other)

public Table.Builder mergeFrom(Table other)
Parameter
NameDescription
otherTable
Returns
TypeDescription
Table.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Table.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Table.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Table.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Table.Builder
Overrides

mergeRestoreInfo(RestoreInfo value)

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

Parameter
NameDescription
valueRestoreInfo
Returns
TypeDescription
Table.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Table.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Table.Builder
Overrides

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

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

Parameter
NameDescription
valuesMap<String,ClusterState>
Returns
TypeDescription
Table.Builder

putAllColumnFamilies(Map<String,ColumnFamily> values)

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

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Parameter
NameDescription
valuesMap<String,ColumnFamily>
Returns
TypeDescription
Table.Builder

putClusterStates(String key, Table.ClusterState value)

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

Parameters
NameDescription
keyString
valueTable.ClusterState
Returns
TypeDescription
Table.Builder

putColumnFamilies(String key, ColumnFamily value)

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

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Parameters
NameDescription
keyString
valueColumnFamily
Returns
TypeDescription
Table.Builder

removeClusterStates(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Table.Builder

removeColumnFamilies(String key)

public Table.Builder removeColumnFamilies(String key)

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL

map<string, .google.bigtable.admin.v2.ColumnFamily> column_families = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
Table.Builder

setDeletionProtection(boolean value)

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;

Parameter
NameDescription
valueboolean

The deletionProtection to set.

Returns
TypeDescription
Table.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Table.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Table.Builder
Overrides

setGranularity(Table.TimestampGranularity value)

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

Parameter
NameDescription
valueTable.TimestampGranularity

The granularity to set.

Returns
TypeDescription
Table.Builder

This builder for chaining.

setGranularityValue(int value)

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for granularity to set.

Returns
TypeDescription
Table.Builder

This builder for chaining.

setName(String value)

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*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Table.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Table.Builder setNameBytes(ByteString value)

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Table.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Table.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Table.Builder
Overrides

setRestoreInfo(RestoreInfo value)

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

Parameter
NameDescription
valueRestoreInfo
Returns
TypeDescription
Table.Builder

setRestoreInfo(RestoreInfo.Builder builderForValue)

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

Parameter
NameDescription
builderForValueRestoreInfo.Builder
Returns
TypeDescription
Table.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Table.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Table.Builder
Overrides