Cloud Bigtable V2 Client - Class Table (1.27.0)

Version 1.27.0

• 1.32.1 (latest)
• 1.32.0
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

Reference documentation and code samples for the Cloud Bigtable V2 Client class Table.

A collection of user data indexed by row, column, and timestamp.

Each table is served using the resources of its parent cluster.

Generated from protobuf message google.bigtable.admin.v2.Table

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string 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
↳ cluster_states	array|Google\Protobuf\Internal\MapField 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
↳ column_families	array|Google\Protobuf\Internal\MapField The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, FULL
↳ granularity	int 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.
↳ restore_info	Google\Cloud\Bigtable\Admin\V2\RestoreInfo 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.
↳ change_stream_config	Google\Cloud\Bigtable\Admin\V2\ChangeStreamConfig If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
↳ deletion_protection	bool 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.

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

Returns
Type	Description
string

setName

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getClusterStates

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

Returns
Type	Description
Google\Protobuf\Internal\MapField

setClusterStates

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

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getColumnFamilies

The column families configured for this table, mapped by column family ID.

Views: SCHEMA_VIEW, FULL

Returns
Type	Description
Google\Protobuf\Internal\MapField

setColumnFamilies

The column families configured for this table, mapped by column family ID.

Views: SCHEMA_VIEW, FULL

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

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.

Returns
Type	Description
int

setGranularity

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

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.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\RestoreInfo|null

hasRestoreInfo

clearRestoreInfo

setRestoreInfo

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.

Parameter
Name	Description
var	Google\Cloud\Bigtable\Admin\V2\RestoreInfo

Returns
Type	Description
$this

getChangeStreamConfig

If specified, enable the change stream on this table.

Otherwise, the change stream is disabled and the change stream is not retained.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\ChangeStreamConfig|null

hasChangeStreamConfig

clearChangeStreamConfig

setChangeStreamConfig

If specified, enable the change stream on this table.

Otherwise, the change stream is disabled and the change stream is not retained.

Parameter
Name	Description
var	Google\Cloud\Bigtable\Admin\V2\ChangeStreamConfig

Returns
Type	Description
$this

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.

Returns
Type	Description
bool

setDeletionProtection

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this