Google Cloud Bigtable Administration v2 API - Class BigtableTableAdmin.BigtableTableAdminClient (3.5.0)

Version 3.5.0

• 3.21.0 (latest)
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0

public class BigtableTableAdmin.BigtableTableAdminClient : ClientBase<BigtableTableAdmin.BigtableTableAdminClient>

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class BigtableTableAdmin.BigtableTableAdminClient.

Client for BigtableTableAdmin

Inheritance

object > ClientBase > ClientBaseBigtableTableAdminBigtableTableAdminClient > BigtableTableAdmin.BigtableTableAdminClient

Inherited Members

ClientBase<BigtableTableAdmin.BigtableTableAdminClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

BigtableTableAdminClient()

protected BigtableTableAdminClient()

Protected parameterless constructor to allow creation of test doubles.

BigtableTableAdminClient(CallInvoker)

public BigtableTableAdminClient(CallInvoker callInvoker)

Creates a new client for BigtableTableAdmin that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

BigtableTableAdminClient(ChannelBase)

public BigtableTableAdminClient(ChannelBase channel)

Creates a new client for BigtableTableAdmin

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

BigtableTableAdminClient(ClientBaseConfiguration)

protected BigtableTableAdminClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CheckConsistency(CheckConsistencyRequest, CallOptions)

public virtual CheckConsistencyResponse CheckConsistency(CheckConsistencyRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CheckConsistencyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CheckConsistencyResponse	The response received from the server.

CheckConsistency(CheckConsistencyRequest, Metadata, DateTime?, CancellationToken)

public virtual CheckConsistencyResponse CheckConsistency(CheckConsistencyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	CheckConsistencyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
CheckConsistencyResponse	The response received from the server.

CheckConsistencyAsync(CheckConsistencyRequest, CallOptions)

public virtual AsyncUnaryCall<CheckConsistencyResponse> CheckConsistencyAsync(CheckConsistencyRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CheckConsistencyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCheckConsistencyResponse	The call object.

CheckConsistencyAsync(CheckConsistencyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CheckConsistencyResponse> CheckConsistencyAsync(CheckConsistencyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	CheckConsistencyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallCheckConsistencyResponse	The call object.

CreateBackup(CreateBackupRequest, CallOptions)

public virtual Operation CreateBackup(CreateBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateBackup(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateBackup(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateBackupAsync(CreateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateBackupAsync(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

CreateTable(CreateTableRequest, CallOptions)

public virtual Table CreateTable(CreateTableRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CreateTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Table	The response received from the server.

CreateTable(CreateTableRequest, Metadata, DateTime?, CancellationToken)

public virtual Table CreateTable(CreateTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	CreateTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Table	The response received from the server.

CreateTableAsync(CreateTableRequest, CallOptions)

public virtual AsyncUnaryCall<Table> CreateTableAsync(CreateTableRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CreateTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTable	The call object.

CreateTableAsync(CreateTableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Table> CreateTableAsync(CreateTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	CreateTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTable	The call object.

CreateTableFromSnapshot(CreateTableFromSnapshotRequest, CallOptions)

public virtual Operation CreateTableFromSnapshot(CreateTableFromSnapshotRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CreateTableFromSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateTableFromSnapshot(CreateTableFromSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateTableFromSnapshot(CreateTableFromSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	CreateTableFromSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CreateTableFromSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	CreateTableFromSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteBackup(DeleteBackupRequest, CallOptions)

public virtual Empty DeleteBackup(DeleteBackupRequest request, CallOptions options)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteBackup(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteBackup(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteBackupAsync(DeleteBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteBackupAsync(DeleteBackupRequest request, CallOptions options)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteBackupAsync(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteBackupAsync(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteSnapshot(DeleteSnapshotRequest, CallOptions)

public virtual Empty DeleteSnapshot(DeleteSnapshotRequest request, CallOptions options)

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.

Parameters
Name	Description
request	DeleteSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteSnapshot(DeleteSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteSnapshot(DeleteSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	DeleteSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteSnapshotAsync(DeleteSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteSnapshotAsync(DeleteSnapshotRequest request, CallOptions options)

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.

Parameters
Name	Description
request	DeleteSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteSnapshotAsync(DeleteSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteSnapshotAsync(DeleteSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	DeleteSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteTable(DeleteTableRequest, CallOptions)

public virtual Empty DeleteTable(DeleteTableRequest request, CallOptions options)

Permanently deletes a specified table and all of its data.

Parameters
Name	Description
request	DeleteTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteTable(DeleteTableRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteTable(DeleteTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Permanently deletes a specified table and all of its data.

Parameters
Name	Description
request	DeleteTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteTableAsync(DeleteTableRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteTableAsync(DeleteTableRequest request, CallOptions options)

Permanently deletes a specified table and all of its data.

Parameters
Name	Description
request	DeleteTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteTableAsync(DeleteTableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteTableAsync(DeleteTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Permanently deletes a specified table and all of its data.

Parameters
Name	Description
request	DeleteTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DropRowRange(DropRowRangeRequest, CallOptions)

public virtual Empty DropRowRange(DropRowRangeRequest request, CallOptions options)

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.

Parameters
Name	Description
request	DropRowRangeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DropRowRange(DropRowRangeRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DropRowRange(DropRowRangeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	DropRowRangeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DropRowRangeAsync(DropRowRangeRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DropRowRangeAsync(DropRowRangeRequest request, CallOptions options)

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.

Parameters
Name	Description
request	DropRowRangeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DropRowRangeAsync(DropRowRangeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DropRowRangeAsync(DropRowRangeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	DropRowRangeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GenerateConsistencyToken(GenerateConsistencyTokenRequest, CallOptions)

public virtual GenerateConsistencyTokenResponse GenerateConsistencyToken(GenerateConsistencyTokenRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GenerateConsistencyTokenRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GenerateConsistencyTokenResponse	The response received from the server.

GenerateConsistencyToken(GenerateConsistencyTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateConsistencyTokenResponse GenerateConsistencyToken(GenerateConsistencyTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	GenerateConsistencyTokenRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
GenerateConsistencyTokenResponse	The response received from the server.

GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GenerateConsistencyTokenRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallGenerateConsistencyTokenResponse	The call object.

GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	GenerateConsistencyTokenRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallGenerateConsistencyTokenResponse	The call object.

GetBackup(GetBackupRequest, CallOptions)

public virtual Backup GetBackup(GetBackupRequest request, CallOptions options)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Backup	The response received from the server.

GetBackup(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup GetBackup(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Backup	The response received from the server.

GetBackupAsync(GetBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, CallOptions options)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

GetBackupAsync(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetSnapshot(GetSnapshotRequest, CallOptions)

public virtual Snapshot GetSnapshot(GetSnapshotRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GetSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Snapshot	The response received from the server.

GetSnapshot(GetSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Snapshot GetSnapshot(GetSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	GetSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Snapshot	The response received from the server.

GetSnapshotAsync(GetSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GetSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSnapshot	The call object.

GetSnapshotAsync(GetSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	GetSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSnapshot	The call object.

GetTable(GetTableRequest, CallOptions)

public virtual Table GetTable(GetTableRequest request, CallOptions options)

Gets metadata information about the specified table.

Parameters
Name	Description
request	GetTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Table	The response received from the server.

GetTable(GetTableRequest, Metadata, DateTime?, CancellationToken)

public virtual Table GetTable(GetTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets metadata information about the specified table.

Parameters
Name	Description
request	GetTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Table	The response received from the server.

GetTableAsync(GetTableRequest, CallOptions)

public virtual AsyncUnaryCall<Table> GetTableAsync(GetTableRequest request, CallOptions options)

Gets metadata information about the specified table.

Parameters
Name	Description
request	GetTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTable	The call object.

GetTableAsync(GetTableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Table> GetTableAsync(GetTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets metadata information about the specified table.

Parameters
Name	Description
request	GetTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTable	The call object.

ListBackups(ListBackupsRequest, CallOptions)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListBackupsResponse	The response received from the server.

ListBackups(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListBackupsResponse	The response received from the server.

ListBackupsAsync(ListBackupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListBackupsResponse	The call object.

ListBackupsAsync(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListBackupsResponse	The call object.

ListSnapshots(ListSnapshotsRequest, CallOptions)

public virtual ListSnapshotsResponse ListSnapshots(ListSnapshotsRequest request, CallOptions options)

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.

Parameters
Name	Description
request	ListSnapshotsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListSnapshotsResponse	The response received from the server.

ListSnapshots(ListSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSnapshotsResponse ListSnapshots(ListSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	ListSnapshotsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListSnapshotsResponse	The response received from the server.

ListSnapshotsAsync(ListSnapshotsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, CallOptions options)

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.

Parameters
Name	Description
request	ListSnapshotsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListSnapshotsResponse	The call object.

ListSnapshotsAsync(ListSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	ListSnapshotsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListSnapshotsResponse	The call object.

ListTables(ListTablesRequest, CallOptions)

public virtual ListTablesResponse ListTables(ListTablesRequest request, CallOptions options)

Lists all tables served from a specified instance.

Parameters
Name	Description
request	ListTablesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListTablesResponse	The response received from the server.

ListTables(ListTablesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTablesResponse ListTables(ListTablesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all tables served from a specified instance.

Parameters
Name	Description
request	ListTablesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListTablesResponse	The response received from the server.

ListTablesAsync(ListTablesRequest, CallOptions)

public virtual AsyncUnaryCall<ListTablesResponse> ListTablesAsync(ListTablesRequest request, CallOptions options)

Lists all tables served from a specified instance.

Parameters
Name	Description
request	ListTablesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListTablesResponse	The call object.

ListTablesAsync(ListTablesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTablesResponse> ListTablesAsync(ListTablesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all tables served from a specified instance.

Parameters
Name	Description
request	ListTablesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListTablesResponse	The call object.

ModifyColumnFamilies(ModifyColumnFamiliesRequest, CallOptions)

public virtual Table ModifyColumnFamilies(ModifyColumnFamiliesRequest request, CallOptions options)

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.

Parameters
Name	Description
request	ModifyColumnFamiliesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Table	The response received from the server.

ModifyColumnFamilies(ModifyColumnFamiliesRequest, Metadata, DateTime?, CancellationToken)

public virtual Table ModifyColumnFamilies(ModifyColumnFamiliesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	ModifyColumnFamiliesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Table	The response received from the server.

ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest, CallOptions)

public virtual AsyncUnaryCall<Table> ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest request, CallOptions options)

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.

Parameters
Name	Description
request	ModifyColumnFamiliesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTable	The call object.

ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Table> ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	ModifyColumnFamiliesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTable	The call object.

NewInstance(ClientBaseConfiguration)

protected override BigtableTableAdmin.BigtableTableAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
BigtableTableAdminBigtableTableAdminClient

Overrides

ClientBase<BigtableTableAdmin.BigtableTableAdminClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RestoreTable(RestoreTableRequest, CallOptions)

public virtual Operation RestoreTable(RestoreTableRequest request, CallOptions options)

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][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is [Table][google.bigtable.admin.v2.Table], if successful.

Parameters
Name	Description
request	RestoreTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RestoreTable(RestoreTableRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RestoreTable(RestoreTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is [Table][google.bigtable.admin.v2.Table], if successful.

Parameters
Name	Description
request	RestoreTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RestoreTableAsync(RestoreTableRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestoreTableAsync(RestoreTableRequest request, CallOptions options)

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][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is [Table][google.bigtable.admin.v2.Table], if successful.

Parameters
Name	Description
request	RestoreTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RestoreTableAsync(RestoreTableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestoreTableAsync(RestoreTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is [Table][google.bigtable.admin.v2.Table], if successful.

Parameters
Name	Description
request	RestoreTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SnapshotTable(SnapshotTableRequest, CallOptions)

public virtual Operation SnapshotTable(SnapshotTableRequest request, CallOptions options)

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.

Parameters
Name	Description
request	SnapshotTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

SnapshotTable(SnapshotTableRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SnapshotTable(SnapshotTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	SnapshotTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

SnapshotTableAsync(SnapshotTableRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SnapshotTableAsync(SnapshotTableRequest request, CallOptions options)

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.

Parameters
Name	Description
request	SnapshotTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SnapshotTableAsync(SnapshotTableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SnapshotTableAsync(SnapshotTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	SnapshotTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

UndeleteTable(UndeleteTableRequest, CallOptions)

public virtual Operation UndeleteTable(UndeleteTableRequest request, CallOptions options)

Restores a specified table which was accidentally deleted.

Parameters
Name	Description
request	UndeleteTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UndeleteTable(UndeleteTableRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UndeleteTable(UndeleteTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Restores a specified table which was accidentally deleted.

Parameters
Name	Description
request	UndeleteTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UndeleteTableAsync(UndeleteTableRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UndeleteTableAsync(UndeleteTableRequest request, CallOptions options)

Restores a specified table which was accidentally deleted.

Parameters
Name	Description
request	UndeleteTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UndeleteTableAsync(UndeleteTableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UndeleteTableAsync(UndeleteTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Restores a specified table which was accidentally deleted.

Parameters
Name	Description
request	UndeleteTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateBackup(UpdateBackupRequest, CallOptions)

public virtual Backup UpdateBackup(UpdateBackupRequest request, CallOptions options)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Backup	The response received from the server.

UpdateBackup(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup UpdateBackup(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Backup	The response received from the server.

UpdateBackupAsync(UpdateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> UpdateBackupAsync(UpdateBackupRequest request, CallOptions options)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

UpdateBackupAsync(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> UpdateBackupAsync(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

UpdateTable(UpdateTableRequest, CallOptions)

public virtual Operation UpdateTable(UpdateTableRequest request, CallOptions options)

Updates a specified table.

Parameters
Name	Description
request	UpdateTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateTable(UpdateTableRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateTable(UpdateTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a specified table.

Parameters
Name	Description
request	UpdateTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateTableAsync(UpdateTableRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateTableAsync(UpdateTableRequest request, CallOptions options)

Updates a specified table.

Parameters
Name	Description
request	UpdateTableRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateTableAsync(UpdateTableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateTableAsync(UpdateTableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a specified table.

Parameters
Name	Description
request	UpdateTableRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.