Cloud Bigtable V2 Client - Class BigtableTableAdminClient (1.26.2)

Version 1.26.2

• 2.6.1 (latest)
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Service Description: Service for creating, configuring, and deleting Cloud Bigtable tables.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

checkConsistency

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.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::checkConsistencyAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CheckConsistencyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\CheckConsistencyResponse

createBackup

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::createBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CreateBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createTable

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.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::createTableAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CreateTableRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Table

createTableFromSnapshot

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::createTableFromSnapshotAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CreateTableFromSnapshotRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteBackup

Deletes a pending or completed Cloud Bigtable backup.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::deleteBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DeleteBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteSnapshot

Permanently deletes the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::deleteSnapshotAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DeleteSnapshotRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteTable

Permanently deletes a specified table and all of its data.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::deleteTableAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DeleteTableRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

dropRowRange

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.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::dropRowRangeAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DropRowRangeRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

generateConsistencyToken

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.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::generateConsistencyTokenAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GenerateConsistencyTokenRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\GenerateConsistencyTokenResponse

getBackup

Gets metadata on a pending or completed Cloud Bigtable Backup.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::getBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GetBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Backup

getIamPolicy

Gets the access control policy for a Table or Backup resource.

Returns an empty policy if the resource exists but does not have a policy set.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

getSnapshot

Gets metadata information about the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::getSnapshotAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GetSnapshotRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Snapshot

getTable

Gets metadata information about the specified table.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::getTableAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GetTableRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Table

listBackups

Lists Cloud Bigtable backups. Returns both completed and pending backups.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::listBackupsAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ListBackupsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listSnapshots

Lists all snapshots associated with the specified cluster.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::listSnapshotsAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ListSnapshotsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listTables

Lists all tables served from a specified instance.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::listTablesAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ListTablesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

modifyColumnFamilies

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.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::modifyColumnFamiliesAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Table

restoreTable

Create a new table by restoring from a completed backup. The new table must be in the same project as the instance containing the 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.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::restoreTableAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\RestoreTableRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

setIamPolicy

Sets the access control policy on a Table or Backup resource.

Replaces any existing policy.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

snapshotTable

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::snapshotTableAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\SnapshotTableRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

testIamPermissions

Returns permissions that the caller has on the specified Table or Backup resource.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::testIamPermissionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\TestIamPermissionsResponse

undeleteTable

Restores a specified table which was accidentally deleted.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::undeleteTableAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\UndeleteTableRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateBackup

Updates a pending or completed Cloud Bigtable Backup.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::updateBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\UpdateBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Backup

updateTable

Updates a specified table.

The async variant is Google\Cloud\Bigtable\Admin\V2\Client\BaseClient\self::updateTableAsync() .

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\UpdateTableRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

checkConsistencyAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CheckConsistencyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createBackupAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CreateBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createTableAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CreateTableRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createTableFromSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\CreateTableFromSnapshotRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteBackupAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DeleteBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DeleteSnapshotRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteTableAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DeleteTableRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

dropRowRangeAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\DropRowRangeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

generateConsistencyTokenAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GenerateConsistencyTokenRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getBackupAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GetBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GetSnapshotRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getTableAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\GetTableRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listBackupsAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ListBackupsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSnapshotsAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ListSnapshotsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listTablesAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ListTablesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

modifyColumnFamiliesAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\ModifyColumnFamiliesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

restoreTableAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\RestoreTableRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

snapshotTableAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\SnapshotTableRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

undeleteTableAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\UndeleteTableRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateBackupAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\UpdateBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateTableAsync

Parameters
Name	Description
request	Google\Cloud\Bigtable\Admin\V2\UpdateTableRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::backupName

Formats a string containing the fully-qualified path to represent a backup resource.

Parameters
Name	Description
project	string
instance	string
cluster	string
backup	string

Returns
Type	Description
string	The formatted backup resource.

static::clusterName

Formats a string containing the fully-qualified path to represent a cluster resource.

Parameters
Name	Description
project	string
instance	string
cluster	string

Returns
Type	Description
string	The formatted cluster resource.

static::cryptoKeyVersionName

Formats a string containing the fully-qualified path to represent a crypto_key_version resource.

Parameters
Name	Description
project	string
location	string
keyRing	string
cryptoKey	string
cryptoKeyVersion	string

Returns
Type	Description
string	The formatted crypto_key_version resource.

static::instanceName

Formats a string containing the fully-qualified path to represent a instance resource.

Parameters
Name	Description
project	string
instance	string

Returns
Type	Description
string	The formatted instance resource.

static::snapshotName

Formats a string containing the fully-qualified path to represent a snapshot resource.

Parameters
Name	Description
project	string
instance	string
cluster	string
snapshot	string

Returns
Type	Description
string	The formatted snapshot resource.

static::tableName

Formats a string containing the fully-qualified path to represent a table resource.

Parameters
Name	Description
project	string
instance	string
table	string

Returns
Type	Description
string	The formatted table resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• backup: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}
• cluster: projects/{project}/instances/{instance}/clusters/{cluster}
• cryptoKeyVersion: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
• instance: projects/{project}/instances/{instance}
• snapshot: projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}
• table: projects/{project}/instances/{instance}/tables/{table}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.