Class Table (2.8.0)

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

Implements

TableOrBuilder

Static Fields

CLUSTER_STATES_FIELD_NUMBER

public static final int CLUSTER_STATES_FIELD_NUMBER
Field Value
TypeDescription
int

COLUMN_FAMILIES_FIELD_NUMBER

public static final int COLUMN_FAMILIES_FIELD_NUMBER
Field Value
TypeDescription
int

GRANULARITY_FIELD_NUMBER

public static final int GRANULARITY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RESTORE_INFO_FIELD_NUMBER

public static final int RESTORE_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Table getDefaultInstance()
Returns
TypeDescription
Table

getDescriptor()

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

newBuilder()

public static Table.Builder newBuilder()
Returns
TypeDescription
Table.Builder

newBuilder(Table prototype)

public static Table.Builder newBuilder(Table prototype)
Parameter
NameDescription
prototypeTable
Returns
TypeDescription
Table.Builder

parseDelimitedFrom(InputStream input)

public static Table parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Table
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Table parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Table
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Table parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Table
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Table
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Table parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Table
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Table
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Table parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Table
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Table
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Table parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Table
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Table
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Table parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Table
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Table
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Table> parser()
Returns
TypeDescription
Parser<Table>

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 [(.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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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

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.

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.

getParserForType()

public Parser<Table> getParserForType()
Returns
TypeDescription
Parser<Table>
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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
RestoreInfo

The restoreInfo.

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the restoreInfo field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Table.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Table.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException