com.google.bigtable.admin.v2

Interface TableOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Table, Table.Builder

public interface TableOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsClusterStates(String key) Output only.
boolean	containsColumnFamilies(String key) The column families configured for this table, mapped by column family ID.
Map<String,Table.ClusterState>	getClusterStates() Deprecated.
int	getClusterStatesCount() Output only.
Map<String,Table.ClusterState>	getClusterStatesMap() Output only.
Table.ClusterState	getClusterStatesOrDefault(String key, Table.ClusterState defaultValue) Output only.
Table.ClusterState	getClusterStatesOrThrow(String key) Output only.
Map<String,ColumnFamily>	getColumnFamilies() Deprecated.
int	getColumnFamiliesCount() The column families configured for this table, mapped by column family ID.
Map<String,ColumnFamily>	getColumnFamiliesMap() The column families configured for this table, mapped by column family ID.
ColumnFamily	getColumnFamiliesOrDefault(String key, ColumnFamily defaultValue) The column families configured for this table, mapped by column family ID.
ColumnFamily	getColumnFamiliesOrThrow(String key) The column families configured for this table, mapped by column family ID.
boolean	getDeletionProtection() Set to true to make the table protected against data loss.
Table.TimestampGranularity	getGranularity() Immutable.
int	getGranularityValue() Immutable.
String	getName() The unique name of the table.
com.google.protobuf.ByteString	getNameBytes() The unique name of the table.
RestoreInfo	getRestoreInfo() Output only.
RestoreInfoOrBuilder	getRestoreInfoOrBuilder() Output only.
boolean	hasRestoreInfo() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 The unique name of the table. Values are of the form
 `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
 Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The unique name of the table. Values are of the form
 `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
 Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
 

string name = 1;

Returns:

The bytes for name.

getClusterStatesCount

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

containsClusterStates

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

getClusterStates

@Deprecated
Map<String,Table.ClusterState> getClusterStates()

Deprecated.

Use getClusterStatesMap() instead.

getClusterStatesMap

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

getClusterStatesOrDefault

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

getClusterStatesOrThrow

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

getColumnFamiliesCount

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;

containsColumnFamilies

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;

getColumnFamilies

@Deprecated
Map<String,ColumnFamily> getColumnFamilies()

Deprecated.

Use getColumnFamiliesMap() instead.

getColumnFamiliesMap

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;

getColumnFamiliesOrDefault

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;

getColumnFamiliesOrThrow

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;

getGranularityValue

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:

The enum numeric value on the wire for granularity.

getGranularity

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:

The granularity.

hasRestoreInfo

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:

Whether the restoreInfo field is set.

getRestoreInfo

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:

The restoreInfo.

getRestoreInfoOrBuilder

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

getDeletionProtection

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:

The deletionProtection.