public final class Table extends GeneratedMessageV3 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 Fields
CLUSTER_STATES_FIELD_NUMBER
public static final int CLUSTER_STATES_FIELD_NUMBER
Field Value
COLUMN_FAMILIES_FIELD_NUMBER
public static final int COLUMN_FAMILIES_FIELD_NUMBER
Field Value
GRANULARITY_FIELD_NUMBER
public static final int GRANULARITY_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESTORE_INFO_FIELD_NUMBER
public static final int RESTORE_INFO_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Table getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Table.Builder newBuilder()
Returns
newBuilder(Table prototype)
public static Table.Builder newBuilder(Table prototype)
Parameter
Name | Description |
prototype | Table
|
Returns
public static Table parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Table parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Table parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Table parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Table parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Table parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Table parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Table parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Table parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Table parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Table parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Table parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Table> parser()
Returns
Methods
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;
Parameter
Returns
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;
Parameter
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
Returns
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;
Returns
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;
Parameters
Returns
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;
Parameter
Returns
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;
Returns
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;
Returns
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;
Parameters
Returns
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;
Parameter
Returns
getDefaultInstanceForType()
public Table getDefaultInstanceForType()
Returns
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;
Returns
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;
Returns
Type | Description |
int | The enum numeric value on the wire for granularity.
|
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
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;
Returns
getParserForType()
public Parser<Table> getParserForType()
Returns
Overrides
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;
Returns
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;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
Returns
Type | Description |
boolean | Whether the restoreInfo field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Table.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Table.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Table.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions