class ProjectsInstancesTables extends Resource (View source)

The "tables" collection of methods.

Typical usage is:

 $bigtableadminService = new Google\Service\BigtableAdmin(...);
 $tables = $bigtableadminService->projects_instances_tables;

Methods

checkConsistency(string $name, CheckConsistencyRequest $postBody, array $optParams = [])

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. (tables.checkConsistency)

create(string $parent, CreateTableRequest $postBody, array $optParams = [])

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

delete(string $name, array $optParams = [])

Permanently deletes a specified table and all of its data. (tables.delete)

dropRowRange(string $name, DropRowRangeRequest $postBody, array $optParams = [])

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice. (tables.dropRowRange)

generateConsistencyToken(string $name, GenerateConsistencyTokenRequest $postBody, array $optParams = [])

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. (tables.generateConsistencyToken)

get(string $name, array $optParams = [])

Gets metadata information about the specified table. (tables.get)

getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

listProjectsInstancesTables(string $parent, array $optParams = [])

Lists all tables served from a specified instance.

modifyColumnFamilies(string $name, ModifyColumnFamiliesRequest $postBody, array $optParams = [])

Performs a series of column family modifications on the specified table.

patch(string $name, Table $postBody, array $optParams = [])

Updates a specified table. (tables.patch)

restore(string $parent, RestoreTableRequest $postBody, array $optParams = [])

Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful. (tables.restore)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on a Bigtable resource. Replaces any existing policy. (tables.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that the caller has on the specified Bigtable resource.

undelete(string $name, UndeleteTableRequest $postBody, array $optParams = [])

Restores a specified table which was accidentally deleted. (tables.undelete)

Details

CheckConsistencyResponse checkConsistency(string $name, CheckConsistencyRequest $postBody, array $optParams = [])

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. (tables.checkConsistency)

Parameters

string $name

Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

CheckConsistencyRequest $postBody
array $optParams

Optional parameters.

Return Value

CheckConsistencyResponse

Exceptions

Exception

Table create(string $parent, CreateTableRequest $postBody, array $optParams = [])

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

(tables.create)

Parameters

string $parent

Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}.

CreateTableRequest $postBody
array $optParams

Optional parameters.

Return Value

Table

Exceptions

Exception

BigtableadminEmpty delete(string $name, array $optParams = [])

Permanently deletes a specified table and all of its data. (tables.delete)

Parameters

string $name

Required. The unique name of the table to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

array $optParams

Optional parameters.

Return Value

BigtableadminEmpty

Exceptions

Exception

BigtableadminEmpty dropRowRange(string $name, DropRowRangeRequest $postBody, array $optParams = [])

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice. (tables.dropRowRange)

Parameters

string $name

Required. The unique name of the table on which to drop a range of rows. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

DropRowRangeRequest $postBody
array $optParams

Optional parameters.

Return Value

BigtableadminEmpty

Exceptions

Exception

GenerateConsistencyTokenResponse generateConsistencyToken(string $name, GenerateConsistencyTokenRequest $postBody, array $optParams = [])

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. (tables.generateConsistencyToken)

Parameters

string $name

Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

GenerateConsistencyTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GenerateConsistencyTokenResponse

Exceptions

Exception

Table get(string $name, array $optParams = [])

Gets metadata information about the specified table. (tables.get)

Parameters

string $name

Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

array $optParams

Optional parameters.

Return Value

Table

Exceptions

Exception

Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

(tables.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListTablesResponse listProjectsInstancesTables(string $parent, array $optParams = [])

Lists all tables served from a specified instance.

(tables.listProjectsInstancesTables)

Parameters

string $parent

Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}.

array $optParams

Optional parameters.

Return Value

ListTablesResponse

Exceptions

Exception

Table modifyColumnFamilies(string $name, ModifyColumnFamiliesRequest $postBody, array $optParams = [])

Performs a series of column family modifications on the specified table.

Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect. (tables.modifyColumnFamilies)

Parameters

string $name

Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

ModifyColumnFamiliesRequest $postBody
array $optParams

Optional parameters.

Return Value

Table

Exceptions

Exception

Operation patch(string $name, Table $postBody, array $optParams = [])

Updates a specified table. (tables.patch)

Parameters

string $name

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, STATS_VIEW, FULL

Table $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation restore(string $parent, RestoreTableRequest $postBody, array $optParams = [])

Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful. (tables.restore)

Parameters

string $parent

Required. The name of the instance in which to create the restored table. Values are of the form projects//instances/.

RestoreTableRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on a Bigtable resource. Replaces any existing policy. (tables.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that the caller has on the specified Bigtable resource.

(tables.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception

Operation undelete(string $name, UndeleteTableRequest $postBody, array $optParams = [])

Restores a specified table which was accidentally deleted. (tables.undelete)

Parameters

string $name

Required. The unique name of the table to be restored. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

UndeleteTableRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception