public sealed class BigtableTableAdminClientImpl : BigtableTableAdminClientReference documentation and code samples for the Google Cloud Bigtable Administration v2 API class BigtableTableAdminClientImpl.
BigtableTableAdmin client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Bigtable.Admin.V2Assembly
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 | |
|---|---|
| Name | Description |
grpcClient | BigtableTableAdminBigtableTableAdminClientThe underlying gRPC client. |
settings | BigtableTableAdminSettingsThe base BigtableTableAdminSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CreateBackupOperationsClient
public override OperationsClient CreateBackupOperationsClient { get; }The long-running operations client for CreateBackup.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateTableFromSnapshotOperationsClient
public override OperationsClient CreateTableFromSnapshotOperationsClient { get; }The long-running operations client for CreateTableFromSnapshot.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override BigtableTableAdmin.BigtableTableAdminClient GrpcClient { get; }The underlying gRPC BigtableTableAdmin client
| Property Value | |
|---|---|
| Type | Description |
BigtableTableAdminBigtableTableAdminClient | |
RestoreTableOperationsClient
public override OperationsClient RestoreTableOperationsClient { get; }The long-running operations client for RestoreTable.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SnapshotTableOperationsClient
public override OperationsClient SnapshotTableOperationsClient { get; }The long-running operations client for SnapshotTable.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UndeleteTableOperationsClient
public override OperationsClient UndeleteTableOperationsClient { get; }The long-running operations client for UndeleteTable.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateTableOperationsClient
public override OperationsClient UpdateTableOperationsClient { get; }The long-running operations client for UpdateTable.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | |
|---|---|
| Name | Description |
request | CheckConsistencyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CheckConsistencyResponse | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CheckConsistencyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCheckConsistencyResponse | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCreateBackupMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateTableFromSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableCreateTableFromSnapshotMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateTableFromSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A Task containing the RPC response. |
DeleteBackup(DeleteBackupRequest, CallSettings)
public override void DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a pending or completed Cloud Bigtable backup.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteBackupAsync(DeleteBackupRequest, CallSettings)
public override Task DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a pending or completed Cloud Bigtable backup.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | DeleteSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | |
|---|---|
| Name | Description |
request | DeleteSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteTable(DeleteTableRequest, CallSettings)
public override void DeleteTable(DeleteTableRequest request, CallSettings callSettings = null)Permanently deletes a specified table and all of its data.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteTableAsync(DeleteTableRequest, CallSettings)
public override Task DeleteTableAsync(DeleteTableRequest request, CallSettings callSettings = null)Permanently deletes a specified table and all of its data.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | DropRowRangeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | |
|---|---|
| Name | Description |
request | DropRowRangeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | GenerateConsistencyTokenRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GenerateConsistencyTokenResponse | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | GenerateConsistencyTokenRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateConsistencyTokenResponse | A Task containing the RPC response. |
GetBackup(GetBackupRequest, CallSettings)
public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)Gets metadata on a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
request | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
GetBackupAsync(GetBackupRequest, CallSettings)
public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)Gets metadata on a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
request | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
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.