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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Table.BuilderImplements
TableOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Table.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Table.Builder |
build()
public Table build()
Type | Description |
Table |
buildPartial()
public Table buildPartial()
Type | Description |
Table |
clear()
public Table.Builder clear()
Type | Description |
Table.Builder |
clearClusterStates()
public Table.Builder clearClusterStates()
Type | Description |
Table.Builder |
clearColumnFamilies()
public Table.Builder clearColumnFamilies()
Type | Description |
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;
Type | Description |
Table.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Table.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
Table.Builder |
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];
Type | Description |
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;
Type | Description |
Table.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Table.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
Table.Builder |
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];
Type | Description |
Table.Builder |
clone()
public Table.Builder clone()
Type | Description |
Table.Builder |
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];
Name | Description |
key | String |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
boolean |
getClusterStates()
public Map<String,Table.ClusterState> getClusterStates()
Use #getClusterStatesMap() instead.
Type | Description |
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];
Type | Description |
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];
Type | Description |
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];
Name | Description |
key | String |
defaultValue | Table.ClusterState |
Type | Description |
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];
Name | Description |
key | String |
Type | Description |
Table.ClusterState |
getColumnFamilies()
public Map<String,ColumnFamily> getColumnFamilies()
Use #getColumnFamiliesMap() instead.
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
key | String |
defaultValue | ColumnFamily |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
ColumnFamily |
getDefaultInstanceForType()
public Table getDefaultInstanceForType()
Type | Description |
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;
Type | Description |
boolean | The deletionProtection. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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];
Type | Description |
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];
Type | Description |
int | The enum numeric value on the wire for granularity. |
getMutableClusterStates()
public Map<String,Table.ClusterState> getMutableClusterStates()
Use alternate mutation accessors instead.
Type | Description |
Map<String,ClusterState> |
getMutableColumnFamilies()
public Map<String,ColumnFamily> getMutableColumnFamilies()
Use alternate mutation accessors instead.
Type | Description |
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;
Type | Description |
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;
Type | Description |
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];
Type | Description |
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];
Type | Description |
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];
Type | Description |
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];
Type | Description |
boolean | Whether the restoreInfo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(Table other)
public Table.Builder mergeFrom(Table other)
Name | Description |
other | Table |
Type | Description |
Table.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Table.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Table.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public Table.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
Table.Builder |
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];
Name | Description |
value | RestoreInfo |
Type | Description |
Table.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Table.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Table.Builder |
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];
Name | Description |
values | Map<String,ClusterState> |
Type | Description |
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;
Name | Description |
values | Map<String,ColumnFamily> |
Type | Description |
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];
Name | Description |
key | String |
value | Table.ClusterState |
Type | Description |
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;
Name | Description |
key | String |
value | ColumnFamily |
Type | Description |
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];
Name | Description |
key | String |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
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;
Name | Description |
value | boolean The deletionProtection to set. |
Type | Description |
Table.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Table.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Table.Builder |
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];
Name | Description |
value | Table.TimestampGranularity The granularity to set. |
Type | Description |
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];
Name | Description |
value | int The enum numeric value on the wire for granularity to set. |
Type | Description |
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;
Name | Description |
value | String The name to set. |
Type | Description |
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;
Name | Description |
value | ByteString The bytes for name to set. |
Type | Description |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
Table.Builder |
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];
Name | Description |
value | RestoreInfo |
Type | Description |
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];
Name | Description |
builderForValue | RestoreInfo.Builder |
Type | Description |
Table.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Table.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Table.Builder |