Google Cloud Bigtable Administration v2 API - Class BigtableTableAdmin.BigtableTableAdminBase (3.11.0)

Version 3.11.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

[BindServiceMethod(typeof(BigtableTableAdmin), "BindService")]
public abstract class BigtableTableAdmin.BigtableTableAdminBase

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

Base class for server-side implementations of BigtableTableAdmin

Inheritance

object > BigtableTableAdmin.BigtableTableAdminBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Methods

CheckConsistency(CheckConsistencyRequest, ServerCallContext)

public virtual Task<CheckConsistencyResponse> CheckConsistency(CheckConsistencyRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCheckConsistencyResponse	The response to send back to the client (wrapped by a task).

CopyBackup(CopyBackupRequest, ServerCallContext)

public virtual Task<Operation> CopyBackup(CopyBackupRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CopyBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateAuthorizedView(CreateAuthorizedViewRequest, ServerCallContext)

public virtual Task<Operation> CreateAuthorizedView(CreateAuthorizedViewRequest request, ServerCallContext context)

Creates a new AuthorizedView in a table.

Parameters
Name	Description
request	CreateAuthorizedViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateBackup(CreateBackupRequest, ServerCallContext)

public virtual Task<Operation> CreateBackup(CreateBackupRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateTable(CreateTableRequest, ServerCallContext)

public virtual Task<Table> CreateTable(CreateTableRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTable	The response to send back to the client (wrapped by a task).

CreateTableFromSnapshot(CreateTableFromSnapshotRequest, ServerCallContext)

public virtual Task<Operation> CreateTableFromSnapshot(CreateTableFromSnapshotRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteAuthorizedView(DeleteAuthorizedViewRequest, ServerCallContext)

public virtual Task<Empty> DeleteAuthorizedView(DeleteAuthorizedViewRequest request, ServerCallContext context)

Permanently deletes a specified AuthorizedView.

Parameters
Name	Description
request	DeleteAuthorizedViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteBackup(DeleteBackupRequest, ServerCallContext)

public virtual Task<Empty> DeleteBackup(DeleteBackupRequest request, ServerCallContext context)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
Name	Description
request	DeleteBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteSnapshot(DeleteSnapshotRequest, ServerCallContext)

public virtual Task<Empty> DeleteSnapshot(DeleteSnapshotRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteTable(DeleteTableRequest, ServerCallContext)

public virtual Task<Empty> DeleteTable(DeleteTableRequest request, ServerCallContext context)

Permanently deletes a specified table and all of its data.

Parameters
Name	Description
request	DeleteTableRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DropRowRange(DropRowRangeRequest, ServerCallContext)

public virtual Task<Empty> DropRowRange(DropRowRangeRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GenerateConsistencyToken(GenerateConsistencyTokenRequest, ServerCallContext)

public virtual Task<GenerateConsistencyTokenResponse> GenerateConsistencyToken(GenerateConsistencyTokenRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateConsistencyTokenResponse	The response to send back to the client (wrapped by a task).

GetAuthorizedView(GetAuthorizedViewRequest, ServerCallContext)

public virtual Task<AuthorizedView> GetAuthorizedView(GetAuthorizedViewRequest request, ServerCallContext context)

Gets information from a specified AuthorizedView.

Parameters
Name	Description
request	GetAuthorizedViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAuthorizedView	The response to send back to the client (wrapped by a task).

GetBackup(GetBackupRequest, ServerCallContext)

public virtual Task<Backup> GetBackup(GetBackupRequest request, ServerCallContext context)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	GetBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackup	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPolicy	The response to send back to the client (wrapped by a task).

GetSnapshot(GetSnapshotRequest, ServerCallContext)

public virtual Task<Snapshot> GetSnapshot(GetSnapshotRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSnapshot	The response to send back to the client (wrapped by a task).

GetTable(GetTableRequest, ServerCallContext)

public virtual Task<Table> GetTable(GetTableRequest request, ServerCallContext context)

Gets metadata information about the specified table.

Parameters
Name	Description
request	GetTableRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTable	The response to send back to the client (wrapped by a task).

ListAuthorizedViews(ListAuthorizedViewsRequest, ServerCallContext)

public virtual Task<ListAuthorizedViewsResponse> ListAuthorizedViews(ListAuthorizedViewsRequest request, ServerCallContext context)

Lists all AuthorizedViews from a specific table.

Parameters
Name	Description
request	ListAuthorizedViewsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAuthorizedViewsResponse	The response to send back to the client (wrapped by a task).

ListBackups(ListBackupsRequest, ServerCallContext)

public virtual Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListBackupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListBackupsResponse	The response to send back to the client (wrapped by a task).

ListSnapshots(ListSnapshotsRequest, ServerCallContext)

public virtual Task<ListSnapshotsResponse> ListSnapshots(ListSnapshotsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListSnapshotsResponse	The response to send back to the client (wrapped by a task).

ListTables(ListTablesRequest, ServerCallContext)

public virtual Task<ListTablesResponse> ListTables(ListTablesRequest request, ServerCallContext context)

Lists all tables served from a specified instance.

Parameters
Name	Description
request	ListTablesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTablesResponse	The response to send back to the client (wrapped by a task).

ModifyColumnFamilies(ModifyColumnFamiliesRequest, ServerCallContext)

public virtual Task<Table> ModifyColumnFamilies(ModifyColumnFamiliesRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTable	The response to send back to the client (wrapped by a task).

RestoreTable(RestoreTableRequest, ServerCallContext)

public virtual Task<Operation> RestoreTable(RestoreTableRequest request, ServerCallContext context)

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
Name	Description
request	RestoreTableRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPolicy	The response to send back to the client (wrapped by a task).

SnapshotTable(SnapshotTableRequest, ServerCallContext)

public virtual Task<Operation> SnapshotTable(SnapshotTableRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTestIamPermissionsResponse	The response to send back to the client (wrapped by a task).

UndeleteTable(UndeleteTableRequest, ServerCallContext)

public virtual Task<Operation> UndeleteTable(UndeleteTableRequest request, ServerCallContext context)

Restores a specified table which was accidentally deleted.

Parameters
Name	Description
request	UndeleteTableRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateAuthorizedView(UpdateAuthorizedViewRequest, ServerCallContext)

public virtual Task<Operation> UpdateAuthorizedView(UpdateAuthorizedViewRequest request, ServerCallContext context)

Updates an AuthorizedView in a table.

Parameters
Name	Description
request	UpdateAuthorizedViewRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateBackup(UpdateBackupRequest, ServerCallContext)

public virtual Task<Backup> UpdateBackup(UpdateBackupRequest request, ServerCallContext context)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackup	The response to send back to the client (wrapped by a task).

UpdateTable(UpdateTableRequest, ServerCallContext)

public virtual Task<Operation> UpdateTable(UpdateTableRequest request, ServerCallContext context)

Updates a specified table.

Parameters
Name	Description
request	UpdateTableRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).