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
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Table.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Table buildPartial()
Returns
clear()
public Table.Builder clear()
Returns
Overrides
clearClusterStates()
public Table.Builder clearClusterStates()
Returns
clearColumnFamilies()
public Table.Builder clearColumnFamilies()
Returns
clearField(Descriptors.FieldDescriptor field)
public Table.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearGranularity()
public Table.Builder clearGranularity()
(CreationOnly)
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;
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public Table.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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;
clone()
public Table.Builder clone()
Returns
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;
containsColumnFamilies(String key)
public boolean containsColumnFamilies(String key)
(CreationOnly)
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;
getClusterStates()
public Map<String,Table.ClusterState> getClusterStates()
Returns
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;
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;
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;
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;
getColumnFamilies()
public Map<String,ColumnFamily> getColumnFamilies()
Returns
getColumnFamiliesCount()
public int getColumnFamiliesCount()
(CreationOnly)
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;
getColumnFamiliesMap()
public Map<String,ColumnFamily> getColumnFamiliesMap()
(CreationOnly)
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;
getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue)
public ColumnFamily getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue)
(CreationOnly)
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;
getColumnFamiliesOrThrow(String key)
public ColumnFamily getColumnFamiliesOrThrow(String key)
(CreationOnly)
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;
getDefaultInstanceForType()
public Table getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getGranularity()
public Table.TimestampGranularity getGranularity()
(CreationOnly)
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;
getGranularityValue()
public int getGranularityValue()
(CreationOnly)
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;
| Type | Description |
| int | The enum numeric value on the wire for granularity.
|
getMutableClusterStates()
public Map<String,Table.ClusterState> getMutableClusterStates()
Use alternate mutation accessors instead.
getMutableColumnFamilies()
public Map<String,ColumnFamily> getMutableColumnFamilies()
Use alternate mutation accessors instead.
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;
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;
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;
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;
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;
| Type | Description |
| boolean | Whether the restoreInfo field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Table other)
public Table.Builder mergeFrom(Table other)
Parameter
| Name | Description |
| other | Table
|
Returns
public Table.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Table.Builder mergeFrom(Message other)
Parameter
Returns
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;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Table.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
putAllColumnFamilies(Map<String,ColumnFamily> values)
public Table.Builder putAllColumnFamilies(Map<String,ColumnFamily> values)
(CreationOnly)
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;
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;
putColumnFamilies(String key, ColumnFamily value)
public Table.Builder putColumnFamilies(String key, ColumnFamily value)
(CreationOnly)
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;
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;
removeColumnFamilies(String key)
public Table.Builder removeColumnFamilies(String key)
(CreationOnly)
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;
setField(Descriptors.FieldDescriptor field, Object value)
public Table.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setGranularity(Table.TimestampGranularity value)
public Table.Builder setGranularity(Table.TimestampGranularity value)
(CreationOnly)
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;
setGranularityValue(int value)
public Table.Builder setGranularityValue(int value)
(CreationOnly)
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;
| Name | Description |
| value | int
The enum numeric value on the wire for granularity to set.
|
Returns
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.
|
Returns
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.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Table.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
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;
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;
setUnknownFields(UnknownFieldSet unknownFields)
public final Table.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
