Google Cloud Bigtable Administration v2 API - Class BigtableTableAdminClient (3.3.0)

public abstract class BigtableTableAdminClient

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

BigtableTableAdmin client wrapper, for convenient use.

Inheritance

Object > BigtableTableAdminClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

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.

Properties

CreateBackupOperationsClient

public virtual OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value

Type	Description
OperationsClient

CreateTableFromSnapshotOperationsClient

public virtual OperationsClient CreateTableFromSnapshotOperationsClient { get; }

The long-running operations client for CreateTableFromSnapshot.

Property Value

Type	Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the BigtableTableAdmin service, which is a host of "bigtableadmin.googleapis.com" and a port of 443.

Property Value

Type	Description
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default BigtableTableAdmin scopes.

Property Value

Type	Description
IReadOnlyList<String>

Remarks

The default BigtableTableAdmin scopes are:

GrpcClient

public virtual BigtableTableAdmin.BigtableTableAdminClient GrpcClient { get; }

The underlying gRPC BigtableTableAdmin client

Property Value

Type	Description
BigtableTableAdmin.BigtableTableAdminClient

RestoreTableOperationsClient

public virtual OperationsClient RestoreTableOperationsClient { get; }

The long-running operations client for RestoreTable.

Property Value

Type	Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value

Type	Description
ServiceMetadata

SnapshotTableOperationsClient

public virtual OperationsClient SnapshotTableOperationsClient { get; }

The long-running operations client for SnapshotTable.

Property Value

Type	Description
OperationsClient

UndeleteTableOperationsClient

public virtual OperationsClient UndeleteTableOperationsClient { get; }

The long-running operations client for UndeleteTable.

Property Value

Type	Description
OperationsClient

UpdateTableOperationsClient

public virtual OperationsClient UpdateTableOperationsClient { get; }

The long-running operations client for UpdateTable.

Property Value

Type	Description
OperationsClient

Methods

CheckConsistency(CheckConsistencyRequest, CallSettings)

public virtual 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	`CheckConsistencyRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
CheckConsistencyResponse	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
CheckConsistencyRequest request = new CheckConsistencyRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    ConsistencyToken = "",
};
// Make the request
CheckConsistencyResponse response = bigtableTableAdminClient.CheckConsistency(request);

CheckConsistency(TableName, String, CallSettings)

public virtual CheckConsistencyResponse CheckConsistency(TableName name, string consistencyToken, 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
name	`TableName` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
consistencyToken	`String` Required. The token created using GenerateConsistencyToken for the Table.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
CheckConsistencyResponse	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
string consistencyToken = "";
// Make the request
CheckConsistencyResponse response = bigtableTableAdminClient.CheckConsistency(name, consistencyToken);

CheckConsistency(String, String, CallSettings)

public virtual CheckConsistencyResponse CheckConsistency(string name, string consistencyToken, 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
name	`String` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
consistencyToken	`String` Required. The token created using GenerateConsistencyToken for the Table.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
CheckConsistencyResponse	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string consistencyToken = "";
// Make the request
CheckConsistencyResponse response = bigtableTableAdminClient.CheckConsistency(name, consistencyToken);

CheckConsistencyAsync(CheckConsistencyRequest, CallSettings)

public virtual 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	`CheckConsistencyRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<CheckConsistencyResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CheckConsistencyRequest request = new CheckConsistencyRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    ConsistencyToken = "",
};
// Make the request
CheckConsistencyResponse response = await bigtableTableAdminClient.CheckConsistencyAsync(request);

CheckConsistencyAsync(CheckConsistencyRequest, CancellationToken)

public virtual Task<CheckConsistencyResponse> CheckConsistencyAsync(CheckConsistencyRequest request, CancellationToken cancellationToken)

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 object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<CheckConsistencyResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CheckConsistencyRequest request = new CheckConsistencyRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    ConsistencyToken = "",
};
// Make the request
CheckConsistencyResponse response = await bigtableTableAdminClient.CheckConsistencyAsync(request);

CheckConsistencyAsync(TableName, String, CallSettings)

public virtual Task<CheckConsistencyResponse> CheckConsistencyAsync(TableName name, string consistencyToken, 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
name	`TableName` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
consistencyToken	`String` Required. The token created using GenerateConsistencyToken for the Table.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<CheckConsistencyResponse>	A Task containing the RPC response.

Example

BigtableTableAdminClient adminClient = await BigtableTableAdminClient.CreateAsync();

BigtableTableAdminSettings settings = BigtableTableAdminSettings.GetDefault();
CallSettings generateSettings = settings.GenerateConsistencyTokenSettings;
CallSettings checkConsistencySettings = settings.CheckConsistencySettings;

// Create a consistency token for the table.
TableName tableName = new TableName("[PROJECT]", "[INSTANCE]", "[TABLE]");
GenerateConsistencyTokenResponse generateResponse =
    await adminClient.GenerateConsistencyTokenAsync(tableName, generateSettings);
string consistencyToken = generateResponse.ConsistencyToken;

// Check for consistency for 60 seconds at 10 second intervals.
TimeSpan pollingTimeout = TimeSpan.FromSeconds(60);
TimeSpan pollingInterval = TimeSpan.FromSeconds(10);
CheckConsistencyResponse checkConsistencyResponse =
    await Polling.PollRepeatedlyAsync(
        deadline => adminClient.CheckConsistencyAsync(
            tableName,
            consistencyToken,
            checkConsistencySettings.WithEarlierDeadline(deadline, settings.Clock)),
        response => response.Consistent,
        settings.Clock,
        settings.Scheduler,
        new PollSettings(Expiration.FromTimeout(pollingTimeout), pollingInterval),
        checkConsistencySettings.CancellationToken ?? CancellationToken.None);

if (checkConsistencyResponse.Consistent)
{
    // Replication has caught up.
}

CheckConsistencyAsync(TableName, String, CancellationToken)

public virtual Task<CheckConsistencyResponse> CheckConsistencyAsync(TableName name, string consistencyToken, CancellationToken cancellationToken)

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
name	`TableName` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
consistencyToken	`String` Required. The token created using GenerateConsistencyToken for the Table.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<CheckConsistencyResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
string consistencyToken = "";
// Make the request
CheckConsistencyResponse response = await bigtableTableAdminClient.CheckConsistencyAsync(name, consistencyToken);

CheckConsistencyAsync(String, String, CallSettings)

public virtual Task<CheckConsistencyResponse> CheckConsistencyAsync(string name, string consistencyToken, 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
name	`String` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
consistencyToken	`String` Required. The token created using GenerateConsistencyToken for the Table.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<CheckConsistencyResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string consistencyToken = "";
// Make the request
CheckConsistencyResponse response = await bigtableTableAdminClient.CheckConsistencyAsync(name, consistencyToken);

CheckConsistencyAsync(String, String, CancellationToken)

public virtual Task<CheckConsistencyResponse> CheckConsistencyAsync(string name, string consistencyToken, CancellationToken cancellationToken)

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
name	`String` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
consistencyToken	`String` Required. The token created using GenerateConsistencyToken for the Table.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<CheckConsistencyResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string consistencyToken = "";
// Make the request
CheckConsistencyResponse response = await bigtableTableAdminClient.CheckConsistencyAsync(name, consistencyToken);

Create()

public static BigtableTableAdminClient Create()

Synchronously creates a BigtableTableAdminClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableTableAdminClientBuilder .

Returns

Type	Description
BigtableTableAdminClient	The created BigtableTableAdminClient.

CreateAsync(CancellationToken)

public static Task<BigtableTableAdminClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a BigtableTableAdminClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableTableAdminClientBuilder .

Parameter

Name	Description
cancellationToken	`CancellationToken` The CancellationToken to use while creating the client.

Returns

Type	Description
Task<BigtableTableAdminClient>	The task representing the created BigtableTableAdminClient.

CreateBackup(ClusterName, String, Backup, CallSettings)

public virtual Operation<Backup, CreateBackupMetadata> CreateBackup(ClusterName parent, string backupId, Backup backup, 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
parent	`ClusterName` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
backupId	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backup	`Backup` Required. The backup to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Backup, CreateBackupMetadata>	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string backupId = "";
Backup backup = new Backup();
// Make the request
Operation<Backup, CreateBackupMetadata> response = bigtableTableAdminClient.CreateBackup(parent, backupId, backup);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackup(CreateBackupRequest, CallSettings)

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

Parameters

Name	Description
request	`CreateBackupRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Backup, CreateBackupMetadata>	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    BackupId = "",
    Backup = new Backup(),
};
// Make the request
Operation<Backup, CreateBackupMetadata> response = bigtableTableAdminClient.CreateBackup(request);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackup(String, String, Backup, CallSettings)

public virtual Operation<Backup, CreateBackupMetadata> CreateBackup(string parent, string backupId, Backup backup, CallSettings callSettings = null)

Parameters

Name	Description
parent	`String` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
backupId	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backup	`Backup` Required. The backup to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Backup, CreateBackupMetadata>	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string backupId = "";
Backup backup = new Backup();
// Make the request
Operation<Backup, CreateBackupMetadata> response = bigtableTableAdminClient.CreateBackup(parent, backupId, backup);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateBackup(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackupAsync(ClusterName, String, Backup, CallSettings)

public virtual Task<Operation<Backup, CreateBackupMetadata>> CreateBackupAsync(ClusterName parent, string backupId, Backup backup, CallSettings callSettings = null)

Parameters

Name	Description
parent	`ClusterName` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
backupId	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backup	`Backup` Required. The backup to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Operation<Backup, CreateBackupMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string backupId = "";
Backup backup = new Backup();
// Make the request
Operation<Backup, CreateBackupMetadata> response = await bigtableTableAdminClient.CreateBackupAsync(parent, backupId, backup);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackupAsync(ClusterName, String, Backup, CancellationToken)

public virtual Task<Operation<Backup, CreateBackupMetadata>> CreateBackupAsync(ClusterName parent, string backupId, Backup backup, CancellationToken cancellationToken)

Parameters

Name	Description
parent	`ClusterName` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
backupId	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backup	`Backup` Required. The backup to create.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Operation<Backup, CreateBackupMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string backupId = "";
Backup backup = new Backup();
// Make the request
Operation<Backup, CreateBackupMetadata> response = await bigtableTableAdminClient.CreateBackupAsync(parent, backupId, backup);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackupAsync(CreateBackupRequest, CallSettings)

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

Parameters

Name	Description
request	`CreateBackupRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Operation<Backup, CreateBackupMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    BackupId = "",
    Backup = new Backup(),
};
// Make the request
Operation<Backup, CreateBackupMetadata> response = await bigtableTableAdminClient.CreateBackupAsync(request);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackupAsync(CreateBackupRequest, CancellationToken)

public virtual Task<Operation<Backup, CreateBackupMetadata>> CreateBackupAsync(CreateBackupRequest request, CancellationToken cancellationToken)

Parameters

Name	Description
request	`CreateBackupRequest` The request object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Operation<Backup, CreateBackupMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
    BackupId = "",
    Backup = new Backup(),
};
// Make the request
Operation<Backup, CreateBackupMetadata> response = await bigtableTableAdminClient.CreateBackupAsync(request);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackupAsync(String, String, Backup, CallSettings)

public virtual Task<Operation<Backup, CreateBackupMetadata>> CreateBackupAsync(string parent, string backupId, Backup backup, CallSettings callSettings = null)

Parameters

Name	Description
parent	`String` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
backupId	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backup	`Backup` Required. The backup to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Operation<Backup, CreateBackupMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string backupId = "";
Backup backup = new Backup();
// Make the request
Operation<Backup, CreateBackupMetadata> response = await bigtableTableAdminClient.CreateBackupAsync(parent, backupId, backup);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateBackupAsync(String, String, Backup, CancellationToken)

public virtual Task<Operation<Backup, CreateBackupMetadata>> CreateBackupAsync(string parent, string backupId, Backup backup, CancellationToken cancellationToken)

Parameters

Name	Description
parent	`String` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
backupId	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backup	`Backup` Required. The backup to create.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Operation<Backup, CreateBackupMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string backupId = "";
Backup backup = new Backup();
// Make the request
Operation<Backup, CreateBackupMetadata> response = await bigtableTableAdminClient.CreateBackupAsync(parent, backupId, backup);

// Poll until the returned long-running operation is complete
Operation<Backup, CreateBackupMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Backup result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Backup, CreateBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateBackupAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Backup retrievedResult = retrievedResponse.Result;
}

CreateTable(CreateTableRequest, CallSettings)

public virtual 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	`CreateTableRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Table	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
CreateTableRequest request = new CreateTableRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    TableId = "",
    Table = new Table(),
    InitialSplits =
    {
        new CreateTableRequest.Types.Split(),
    },
};
// Make the request
Table response = bigtableTableAdminClient.CreateTable(request);

CreateTable(InstanceName, String, Table, CallSettings)

public virtual Table CreateTable(InstanceName parent, string tableId, Table table, 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
parent	`InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
table	`Table` Required. The Table to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Table	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string tableId = "";
Table table = new Table();
// Make the request
Table response = bigtableTableAdminClient.CreateTable(parent, tableId, table);

CreateTable(String, String, Table, CallSettings)

public virtual Table CreateTable(string parent, string tableId, Table table, 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
parent	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
table	`Table` Required. The Table to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Table	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string tableId = "";
Table table = new Table();
// Make the request
Table response = bigtableTableAdminClient.CreateTable(parent, tableId, table);

CreateTableAsync(CreateTableRequest, CallSettings)

public virtual 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	`CreateTableRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Table>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateTableRequest request = new CreateTableRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    TableId = "",
    Table = new Table(),
    InitialSplits =
    {
        new CreateTableRequest.Types.Split(),
    },
};
// Make the request
Table response = await bigtableTableAdminClient.CreateTableAsync(request);

CreateTableAsync(CreateTableRequest, CancellationToken)

public virtual Task<Table> CreateTableAsync(CreateTableRequest request, CancellationToken cancellationToken)

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 object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Table>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateTableRequest request = new CreateTableRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    TableId = "",
    Table = new Table(),
    InitialSplits =
    {
        new CreateTableRequest.Types.Split(),
    },
};
// Make the request
Table response = await bigtableTableAdminClient.CreateTableAsync(request);

CreateTableAsync(InstanceName, String, Table, CallSettings)

public virtual Task<Table> CreateTableAsync(InstanceName parent, string tableId, Table table, 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
parent	`InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
table	`Table` Required. The Table to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Table>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string tableId = "";
Table table = new Table();
// Make the request
Table response = await bigtableTableAdminClient.CreateTableAsync(parent, tableId, table);

CreateTableAsync(InstanceName, String, Table, CancellationToken)

public virtual Task<Table> CreateTableAsync(InstanceName parent, string tableId, Table table, CancellationToken cancellationToken)

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
parent	`InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
table	`Table` Required. The Table to create.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Table>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string tableId = "";
Table table = new Table();
// Make the request
Table response = await bigtableTableAdminClient.CreateTableAsync(parent, tableId, table);

CreateTableAsync(String, String, Table, CallSettings)

public virtual Task<Table> CreateTableAsync(string parent, string tableId, Table table, 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
parent	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
table	`Table` Required. The Table to create.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Table>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string tableId = "";
Table table = new Table();
// Make the request
Table response = await bigtableTableAdminClient.CreateTableAsync(parent, tableId, table);

CreateTableAsync(String, String, Table, CancellationToken)

public virtual Task<Table> CreateTableAsync(string parent, string tableId, Table table, CancellationToken cancellationToken)

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
parent	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
table	`Table` Required. The Table to create.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Table>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string tableId = "";
Table table = new Table();
// Make the request
Table response = await bigtableTableAdminClient.CreateTableAsync(parent, tableId, table);

CreateTableFromSnapshot(CreateTableFromSnapshotRequest, CallSettings)

public virtual 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	`CreateTableFromSnapshotRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Table, CreateTableFromSnapshotMetadata>	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
CreateTableFromSnapshotRequest request = new CreateTableFromSnapshotRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    TableId = "",
    SourceSnapshotAsSnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = bigtableTableAdminClient.CreateTableFromSnapshot(request);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateTableFromSnapshot(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshot(InstanceName, String, SnapshotName, CallSettings)

public virtual Operation<Table, CreateTableFromSnapshotMetadata> CreateTableFromSnapshot(InstanceName parent, string tableId, SnapshotName sourceSnapshot, 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.

Parameters

Name	Description
parent	`InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
sourceSnapshot	`SnapshotName` Required. The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Table, CreateTableFromSnapshotMetadata>	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string tableId = "";
SnapshotName sourceSnapshot = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = bigtableTableAdminClient.CreateTableFromSnapshot(parent, tableId, sourceSnapshot);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateTableFromSnapshot(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshot(String, String, String, CallSettings)

public virtual Operation<Table, CreateTableFromSnapshotMetadata> CreateTableFromSnapshot(string parent, string tableId, string sourceSnapshot, 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.

Parameters

Name	Description
parent	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
sourceSnapshot	`String` Required. The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Table, CreateTableFromSnapshotMetadata>	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string tableId = "";
string sourceSnapshot = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = bigtableTableAdminClient.CreateTableFromSnapshot(parent, tableId, sourceSnapshot);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateTableFromSnapshot(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest, CallSettings)

public virtual 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.

Parameters

Name	Description
request	`CreateTableFromSnapshotRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Operation<Table, CreateTableFromSnapshotMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateTableFromSnapshotRequest request = new CreateTableFromSnapshotRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    TableId = "",
    SourceSnapshotAsSnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = await bigtableTableAdminClient.CreateTableFromSnapshotAsync(request);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateTableFromSnapshotAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest, CancellationToken)

public virtual Task<Operation<Table, CreateTableFromSnapshotMetadata>> CreateTableFromSnapshotAsync(CreateTableFromSnapshotRequest request, CancellationToken cancellationToken)

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.

Parameters

Name	Description
request	`CreateTableFromSnapshotRequest` The request object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Operation<Table, CreateTableFromSnapshotMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateTableFromSnapshotRequest request = new CreateTableFromSnapshotRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    TableId = "",
    SourceSnapshotAsSnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = await bigtableTableAdminClient.CreateTableFromSnapshotAsync(request);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateTableFromSnapshotAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshotAsync(InstanceName, String, SnapshotName, CallSettings)

public virtual Task<Operation<Table, CreateTableFromSnapshotMetadata>> CreateTableFromSnapshotAsync(InstanceName parent, string tableId, SnapshotName sourceSnapshot, 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.

Parameters

Name	Description
parent	`InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
sourceSnapshot	`SnapshotName` Required. The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Operation<Table, CreateTableFromSnapshotMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string tableId = "";
SnapshotName sourceSnapshot = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = await bigtableTableAdminClient.CreateTableFromSnapshotAsync(parent, tableId, sourceSnapshot);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateTableFromSnapshotAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshotAsync(InstanceName, String, SnapshotName, CancellationToken)

public virtual Task<Operation<Table, CreateTableFromSnapshotMetadata>> CreateTableFromSnapshotAsync(InstanceName parent, string tableId, SnapshotName sourceSnapshot, CancellationToken cancellationToken)

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.

Parameters

Name	Description
parent	`InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
sourceSnapshot	`SnapshotName` Required. The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Operation<Table, CreateTableFromSnapshotMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string tableId = "";
SnapshotName sourceSnapshot = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = await bigtableTableAdminClient.CreateTableFromSnapshotAsync(parent, tableId, sourceSnapshot);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateTableFromSnapshotAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshotAsync(String, String, String, CallSettings)

public virtual Task<Operation<Table, CreateTableFromSnapshotMetadata>> CreateTableFromSnapshotAsync(string parent, string tableId, string sourceSnapshot, 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.

Parameters

Name	Description
parent	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
sourceSnapshot	`String` Required. The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Operation<Table, CreateTableFromSnapshotMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string tableId = "";
string sourceSnapshot = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = await bigtableTableAdminClient.CreateTableFromSnapshotAsync(parent, tableId, sourceSnapshot);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateTableFromSnapshotAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

CreateTableFromSnapshotAsync(String, String, String, CancellationToken)

public virtual Task<Operation<Table, CreateTableFromSnapshotMetadata>> CreateTableFromSnapshotAsync(string parent, string tableId, string sourceSnapshot, CancellationToken cancellationToken)

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.

Parameters

Name	Description
parent	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
tableId	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
sourceSnapshot	`String` Required. The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Operation<Table, CreateTableFromSnapshotMetadata>>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string tableId = "";
string sourceSnapshot = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
Operation<Table, CreateTableFromSnapshotMetadata> response = await bigtableTableAdminClient.CreateTableFromSnapshotAsync(parent, tableId, sourceSnapshot);

// Poll until the returned long-running operation is complete
Operation<Table, CreateTableFromSnapshotMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Table result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Table, CreateTableFromSnapshotMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateTableFromSnapshotAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Table retrievedResult = retrievedResponse.Result;
}

DeleteBackup(BackupName, CallSettings)

public virtual void DeleteBackup(BackupName name, CallSettings callSettings = null)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
name	`BackupName` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
// Make the request
bigtableTableAdminClient.DeleteBackup(name);

DeleteBackup(DeleteBackupRequest, CallSettings)

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

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
request	`DeleteBackupRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
bigtableTableAdminClient.DeleteBackup(request);

DeleteBackup(String, CallSettings)

public virtual void DeleteBackup(string name, CallSettings callSettings = null)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
name	`String` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
// Make the request
bigtableTableAdminClient.DeleteBackup(name);

DeleteBackupAsync(BackupName, CallSettings)

public virtual Task DeleteBackupAsync(BackupName name, CallSettings callSettings = null)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
name	`BackupName` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
// Make the request
await bigtableTableAdminClient.DeleteBackupAsync(name);

DeleteBackupAsync(BackupName, CancellationToken)

public virtual Task DeleteBackupAsync(BackupName name, CancellationToken cancellationToken)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
name	`BackupName` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
// Make the request
await bigtableTableAdminClient.DeleteBackupAsync(name);

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

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

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
request	`DeleteBackupRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
await bigtableTableAdminClient.DeleteBackupAsync(request);

DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

public virtual Task DeleteBackupAsync(DeleteBackupRequest request, CancellationToken cancellationToken)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
request	`DeleteBackupRequest` The request object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
await bigtableTableAdminClient.DeleteBackupAsync(request);

DeleteBackupAsync(String, CallSettings)

public virtual Task DeleteBackupAsync(string name, CallSettings callSettings = null)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
name	`String` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
// Make the request
await bigtableTableAdminClient.DeleteBackupAsync(name);

DeleteBackupAsync(String, CancellationToken)

public virtual Task DeleteBackupAsync(string name, CancellationToken cancellationToken)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
name	`String` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
// Make the request
await bigtableTableAdminClient.DeleteBackupAsync(name);

DeleteSnapshot(DeleteSnapshotRequest, CallSettings)

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

Permanently deletes the specified snapshot.

Parameters

Name	Description
request	`DeleteSnapshotRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
DeleteSnapshotRequest request = new DeleteSnapshotRequest
{
    SnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
bigtableTableAdminClient.DeleteSnapshot(request);

DeleteSnapshot(SnapshotName, CallSettings)

public virtual void DeleteSnapshot(SnapshotName name, CallSettings callSettings = null)

Permanently deletes the specified snapshot.

Parameters

Name	Description
name	`SnapshotName` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
SnapshotName name = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
bigtableTableAdminClient.DeleteSnapshot(name);

DeleteSnapshot(String, CallSettings)

public virtual void DeleteSnapshot(string name, CallSettings callSettings = null)

Permanently deletes the specified snapshot.

Parameters

Name	Description
name	`String` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
bigtableTableAdminClient.DeleteSnapshot(name);

DeleteSnapshotAsync(DeleteSnapshotRequest, CallSettings)

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

Permanently deletes the specified snapshot.

Parameters

Name	Description
request	`DeleteSnapshotRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteSnapshotRequest request = new DeleteSnapshotRequest
{
    SnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
await bigtableTableAdminClient.DeleteSnapshotAsync(request);

DeleteSnapshotAsync(DeleteSnapshotRequest, CancellationToken)

public virtual Task DeleteSnapshotAsync(DeleteSnapshotRequest request, CancellationToken cancellationToken)

Permanently deletes the specified snapshot.

Parameters

Name	Description
request	`DeleteSnapshotRequest` The request object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteSnapshotRequest request = new DeleteSnapshotRequest
{
    SnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
await bigtableTableAdminClient.DeleteSnapshotAsync(request);

DeleteSnapshotAsync(SnapshotName, CallSettings)

public virtual Task DeleteSnapshotAsync(SnapshotName name, CallSettings callSettings = null)

Permanently deletes the specified snapshot.

Parameters

Name	Description
name	`SnapshotName` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SnapshotName name = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
await bigtableTableAdminClient.DeleteSnapshotAsync(name);

DeleteSnapshotAsync(SnapshotName, CancellationToken)

public virtual Task DeleteSnapshotAsync(SnapshotName name, CancellationToken cancellationToken)

Permanently deletes the specified snapshot.

Parameters

Name	Description
name	`SnapshotName` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SnapshotName name = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
await bigtableTableAdminClient.DeleteSnapshotAsync(name);

DeleteSnapshotAsync(String, CallSettings)

public virtual Task DeleteSnapshotAsync(string name, CallSettings callSettings = null)

Permanently deletes the specified snapshot.

Parameters

Name	Description
name	`String` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
await bigtableTableAdminClient.DeleteSnapshotAsync(name);

DeleteSnapshotAsync(String, CancellationToken)

public virtual Task DeleteSnapshotAsync(string name, CancellationToken cancellationToken)

Permanently deletes the specified snapshot.

Parameters

Name	Description
name	`String` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
await bigtableTableAdminClient.DeleteSnapshotAsync(name);

DeleteTable(DeleteTableRequest, CallSettings)

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

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
request	`DeleteTableRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
DeleteTableRequest request = new DeleteTableRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
bigtableTableAdminClient.DeleteTable(request);

DeleteTable(TableName, CallSettings)

public virtual void DeleteTable(TableName name, CallSettings callSettings = null)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
name	`TableName` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
bigtableTableAdminClient.DeleteTable(name);

DeleteTable(String, CallSettings)

public virtual void DeleteTable(string name, CallSettings callSettings = null)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
name	`String` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
bigtableTableAdminClient.DeleteTable(name);

DeleteTableAsync(DeleteTableRequest, CallSettings)

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

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
request	`DeleteTableRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteTableRequest request = new DeleteTableRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
await bigtableTableAdminClient.DeleteTableAsync(request);

DeleteTableAsync(DeleteTableRequest, CancellationToken)

public virtual Task DeleteTableAsync(DeleteTableRequest request, CancellationToken cancellationToken)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
request	`DeleteTableRequest` The request object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteTableRequest request = new DeleteTableRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
await bigtableTableAdminClient.DeleteTableAsync(request);

DeleteTableAsync(TableName, CallSettings)

public virtual Task DeleteTableAsync(TableName name, CallSettings callSettings = null)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
name	`TableName` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
await bigtableTableAdminClient.DeleteTableAsync(name);

DeleteTableAsync(TableName, CancellationToken)

public virtual Task DeleteTableAsync(TableName name, CancellationToken cancellationToken)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
name	`TableName` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
await bigtableTableAdminClient.DeleteTableAsync(name);

DeleteTableAsync(String, CallSettings)

public virtual Task DeleteTableAsync(string name, CallSettings callSettings = null)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
name	`String` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
await bigtableTableAdminClient.DeleteTableAsync(name);

DeleteTableAsync(String, CancellationToken)

public virtual Task DeleteTableAsync(string name, CancellationToken cancellationToken)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
name	`String` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
await bigtableTableAdminClient.DeleteTableAsync(name);

DropAllRows(TableName, CallSettings)

public void DropAllRows(TableName tableName, CallSettings callSettings = null)

Permanently drop/delete all rows in the table.

Parameters

Name	Description
tableName	`TableName` The unique name of the table on which to drop the rows. Must not be null.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Remarks

This method simply delegates to DropRowRange(DropRowRangeRequest, CallSettings).

DropAllRowsAsync(TableName, CallSettings)

public Task DropAllRowsAsync(TableName tableName, CallSettings callSettings = null)

Permanently drop/delete all rows in the table.

Parameters

Name	Description
tableName	`TableName` The unique name of the table on which to drop the rows. Must not be null.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task that completes when the RPC has completed.

Remarks

This method simply delegates to DropRowRangeAsync(DropRowRangeRequest, CallSettings).

DropAllRowsAsync(TableName, CancellationToken)

public Task DropAllRowsAsync(TableName tableName, CancellationToken cancellationToken)

Permanently drop/delete all rows in the table.

Parameters

Name	Description
tableName	`TableName` The unique name of the table on which to drop the rows. Must not be null.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task that completes when the RPC has completed.

Remarks

This method simply delegates to DropAllRowsAsync(TableName, CallSettings).

DropRowRange(DropRowRangeRequest, CallSettings)

public virtual 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	`DropRowRangeRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
DropRowRangeRequest request = new DropRowRangeRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKeyPrefix = ByteString.Empty,
};
// Make the request
bigtableTableAdminClient.DropRowRange(request);

DropRowRange(TableName, BigtableByteString, CallSettings)

public void DropRowRange(TableName tableName, BigtableByteString rowKeyPrefix, CallSettings callSettings = null)

Permanently drop/delete all rows that start with this row key prefix.

Parameters

Name	Description
tableName	`TableName` The unique name of the table on which to drop a range of rows. Must not be null.
rowKeyPrefix	`BigtableByteString` The prefix of all rows which should be dropped. Cannot be null or empty.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Remarks

This method simply delegates to DropRowRange(DropRowRangeRequest, CallSettings).

Note that string is implicitly convertible to BigtableByteString, so rowKeyPrefix can be specified using a string as well and its UTF-8 representations will be used.

DropRowRangeAsync(DropRowRangeRequest, CallSettings)

public virtual 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	`DropRowRangeRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DropRowRangeRequest request = new DropRowRangeRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKeyPrefix = ByteString.Empty,
};
// Make the request
await bigtableTableAdminClient.DropRowRangeAsync(request);

DropRowRangeAsync(DropRowRangeRequest, CancellationToken)

public virtual Task DropRowRangeAsync(DropRowRangeRequest request, CancellationToken cancellationToken)

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 object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DropRowRangeRequest request = new DropRowRangeRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKeyPrefix = ByteString.Empty,
};
// Make the request
await bigtableTableAdminClient.DropRowRangeAsync(request);

DropRowRangeAsync(TableName, BigtableByteString, CallSettings)

public Task DropRowRangeAsync(TableName tableName, BigtableByteString rowKeyPrefix, CallSettings callSettings = null)

Permanently drop/delete all rows that start with this row key prefix.

Parameters

Name	Description
tableName	`TableName` The unique name of the table on which to drop a range of rows. Must not be null.
rowKeyPrefix	`BigtableByteString` The prefix of all rows which should be dropped. Cannot be null or empty.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task that completes when the RPC has completed.

Remarks

This method simply delegates to DropRowRangeAsync(DropRowRangeRequest, CallSettings).

Note that string is implicitly convertible to BigtableByteString, so rowKeyPrefix can be specified using a string as well and its UTF-8 representations will be used.

DropRowRangeAsync(TableName, BigtableByteString, CancellationToken)

public Task DropRowRangeAsync(TableName tableName, BigtableByteString rowKeyPrefix, CancellationToken cancellationToken)

Permanently drop/delete all rows that start with this row key prefix.

Parameters

Name	Description
tableName	`TableName` The unique name of the table on which to drop a range of rows. Must not be null.
rowKeyPrefix	`BigtableByteString` The prefix of all rows which should be dropped. Cannot be null or empty.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task that completes when the RPC has completed.

Remarks

This method simply delegates to DropRowRangeAsync(TableName, BigtableByteString, CallSettings).

Note that string is implicitly convertible to BigtableByteString, so rowKeyPrefix can be specified using a string as well and its UTF-8 representations will be used.

GenerateConsistencyToken(GenerateConsistencyTokenRequest, CallSettings)

public virtual 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	`GenerateConsistencyTokenRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
GenerateConsistencyTokenResponse	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
GenerateConsistencyTokenRequest request = new GenerateConsistencyTokenRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
GenerateConsistencyTokenResponse response = bigtableTableAdminClient.GenerateConsistencyToken(request);

GenerateConsistencyToken(TableName, CallSettings)

public virtual GenerateConsistencyTokenResponse GenerateConsistencyToken(TableName name, CallSettings callSettings = null)

Parameters

Name	Description
name	`TableName` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
GenerateConsistencyTokenResponse	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
GenerateConsistencyTokenResponse response = bigtableTableAdminClient.GenerateConsistencyToken(name);

GenerateConsistencyToken(String, CallSettings)

public virtual GenerateConsistencyTokenResponse GenerateConsistencyToken(string name, CallSettings callSettings = null)

Parameters

Name	Description
name	`String` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
GenerateConsistencyTokenResponse	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
GenerateConsistencyTokenResponse response = bigtableTableAdminClient.GenerateConsistencyToken(name);

GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest, CallSettings)

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

Parameters

Name	Description
request	`GenerateConsistencyTokenRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<GenerateConsistencyTokenResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GenerateConsistencyTokenRequest request = new GenerateConsistencyTokenRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
GenerateConsistencyTokenResponse response = await bigtableTableAdminClient.GenerateConsistencyTokenAsync(request);

GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest, CancellationToken)

public virtual Task<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(GenerateConsistencyTokenRequest request, CancellationToken cancellationToken)

Parameters

Name	Description
request	`GenerateConsistencyTokenRequest` The request object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<GenerateConsistencyTokenResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GenerateConsistencyTokenRequest request = new GenerateConsistencyTokenRequest
{
    TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
GenerateConsistencyTokenResponse response = await bigtableTableAdminClient.GenerateConsistencyTokenAsync(request);

GenerateConsistencyTokenAsync(TableName, CallSettings)

public virtual Task<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(TableName name, CallSettings callSettings = null)

Parameters

Name	Description
name	`TableName` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<GenerateConsistencyTokenResponse>	A Task containing the RPC response.

Example

BigtableTableAdminClient adminClient = await BigtableTableAdminClient.CreateAsync();

BigtableTableAdminSettings settings = BigtableTableAdminSettings.GetDefault();
CallSettings generateSettings = settings.GenerateConsistencyTokenSettings;
CallSettings checkConsistencySettings = settings.CheckConsistencySettings;

// Create a consistency token for the table.
TableName tableName = new TableName("[PROJECT]", "[INSTANCE]", "[TABLE]");
GenerateConsistencyTokenResponse generateResponse =
    await adminClient.GenerateConsistencyTokenAsync(tableName, generateSettings);
string consistencyToken = generateResponse.ConsistencyToken;

// Check for consistency for 60 seconds at 10 second intervals.
TimeSpan pollingTimeout = TimeSpan.FromSeconds(60);
TimeSpan pollingInterval = TimeSpan.FromSeconds(10);
CheckConsistencyResponse checkConsistencyResponse =
    await Polling.PollRepeatedlyAsync(
        deadline => adminClient.CheckConsistencyAsync(
            tableName,
            consistencyToken,
            checkConsistencySettings.WithEarlierDeadline(deadline, settings.Clock)),
        response => response.Consistent,
        settings.Clock,
        settings.Scheduler,
        new PollSettings(Expiration.FromTimeout(pollingTimeout), pollingInterval),
        checkConsistencySettings.CancellationToken ?? CancellationToken.None);

if (checkConsistencyResponse.Consistent)
{
    // Replication has caught up.
}

GenerateConsistencyTokenAsync(TableName, CancellationToken)

public virtual Task<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(TableName name, CancellationToken cancellationToken)

Parameters

Name	Description
name	`TableName` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<GenerateConsistencyTokenResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
GenerateConsistencyTokenResponse response = await bigtableTableAdminClient.GenerateConsistencyTokenAsync(name);

GenerateConsistencyTokenAsync(String, CallSettings)

public virtual Task<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(string name, CallSettings callSettings = null)

Parameters

Name	Description
name	`String` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<GenerateConsistencyTokenResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
GenerateConsistencyTokenResponse response = await bigtableTableAdminClient.GenerateConsistencyTokenAsync(name);

GenerateConsistencyTokenAsync(String, CancellationToken)

public virtual Task<GenerateConsistencyTokenResponse> GenerateConsistencyTokenAsync(string name, CancellationToken cancellationToken)

Parameters

Name	Description
name	`String` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<GenerateConsistencyTokenResponse>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
GenerateConsistencyTokenResponse response = await bigtableTableAdminClient.GenerateConsistencyTokenAsync(name);

GetBackup(BackupName, CallSettings)

public virtual Backup GetBackup(BackupName name, CallSettings callSettings = null)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
name	`BackupName` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Backup	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
// Make the request
Backup response = bigtableTableAdminClient.GetBackup(name);

GetBackup(GetBackupRequest, CallSettings)

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

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
request	`GetBackupRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Backup	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
Backup response = bigtableTableAdminClient.GetBackup(request);

GetBackup(String, CallSettings)

public virtual Backup GetBackup(string name, CallSettings callSettings = null)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
name	`String` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Backup	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
// Make the request
Backup response = bigtableTableAdminClient.GetBackup(name);

GetBackupAsync(BackupName, CallSettings)

public virtual Task<Backup> GetBackupAsync(BackupName name, CallSettings callSettings = null)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
name	`BackupName` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Backup>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
// Make the request
Backup response = await bigtableTableAdminClient.GetBackupAsync(name);

GetBackupAsync(BackupName, CancellationToken)

public virtual Task<Backup> GetBackupAsync(BackupName name, CancellationToken cancellationToken)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
name	`BackupName` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Backup>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
// Make the request
Backup response = await bigtableTableAdminClient.GetBackupAsync(name);

GetBackupAsync(GetBackupRequest, CallSettings)

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

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
request	`GetBackupRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Backup>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
Backup response = await bigtableTableAdminClient.GetBackupAsync(request);

GetBackupAsync(GetBackupRequest, CancellationToken)

public virtual Task<Backup> GetBackupAsync(GetBackupRequest request, CancellationToken cancellationToken)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
request	`GetBackupRequest` The request object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Backup>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
Backup response = await bigtableTableAdminClient.GetBackupAsync(request);

GetBackupAsync(String, CallSettings)

public virtual Task<Backup> GetBackupAsync(string name, CallSettings callSettings = null)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
name	`String` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Backup>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
// Make the request
Backup response = await bigtableTableAdminClient.GetBackupAsync(name);

GetBackupAsync(String, CancellationToken)

public virtual Task<Backup> GetBackupAsync(string name, CancellationToken cancellationToken)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
name	`String` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Backup>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
// Make the request
Backup response = await bigtableTableAdminClient.GetBackupAsync(name);

GetIamPolicy(IResourceName, CallSettings)

public virtual Policy GetIamPolicy(IResourceName resource, 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
resource	`IResourceName` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Policy	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = bigtableTableAdminClient.GetIamPolicy(resource);

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public virtual 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	`GetIamPolicyRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Policy	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = bigtableTableAdminClient.GetIamPolicy(request);

GetIamPolicy(String, CallSettings)

public virtual Policy GetIamPolicy(string resource, 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
resource	`String` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Policy	The RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = bigtableTableAdminClient.GetIamPolicy(resource);

GetIamPolicyAsync(IResourceName, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, 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
resource	`IResourceName` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Policy>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await bigtableTableAdminClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(IResourceName, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CancellationToken cancellationToken)

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
resource	`IResourceName` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Policy>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await bigtableTableAdminClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public virtual 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

Name	Description
request	`GetIamPolicyRequest` The request object containing all of the parameters for the API call.
callSettings	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Policy>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await bigtableTableAdminClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken cancellationToken)

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 object containing all of the parameters for the API call.
cancellationToken	`CancellationToken` A CancellationToken to use for this RPC.

Returns

Type	Description
Task<Policy>	A Task containing the RPC response.

Example

// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await bigtableTableAdminClient.GetIamPolicyAsync(request);