Interface TableOrBuilder (2.14.0)

Version 2.14.0

• 2.37.0 (latest)
• 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 interface TableOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsClusterStates(String key)

public abstract 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 abstract 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

getClusterStates()

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

Use #getClusterStatesMap() instead.

Returns

Type	Description
Map<String,ClusterState>

getClusterStatesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,ColumnFamily> getColumnFamilies()

Use #getColumnFamiliesMap() instead.

Returns

Type	Description
Map<String,ColumnFamily>

getColumnFamiliesCount()

public abstract 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 abstract 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 abstract 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 abstract 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

getDeletionProtection()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getRestoreInfo()

public abstract 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 abstract 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

hasRestoreInfo()

public abstract 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.