Class Table (2.16.0)

Version 2.16.0

• 2.46.0 (latest)
• 2.45.1
• 2.44.1
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.5
• 2.37.0
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Table

Implements

TableOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CLUSTER_STATES_FIELD_NUMBER

public static final int CLUSTER_STATES_FIELD_NUMBER

Field Value

Type	Description
int

COLUMN_FAMILIES_FIELD_NUMBER

public static final int COLUMN_FAMILIES_FIELD_NUMBER

Field Value

Type	Description
int

DELETION_PROTECTION_FIELD_NUMBER

public static final int DELETION_PROTECTION_FIELD_NUMBER

Field Value

Type	Description
int

GRANULARITY_FIELD_NUMBER

public static final int GRANULARITY_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

RESTORE_INFO_FIELD_NUMBER

public static final int RESTORE_INFO_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Table getDefaultInstance()

Returns

Type	Description
Table

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Table.Builder newBuilder()

Returns

Type	Description
Table.Builder

newBuilder(Table prototype)

public static Table.Builder newBuilder(Table prototype)

Parameter

Name	Description
prototype	Table

Returns

Type	Description
Table.Builder

parseDelimitedFrom(InputStream input)

public static Table parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Table

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Table parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Table

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Table parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Table

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Table

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Table parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Table

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Table

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Table parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Table

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Table

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Table parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Table

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Table

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Table parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Table

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Table parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Table

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Table> parser()

Returns

Type	Description
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

Name	Description
key	String

Returns

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;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getClusterStates()

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

Use #getClusterStatesMap() instead.

Returns

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

Returns

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

Returns

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

Parameters

Name	Description
key	String
defaultValue	Table.ClusterState

Returns

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

Parameter

Name	Description
key	String

Returns

Type	Description
Table.ClusterState

getColumnFamilies()

public Map<String,ColumnFamily> getColumnFamilies()

Use #getColumnFamiliesMap() instead.

Returns

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;

Returns

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;

Returns

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;

Parameters

Name	Description
key	String
defaultValue	ColumnFamily

Returns

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;

Parameter

Name	Description
key	String

Returns

Type	Description
ColumnFamily

getDefaultInstanceForType()

public Table getDefaultInstanceForType()

Returns

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;

Returns

Type	Description
boolean	The deletionProtection.

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

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

Returns

Type	Description
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

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

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Table> getParserForType()

Returns

Type	Description
Parser<Table>

Overrides

GeneratedMessageV3.getParserForType()

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

Type	Description
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

Type	Description
RestoreInfoOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

Type	Description
boolean	Whether the restoreInfo field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Table.Builder newBuilderForType()

Returns

Type	Description
Table.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Table.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Table.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Table.Builder toBuilder()

Returns

Type	Description
Table.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException