Google Cloud Bigtable Administration v2 API - Class BigtableTableAdminClientImpl (3.13.0) 

public sealed class BigtableTableAdminClientImpl : BigtableTableAdminClient

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

BigtableTableAdmin client wrapper implementation, for convenient use.

Inheritance

object > BigtableTableAdminClient > BigtableTableAdminClientImpl

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Remarks

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

Provides access to the table schemas only, not the data stored within the tables.

Constructors

BigtableTableAdminClientImpl(BigtableTableAdminClient, BigtableTableAdminSettings, ILogger)

public BigtableTableAdminClientImpl(BigtableTableAdmin.BigtableTableAdminClient grpcClient, BigtableTableAdminSettings settings, ILogger logger)

Constructs a client wrapper for the BigtableTableAdmin service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientBigtableTableAdminBigtableTableAdminClient

The underlying gRPC client.

settingsBigtableTableAdminSettings

The base BigtableTableAdminSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CopyBackupOperationsClient

public override OperationsClient CopyBackupOperationsClient { get; }

The long-running operations client for CopyBackup.

Property Value
TypeDescription
OperationsClient
Overrides

CreateAuthorizedViewOperationsClient

public override OperationsClient CreateAuthorizedViewOperationsClient { get; }

The long-running operations client for CreateAuthorizedView.

Property Value
TypeDescription
OperationsClient
Overrides

CreateBackupOperationsClient

public override OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value
TypeDescription
OperationsClient
Overrides

CreateTableFromSnapshotOperationsClient

public override OperationsClient CreateTableFromSnapshotOperationsClient { get; }

The long-running operations client for CreateTableFromSnapshot.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override BigtableTableAdmin.BigtableTableAdminClient GrpcClient { get; }

The underlying gRPC BigtableTableAdmin client

Property Value
TypeDescription
BigtableTableAdminBigtableTableAdminClient
Overrides

RestoreTableOperationsClient

public override OperationsClient RestoreTableOperationsClient { get; }

The long-running operations client for RestoreTable.

Property Value
TypeDescription
OperationsClient
Overrides

SnapshotTableOperationsClient

public override OperationsClient SnapshotTableOperationsClient { get; }

The long-running operations client for SnapshotTable.

Property Value
TypeDescription
OperationsClient
Overrides

UndeleteTableOperationsClient

public override OperationsClient UndeleteTableOperationsClient { get; }

The long-running operations client for UndeleteTable.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateAuthorizedViewOperationsClient

public override OperationsClient UpdateAuthorizedViewOperationsClient { get; }

The long-running operations client for UpdateAuthorizedView.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateTableOperationsClient

public override OperationsClient UpdateTableOperationsClient { get; }

The long-running operations client for UpdateTable.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CheckConsistency(CheckConsistencyRequest, CallSettings)

public override CheckConsistencyResponse CheckConsistency(CheckConsistencyRequest request, CallSettings callSettings = null)

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
NameDescription
requestCheckConsistencyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
CheckConsistencyResponse

The RPC response.

Overrides

CheckConsistencyAsync(CheckConsistencyRequest, CallSettings)

public override Task<CheckConsistencyResponse> CheckConsistencyAsync(CheckConsistencyRequest request, CallSettings callSettings = null)

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
NameDescription
requestCheckConsistencyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskCheckConsistencyResponse

A Task containing the RPC response.

Overrides

CopyBackup(CopyBackupRequest, CallSettings)

public override Operation<Backup, CopyBackupMetadata> CopyBackup(CopyBackupRequest request, CallSettings callSettings = null)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Parameters
NameDescription
requestCopyBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBackupCopyBackupMetadata

The RPC response.

Overrides

CopyBackupAsync(CopyBackupRequest, CallSettings)

public override Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(CopyBackupRequest request, CallSettings callSettings = null)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Parameters
NameDescription
requestCopyBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBackupCopyBackupMetadata

A Task containing the RPC response.

Overrides

CreateAuthorizedView(CreateAuthorizedViewRequest, CallSettings)

public override Operation<AuthorizedView, CreateAuthorizedViewMetadata> CreateAuthorizedView(CreateAuthorizedViewRequest request, CallSettings callSettings = null)

Creates a new AuthorizedView in a table.

Parameters
NameDescription
requestCreateAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAuthorizedViewCreateAuthorizedViewMetadata

The RPC response.

Overrides

CreateAuthorizedViewAsync(CreateAuthorizedViewRequest, CallSettings)

public override Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> CreateAuthorizedViewAsync(CreateAuthorizedViewRequest request, CallSettings callSettings = null)

Creates a new AuthorizedView in a table.

Parameters
NameDescription
requestCreateAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata

A Task containing the RPC response.

Overrides

CreateBackup(CreateBackupRequest, CallSettings)

public override Operation<Backup, CreateBackupMetadata> CreateBackup(CreateBackupRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBackupCreateBackupMetadata

The RPC response.

Overrides

CreateBackupAsync(CreateBackupRequest, CallSettings)

public override Task<Operation<Backup, CreateBackupMetadata>> CreateBackupAsync(CreateBackupRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBackupCreateBackupMetadata

A Task containing the RPC response.

Overrides

CreateTable(CreateTableRequest, CallSettings)

public override Table CreateTable(CreateTableRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Table

The RPC response.

Overrides

CreateTableAsync(CreateTableRequest, CallSettings)

public override Task<Table> CreateTableAsync(CreateTableRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTable

A Task containing the RPC response.

Overrides

CreateTableFromSnapshot(CreateTableFromSnapshotRequest, CallSettings)

public override Operation<Table, CreateTableFromSnapshotMetadata> CreateTableFromSnapshot(CreateTableFromSnapshotRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateTableFromSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTableCreateTableFromSnapshotMetadata

The RPC response.

Overrides

CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest, CallSettings)

public override Task<Operation<Table, CreateTableFromSnapshotMetadata>> CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateTableFromSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTableCreateTableFromSnapshotMetadata

A Task containing the RPC response.

Overrides

DeleteAuthorizedView(DeleteAuthorizedViewRequest, CallSettings)

public override void DeleteAuthorizedView(DeleteAuthorizedViewRequest request, CallSettings callSettings = null)

Permanently deletes a specified AuthorizedView.

Parameters
NameDescription
requestDeleteAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteAuthorizedViewAsync(DeleteAuthorizedViewRequest, CallSettings)

public override Task DeleteAuthorizedViewAsync(DeleteAuthorizedViewRequest request, CallSettings callSettings = null)

Permanently deletes a specified AuthorizedView.

Parameters
NameDescription
requestDeleteAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteBackup(DeleteBackupRequest, CallSettings)

public override void DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

public override Task DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteSnapshot(DeleteSnapshotRequest, CallSettings)

public override void DeleteSnapshot(DeleteSnapshotRequest request, CallSettings callSettings = null)

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
NameDescription
requestDeleteSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteSnapshotAsync(DeleteSnapshotRequest, CallSettings)

public override Task DeleteSnapshotAsync(DeleteSnapshotRequest request, CallSettings callSettings = null)

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
NameDescription
requestDeleteSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteTable(DeleteTableRequest, CallSettings)

public override void DeleteTable(DeleteTableRequest request, CallSettings callSettings = null)

Permanently deletes a specified table and all of its data.

Parameters
NameDescription
requestDeleteTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteTableAsync(DeleteTableRequest, CallSettings)

public override Task DeleteTableAsync(DeleteTableRequest request, CallSettings callSettings = null)

Permanently deletes a specified table and all of its data.

Parameters
NameDescription
requestDeleteTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DropRowRange(DropRowRangeRequest, CallSettings)

public override void DropRowRange(DropRowRangeRequest request, CallSettings callSettings = null)

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
NameDescription
requestDropRowRangeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DropRowRangeAsync(DropRowRangeRequest, CallSettings)

public override Task DropRowRangeAsync(DropRowRangeRequest request, CallSettings callSettings = null)

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
NameDescription
requestDropRowRangeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GenerateConsistencyToken(GenerateConsistencyTokenRequest, CallSettings)

public override GenerateConsistencyTokenResponse GenerateConsistencyToken(GenerateConsistencyTokenRequest request, CallSettings callSettings = null)

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
NameDescription
requestGenerateConsistencyTokenRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerateConsistencyTokenResponse

The RPC response.

Overrides

GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest, CallSettings)

public override Task<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest request, CallSettings callSettings = null)

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
NameDescription
requestGenerateConsistencyTokenRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGenerateConsistencyTokenResponse

A Task containing the RPC response.

Overrides

GetAuthorizedView(GetAuthorizedViewRequest, CallSettings)

public override AuthorizedView GetAuthorizedView(GetAuthorizedViewRequest request, CallSettings callSettings = null)

Gets information from a specified AuthorizedView.

Parameters
NameDescription
requestGetAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AuthorizedView

The RPC response.

Overrides

GetAuthorizedViewAsync(GetAuthorizedViewRequest, CallSettings)

public override Task<AuthorizedView> GetAuthorizedViewAsync(GetAuthorizedViewRequest request, CallSettings callSettings = null)

Gets information from a specified AuthorizedView.

Parameters
NameDescription
requestGetAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAuthorizedView

A Task containing the RPC response.

Overrides

GetBackup(GetBackupRequest, CallSettings)

public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
NameDescription
requestGetBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Backup

The RPC response.

Overrides

GetBackupAsync(GetBackupRequest, CallSettings)

public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
NameDescription
requestGetBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskBackup

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

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
NameDescription
requestGetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

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
NameDescription
requestGetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Overrides

GetSnapshot(GetSnapshotRequest, CallSettings)

public override Snapshot GetSnapshot(GetSnapshotRequest request, CallSettings callSettings = null)

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
NameDescription
requestGetSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Snapshot

The RPC response.

Overrides

GetSnapshotAsync(GetSnapshotRequest, CallSettings)

public override Task<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CallSettings callSettings = null)

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
NameDescription
requestGetSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSnapshot

A Task containing the RPC response.

Overrides

GetTable(GetTableRequest, CallSettings)

public override Table GetTable(GetTableRequest request, CallSettings callSettings = null)

Gets metadata information about the specified table.

Parameters
NameDescription
requestGetTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Table

The RPC response.

Overrides

GetTableAsync(GetTableRequest, CallSettings)

public override Task<Table> GetTableAsync(GetTableRequest request, CallSettings callSettings = null)

Gets metadata information about the specified table.

Parameters
NameDescription
requestGetTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTable

A Task containing the RPC response.

Overrides

ListAuthorizedViews(ListAuthorizedViewsRequest, CallSettings)

public override PagedEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViews(ListAuthorizedViewsRequest request, CallSettings callSettings = null)

Lists all AuthorizedViews from a specific table.

Parameters
NameDescription
requestListAuthorizedViewsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAuthorizedViewsResponseAuthorizedView

A pageable sequence of AuthorizedView resources.

Overrides

ListAuthorizedViewsAsync(ListAuthorizedViewsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViewsAsync(ListAuthorizedViewsRequest request, CallSettings callSettings = null)

Lists all AuthorizedViews from a specific table.

Parameters
NameDescription
requestListAuthorizedViewsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAuthorizedViewsResponseAuthorizedView

A pageable asynchronous sequence of AuthorizedView resources.

Overrides

ListBackups(ListBackupsRequest, CallSettings)

public override PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListBackupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Overrides

ListBackupsAsync(ListBackupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListBackupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Overrides

ListSnapshots(ListSnapshotsRequest, CallSettings)

public override PagedEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshots(ListSnapshotsRequest request, CallSettings callSettings = null)

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
NameDescription
requestListSnapshotsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListSnapshotsResponseSnapshot

A pageable sequence of Snapshot resources.

Overrides

ListSnapshotsAsync(ListSnapshotsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshotsAsync(ListSnapshotsRequest request, CallSettings callSettings = null)

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
NameDescription
requestListSnapshotsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListSnapshotsResponseSnapshot

A pageable asynchronous sequence of Snapshot resources.

Overrides

ListTables(ListTablesRequest, CallSettings)

public override PagedEnumerable<ListTablesResponse, Table> ListTables(ListTablesRequest request, CallSettings callSettings = null)

Lists all tables served from a specified instance.

Parameters
NameDescription
requestListTablesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTablesResponseTable

A pageable sequence of Table resources.

Overrides

ListTablesAsync(ListTablesRequest, CallSettings)

public override PagedAsyncEnumerable<ListTablesResponse, Table> ListTablesAsync(ListTablesRequest request, CallSettings callSettings = null)

Lists all tables served from a specified instance.

Parameters
NameDescription
requestListTablesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTablesResponseTable

A pageable asynchronous sequence of Table resources.

Overrides

ModifyColumnFamilies(ModifyColumnFamiliesRequest, CallSettings)

public override Table ModifyColumnFamilies(ModifyColumnFamiliesRequest request, CallSettings callSettings = null)

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
NameDescription
requestModifyColumnFamiliesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Table

The RPC response.

Overrides

ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest, CallSettings)

public override Task<Table> ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest request, CallSettings callSettings = null)

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
NameDescription
requestModifyColumnFamiliesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTable

A Task containing the RPC response.

Overrides

RestoreTable(RestoreTableRequest, CallSettings)

public override Operation<Table, RestoreTableMetadata> RestoreTable(RestoreTableRequest request, CallSettings callSettings = null)

Create a new table by restoring from a completed 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
NameDescription
requestRestoreTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTableRestoreTableMetadata

The RPC response.

Overrides

RestoreTableAsync(RestoreTableRequest, CallSettings)

public override Task<Operation<Table, RestoreTableMetadata>> RestoreTableAsync(RestoreTableRequest request, CallSettings callSettings = null)

Create a new table by restoring from a completed 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
NameDescription
requestRestoreTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTableRestoreTableMetadata

A Task containing the RPC response.

Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Overrides

SnapshotTable(SnapshotTableRequest, CallSettings)

public override Operation<Snapshot, SnapshotTableMetadata> SnapshotTable(SnapshotTableRequest request, CallSettings callSettings = null)

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
NameDescription
requestSnapshotTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSnapshotSnapshotTableMetadata

The RPC response.

Overrides

SnapshotTableAsync(SnapshotTableRequest, CallSettings)

public override Task<Operation<Snapshot, SnapshotTableMetadata>> SnapshotTableAsync(SnapshotTableRequest request, CallSettings callSettings = null)

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
NameDescription
requestSnapshotTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSnapshotSnapshotTableMetadata

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestTestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestIamPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestTestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Overrides

UndeleteTable(UndeleteTableRequest, CallSettings)

public override Operation<Table, UndeleteTableMetadata> UndeleteTable(UndeleteTableRequest request, CallSettings callSettings = null)

Restores a specified table which was accidentally deleted.

Parameters
NameDescription
requestUndeleteTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTableUndeleteTableMetadata

The RPC response.

Overrides

UndeleteTableAsync(UndeleteTableRequest, CallSettings)

public override Task<Operation<Table, UndeleteTableMetadata>> UndeleteTableAsync(UndeleteTableRequest request, CallSettings callSettings = null)

Restores a specified table which was accidentally deleted.

Parameters
NameDescription
requestUndeleteTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTableUndeleteTableMetadata

A Task containing the RPC response.

Overrides

UpdateAuthorizedView(UpdateAuthorizedViewRequest, CallSettings)

public override Operation<AuthorizedView, UpdateAuthorizedViewMetadata> UpdateAuthorizedView(UpdateAuthorizedViewRequest request, CallSettings callSettings = null)

Updates an AuthorizedView in a table.

Parameters
NameDescription
requestUpdateAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAuthorizedViewUpdateAuthorizedViewMetadata

The RPC response.

Overrides

UpdateAuthorizedViewAsync(UpdateAuthorizedViewRequest, CallSettings)

public override Task<Operation<AuthorizedView, UpdateAuthorizedViewMetadata>> UpdateAuthorizedViewAsync(UpdateAuthorizedViewRequest request, CallSettings callSettings = null)

Updates an AuthorizedView in a table.

Parameters
NameDescription
requestUpdateAuthorizedViewRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAuthorizedViewUpdateAuthorizedViewMetadata

A Task containing the RPC response.

Overrides

UpdateBackup(UpdateBackupRequest, CallSettings)

public override Backup UpdateBackup(UpdateBackupRequest request, CallSettings callSettings = null)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Backup

The RPC response.

Overrides

UpdateBackupAsync(UpdateBackupRequest, CallSettings)

public override Task<Backup> UpdateBackupAsync(UpdateBackupRequest request, CallSettings callSettings = null)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskBackup

A Task containing the RPC response.

Overrides

UpdateTable(UpdateTableRequest, CallSettings)

public override Operation<Table, UpdateTableMetadata> UpdateTable(UpdateTableRequest request, CallSettings callSettings = null)

Updates a specified table.

Parameters
NameDescription
requestUpdateTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTableUpdateTableMetadata

The RPC response.

Overrides

UpdateTableAsync(UpdateTableRequest, CallSettings)

public override Task<Operation<Table, UpdateTableMetadata>> UpdateTableAsync(UpdateTableRequest request, CallSettings callSettings = null)

Updates a specified table.

Parameters
NameDescription
requestUpdateTableRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTableUpdateTableMetadata

A Task containing the RPC response.

Overrides