public abstract class BigtableTableAdminClientReference documentation and code samples for the Google Cloud Bigtable Administration v2 API class BigtableTableAdminClient.
BigtableTableAdmin client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Bigtable.Admin.V2Assembly
Google.Cloud.Bigtable.Admin.V2.dll
Remarks
Service for creating, configuring, and deleting Cloud Bigtable tables.
Provides access to the table schemas only, not the data stored within the tables.
Properties
CopyBackupOperationsClient
public virtual OperationsClient CopyBackupOperationsClient { get; }The long-running operations client for CopyBackup.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateAuthorizedViewOperationsClient
public virtual OperationsClient CreateAuthorizedViewOperationsClient { get; }The long-running operations client for CreateAuthorizedView.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 |
IReadOnlyListstring | |
The default BigtableTableAdmin scopes are:
- https://www.googleapis.com/auth/bigtable.admin
- https://www.googleapis.com/auth/bigtable.admin.table
- https://www.googleapis.com/auth/cloud-bigtable.admin
- https://www.googleapis.com/auth/cloud-bigtable.admin.table
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/cloud-platform.read-only
GrpcClient
public virtual BigtableTableAdmin.BigtableTableAdminClient GrpcClient { get; }The underlying gRPC BigtableTableAdmin client
| Property Value | |
|---|---|
| Type | Description |
BigtableTableAdminBigtableTableAdminClient | |
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 | |
UpdateAuthorizedViewOperationsClient
public virtual OperationsClient UpdateAuthorizedViewOperationsClient { get; }The long-running operations client for UpdateAuthorizedView.
| 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 | CheckConsistencyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CheckConsistencyResponse | The RPC response. |
// 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 | TableNameRequired. The unique name of the Table for which to check replication
consistency. Values are of the form
|
consistencyToken | stringRequired. The token created using GenerateConsistencyToken for the Table. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CheckConsistencyResponse | The RPC response. |
// 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 | stringRequired. The unique name of the Table for which to check replication
consistency. Values are of the form
|
consistencyToken | stringRequired. The token created using GenerateConsistencyToken for the Table. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CheckConsistencyResponse | The RPC response. |
// 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 | CheckConsistencyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCheckConsistencyResponse | A Task containing the RPC response. |
// 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 | CheckConsistencyRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskCheckConsistencyResponse | A Task containing the RPC response. |
// 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 | TableNameRequired. The unique name of the Table for which to check replication
consistency. Values are of the form
|
consistencyToken | stringRequired. The token created using GenerateConsistencyToken for the Table. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCheckConsistencyResponse | A Task containing the RPC response. |
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 | TableNameRequired. The unique name of the Table for which to check replication
consistency. Values are of the form
|
consistencyToken | stringRequired. The token created using GenerateConsistencyToken for the Table. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskCheckConsistencyResponse | A Task containing the RPC response. |
// 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 | stringRequired. The unique name of the Table for which to check replication
consistency. Values are of the form
|
consistencyToken | stringRequired. The token created using GenerateConsistencyToken for the Table. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCheckConsistencyResponse | A Task containing the RPC response. |
// 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 | stringRequired. The unique name of the Table for which to check replication
consistency. Values are of the form
|
consistencyToken | stringRequired. The token created using GenerateConsistencyToken for the Table. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskCheckConsistencyResponse | A Task containing the RPC response. |
// 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);
CopyBackup(ClusterName, string, BackupName, Timestamp, CallSettings)
public virtual Operation<Backup, CopyBackupMetadata> CopyBackup(ClusterName parent, string backupId, BackupName sourceBackup, Timestamp expireTime, CallSettings callSettings = null)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
parent | ClusterNameRequired. The name of the destination cluster that will contain the backup
copy. The cluster must already exists. Values are of the form:
|
backupId | stringRequired. The id of the new backup. The |
sourceBackup | BackupNameRequired. The source backup to be copied from.
The source backup needs to be in READY state for it to be copied.
Copying a copied backup is not allowed.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
|
expireTime | TimestampRequired. Required. The expiration time of the copied backup with
microsecond granularity that must be at least 6 hours and at most 30 days
from the time the request is received. Once the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCopyBackupMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string backupId = "";
BackupName sourceBackup = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = bigtableTableAdminClient.CopyBackup(parent, backupId, sourceBackup, expireTime);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCopyBackup(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;
}
CopyBackup(CopyBackupRequest, CallSettings)
public virtual Operation<Backup, CopyBackupMetadata> CopyBackup(CopyBackupRequest request, CallSettings callSettings = null)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
request | CopyBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCopyBackupMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
CopyBackupRequest request = new CopyBackupRequest
{
ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
BackupId = "",
SourceBackupAsBackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
ExpireTime = new Timestamp(),
};
// Make the request
Operation<Backup, CopyBackupMetadata> response = bigtableTableAdminClient.CopyBackup(request);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCopyBackup(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;
}
CopyBackup(string, string, string, Timestamp, CallSettings)
public virtual Operation<Backup, CopyBackupMetadata> CopyBackup(string parent, string backupId, string sourceBackup, Timestamp expireTime, CallSettings callSettings = null)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The name of the destination cluster that will contain the backup
copy. The cluster must already exists. Values are of the form:
|
backupId | stringRequired. The id of the new backup. The |
sourceBackup | stringRequired. The source backup to be copied from.
The source backup needs to be in READY state for it to be copied.
Copying a copied backup is not allowed.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
|
expireTime | TimestampRequired. Required. The expiration time of the copied backup with
microsecond granularity that must be at least 6 hours and at most 30 days
from the time the request is received. Once the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCopyBackupMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string backupId = "";
string sourceBackup = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = bigtableTableAdminClient.CopyBackup(parent, backupId, sourceBackup, expireTime);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCopyBackup(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;
}
CopyBackupAsync(ClusterName, string, BackupName, Timestamp, CallSettings)
public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(ClusterName parent, string backupId, BackupName sourceBackup, Timestamp expireTime, CallSettings callSettings = null)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
parent | ClusterNameRequired. The name of the destination cluster that will contain the backup
copy. The cluster must already exists. Values are of the form:
|
backupId | stringRequired. The id of the new backup. The |
sourceBackup | BackupNameRequired. The source backup to be copied from.
The source backup needs to be in READY state for it to be copied.
Copying a copied backup is not allowed.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
|
expireTime | TimestampRequired. Required. The expiration time of the copied backup with
microsecond granularity that must be at least 6 hours and at most 30 days
from the time the request is received. Once the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string backupId = "";
BackupName sourceBackup = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await bigtableTableAdminClient.CopyBackupAsync(parent, backupId, sourceBackup, expireTime);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCopyBackupAsync(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;
}
CopyBackupAsync(ClusterName, string, BackupName, Timestamp, CancellationToken)
public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(ClusterName parent, string backupId, BackupName sourceBackup, Timestamp expireTime, CancellationToken cancellationToken)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
parent | ClusterNameRequired. The name of the destination cluster that will contain the backup
copy. The cluster must already exists. Values are of the form:
|
backupId | stringRequired. The id of the new backup. The |
sourceBackup | BackupNameRequired. The source backup to be copied from.
The source backup needs to be in READY state for it to be copied.
Copying a copied backup is not allowed.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
|
expireTime | TimestampRequired. Required. The expiration time of the copied backup with
microsecond granularity that must be at least 6 hours and at most 30 days
from the time the request is received. Once the |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string backupId = "";
BackupName sourceBackup = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await bigtableTableAdminClient.CopyBackupAsync(parent, backupId, sourceBackup, expireTime);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCopyBackupAsync(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;
}
CopyBackupAsync(CopyBackupRequest, CallSettings)
public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(CopyBackupRequest request, CallSettings callSettings = null)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
request | CopyBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CopyBackupRequest request = new CopyBackupRequest
{
ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
BackupId = "",
SourceBackupAsBackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
ExpireTime = new Timestamp(),
};
// Make the request
Operation<Backup, CopyBackupMetadata> response = await bigtableTableAdminClient.CopyBackupAsync(request);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCopyBackupAsync(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;
}
CopyBackupAsync(CopyBackupRequest, CancellationToken)
public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(CopyBackupRequest request, CancellationToken cancellationToken)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
request | CopyBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CopyBackupRequest request = new CopyBackupRequest
{
ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
BackupId = "",
SourceBackupAsBackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
ExpireTime = new Timestamp(),
};
// Make the request
Operation<Backup, CopyBackupMetadata> response = await bigtableTableAdminClient.CopyBackupAsync(request);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCopyBackupAsync(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;
}
CopyBackupAsync(string, string, string, Timestamp, CallSettings)
public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(string parent, string backupId, string sourceBackup, Timestamp expireTime, CallSettings callSettings = null)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The name of the destination cluster that will contain the backup
copy. The cluster must already exists. Values are of the form:
|
backupId | stringRequired. The id of the new backup. The |
sourceBackup | stringRequired. The source backup to be copied from.
The source backup needs to be in READY state for it to be copied.
Copying a copied backup is not allowed.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
|
expireTime | TimestampRequired. Required. The expiration time of the copied backup with
microsecond granularity that must be at least 6 hours and at most 30 days
from the time the request is received. Once the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string backupId = "";
string sourceBackup = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await bigtableTableAdminClient.CopyBackupAsync(parent, backupId, sourceBackup, expireTime);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCopyBackupAsync(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;
}
CopyBackupAsync(string, string, string, Timestamp, CancellationToken)
public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(string parent, string backupId, string sourceBackup, Timestamp expireTime, CancellationToken cancellationToken)Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The name of the destination cluster that will contain the backup
copy. The cluster must already exists. Values are of the form:
|
backupId | stringRequired. The id of the new backup. The |
sourceBackup | stringRequired. The source backup to be copied from.
The source backup needs to be in READY state for it to be copied.
Copying a copied backup is not allowed.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
|
expireTime | TimestampRequired. Required. The expiration time of the copied backup with
microsecond granularity that must be at least 6 hours and at most 30 days
from the time the request is received. Once the |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string backupId = "";
string sourceBackup = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/backups/[BACKUP]";
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await bigtableTableAdminClient.CopyBackupAsync(parent, backupId, sourceBackup, expireTime);
// Poll until the returned long-running operation is complete
Operation<Backup, CopyBackupMetadata> 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, CopyBackupMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCopyBackupAsync(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;
}
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)Asynchronously creates a BigtableTableAdminClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableTableAdminClientBuilder .
| Parameter | |
|---|---|
| Name | Description |
cancellationToken | CancellationTokenThe CancellationToken to use while creating the client. |
| Returns | |
|---|---|
| Type | Description |
TaskBigtableTableAdminClient | The task representing the created BigtableTableAdminClient. |
CreateAuthorizedView(CreateAuthorizedViewRequest, CallSettings)
public virtual Operation<AuthorizedView, CreateAuthorizedViewMetadata> CreateAuthorizedView(CreateAuthorizedViewRequest request, CallSettings callSettings = null)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
request | CreateAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAuthorizedViewCreateAuthorizedViewMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
CreateAuthorizedViewRequest request = new CreateAuthorizedViewRequest
{
ParentAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
AuthorizedViewId = "",
AuthorizedView = new AuthorizedView(),
};
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = bigtableTableAdminClient.CreateAuthorizedView(request);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateAuthorizedView(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedView(TableName, AuthorizedView, string, CallSettings)
public virtual Operation<AuthorizedView, CreateAuthorizedViewMetadata> CreateAuthorizedView(TableName parent, AuthorizedView authorizedView, string authorizedViewId, CallSettings callSettings = null)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
parent | TableNameRequired. This is the name of the table the AuthorizedView belongs to.
Values are of the form
|
authorizedView | AuthorizedViewRequired. The AuthorizedView to create. |
authorizedViewId | stringRequired. The id of the AuthorizedView to create. This AuthorizedView must
not already exist. The |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAuthorizedViewCreateAuthorizedViewMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName parent = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
AuthorizedView authorizedView = new AuthorizedView();
string authorizedViewId = "";
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = bigtableTableAdminClient.CreateAuthorizedView(parent, authorizedView, authorizedViewId);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateAuthorizedView(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedView(string, AuthorizedView, string, CallSettings)
public virtual Operation<AuthorizedView, CreateAuthorizedViewMetadata> CreateAuthorizedView(string parent, AuthorizedView authorizedView, string authorizedViewId, CallSettings callSettings = null)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. This is the name of the table the AuthorizedView belongs to.
Values are of the form
|
authorizedView | AuthorizedViewRequired. The AuthorizedView to create. |
authorizedViewId | stringRequired. The id of the AuthorizedView to create. This AuthorizedView must
not already exist. The |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAuthorizedViewCreateAuthorizedViewMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
AuthorizedView authorizedView = new AuthorizedView();
string authorizedViewId = "";
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = bigtableTableAdminClient.CreateAuthorizedView(parent, authorizedView, authorizedViewId);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceCreateAuthorizedView(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedViewAsync(CreateAuthorizedViewRequest, CallSettings)
public virtual Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> CreateAuthorizedViewAsync(CreateAuthorizedViewRequest request, CallSettings callSettings = null)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
request | CreateAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateAuthorizedViewRequest request = new CreateAuthorizedViewRequest
{
ParentAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
AuthorizedViewId = "",
AuthorizedView = new AuthorizedView(),
};
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = await bigtableTableAdminClient.CreateAuthorizedViewAsync(request);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedViewAsync(CreateAuthorizedViewRequest, CancellationToken)
public virtual Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> CreateAuthorizedViewAsync(CreateAuthorizedViewRequest request, CancellationToken cancellationToken)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
request | CreateAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
CreateAuthorizedViewRequest request = new CreateAuthorizedViewRequest
{
ParentAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
AuthorizedViewId = "",
AuthorizedView = new AuthorizedView(),
};
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = await bigtableTableAdminClient.CreateAuthorizedViewAsync(request);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedViewAsync(TableName, AuthorizedView, string, CallSettings)
public virtual Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> CreateAuthorizedViewAsync(TableName parent, AuthorizedView authorizedView, string authorizedViewId, CallSettings callSettings = null)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
parent | TableNameRequired. This is the name of the table the AuthorizedView belongs to.
Values are of the form
|
authorizedView | AuthorizedViewRequired. The AuthorizedView to create. |
authorizedViewId | stringRequired. The id of the AuthorizedView to create. This AuthorizedView must
not already exist. The |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName parent = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
AuthorizedView authorizedView = new AuthorizedView();
string authorizedViewId = "";
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = await bigtableTableAdminClient.CreateAuthorizedViewAsync(parent, authorizedView, authorizedViewId);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedViewAsync(TableName, AuthorizedView, string, CancellationToken)
public virtual Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> CreateAuthorizedViewAsync(TableName parent, AuthorizedView authorizedView, string authorizedViewId, CancellationToken cancellationToken)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
parent | TableNameRequired. This is the name of the table the AuthorizedView belongs to.
Values are of the form
|
authorizedView | AuthorizedViewRequired. The AuthorizedView to create. |
authorizedViewId | stringRequired. The id of the AuthorizedView to create. This AuthorizedView must
not already exist. The |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName parent = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
AuthorizedView authorizedView = new AuthorizedView();
string authorizedViewId = "";
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = await bigtableTableAdminClient.CreateAuthorizedViewAsync(parent, authorizedView, authorizedViewId);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedViewAsync(string, AuthorizedView, string, CallSettings)
public virtual Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> CreateAuthorizedViewAsync(string parent, AuthorizedView authorizedView, string authorizedViewId, CallSettings callSettings = null)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. This is the name of the table the AuthorizedView belongs to.
Values are of the form
|
authorizedView | AuthorizedViewRequired. The AuthorizedView to create. |
authorizedViewId | stringRequired. The id of the AuthorizedView to create. This AuthorizedView must
not already exist. The |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
AuthorizedView authorizedView = new AuthorizedView();
string authorizedViewId = "";
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = await bigtableTableAdminClient.CreateAuthorizedViewAsync(parent, authorizedView, authorizedViewId);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
CreateAuthorizedViewAsync(string, AuthorizedView, string, CancellationToken)
public virtual Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> CreateAuthorizedViewAsync(string parent, AuthorizedView authorizedView, string authorizedViewId, CancellationToken cancellationToken)Creates a new AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. This is the name of the table the AuthorizedView belongs to.
Values are of the form
|
authorizedView | AuthorizedViewRequired. The AuthorizedView to create. |
authorizedViewId | stringRequired. The id of the AuthorizedView to create. This AuthorizedView must
not already exist. The |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
AuthorizedView authorizedView = new AuthorizedView();
string authorizedViewId = "";
// Make the request
Operation<AuthorizedView, CreateAuthorizedViewMetadata> response = await bigtableTableAdminClient.CreateAuthorizedViewAsync(parent, authorizedView, authorizedViewId);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, CreateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, CreateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceCreateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
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 | ClusterNameRequired. 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 |
backupId | stringRequired. The id of the backup to be created. The |
backup | BackupRequired. The backup to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCreateBackupMetadata | The RPC response. |
// 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)Starts creating a new Cloud Bigtable Backup. The returned backup [long-running operation][google.longrunning.Operation] can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.bigtable.admin.v2.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup.
| Parameters | |
|---|---|
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCreateBackupMetadata | The RPC response. |
// 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)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 | stringRequired. 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 |
backupId | stringRequired. The id of the backup to be created. The |
backup | BackupRequired. The backup to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCreateBackupMetadata | The RPC response. |
// 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)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 | ClusterNameRequired. 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 |
backupId | stringRequired. The id of the backup to be created. The |
backup | BackupRequired. The backup to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
// 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)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 | ClusterNameRequired. 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 |
backupId | stringRequired. The id of the backup to be created. The |
backup | BackupRequired. The backup to create. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
// 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)Starts creating a new Cloud Bigtable Backup. The returned backup [long-running operation][google.longrunning.Operation] can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.bigtable.admin.v2.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup.
| Parameters | |
|---|---|
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
// 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)Starts creating a new Cloud Bigtable Backup. The returned backup [long-running operation][google.longrunning.Operation] can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.bigtable.admin.v2.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup.
| Parameters | |
|---|---|
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
// 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)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 | stringRequired. 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 |
backupId | stringRequired. The id of the backup to be created. The |
backup | BackupRequired. The backup to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
// 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)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 | stringRequired. 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 |
backupId | stringRequired. The id of the backup to be created. The |
backup | BackupRequired. The backup to create. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
// 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 | CreateTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// 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 | InstanceNameRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
table | TableRequired. The Table to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// 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 | stringRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
table | TableRequired. The Table to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// 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 | CreateTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// 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 | CreateTableRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// 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 | InstanceNameRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
table | TableRequired. The Table to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// 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 | InstanceNameRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
table | TableRequired. The Table to create. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// 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 | stringRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
table | TableRequired. The Table to create. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// 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 | stringRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
table | TableRequired. The Table to create. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// 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 | CreateTableFromSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableCreateTableFromSnapshotMetadata | The RPC response. |
// 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.
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 |
parent | InstanceNameRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
sourceSnapshot | SnapshotNameRequired. 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
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableCreateTableFromSnapshotMetadata | The RPC response. |
// 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.
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 |
parent | stringRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
sourceSnapshot | stringRequired. 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
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableCreateTableFromSnapshotMetadata | The RPC response. |
// 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.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | CreateTableFromSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A Task containing the RPC response. |
// 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.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | CreateTableFromSnapshotRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A Task containing the RPC response. |
// 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.
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 |
parent | InstanceNameRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
sourceSnapshot | SnapshotNameRequired. 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
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A Task containing the RPC response. |
// 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.
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 |
parent | InstanceNameRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
sourceSnapshot | SnapshotNameRequired. 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
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A Task containing the RPC response. |
// 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.
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 |
parent | stringRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
sourceSnapshot | stringRequired. 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
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A Task containing the RPC response. |
// 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.
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 |
parent | stringRequired. The unique name of the instance in which to create the table.
Values are of the form |
tableId | stringRequired. The name by which the new table should be referred to within the
parent instance, e.g., |
sourceSnapshot | stringRequired. 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
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A Task containing the RPC response. |
// 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;
}
DeleteAuthorizedView(AuthorizedViewName, CallSettings)
public virtual void DeleteAuthorizedView(AuthorizedViewName name, CallSettings callSettings = null)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | AuthorizedViewNameRequired. The unique name of the AuthorizedView to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
AuthorizedViewName name = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
// Make the request
bigtableTableAdminClient.DeleteAuthorizedView(name);
DeleteAuthorizedView(DeleteAuthorizedViewRequest, CallSettings)
public virtual void DeleteAuthorizedView(DeleteAuthorizedViewRequest request, CallSettings callSettings = null)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
DeleteAuthorizedViewRequest request = new DeleteAuthorizedViewRequest
{
AuthorizedViewName = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]"),
Etag = "",
};
// Make the request
bigtableTableAdminClient.DeleteAuthorizedView(request);
DeleteAuthorizedView(string, CallSettings)
public virtual void DeleteAuthorizedView(string name, CallSettings callSettings = null)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the AuthorizedView to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]/authorizedViews/[AUTHORIZED_VIEW]";
// Make the request
bigtableTableAdminClient.DeleteAuthorizedView(name);
DeleteAuthorizedViewAsync(AuthorizedViewName, CallSettings)
public virtual Task DeleteAuthorizedViewAsync(AuthorizedViewName name, CallSettings callSettings = null)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | AuthorizedViewNameRequired. The unique name of the AuthorizedView to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
AuthorizedViewName name = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
// Make the request
await bigtableTableAdminClient.DeleteAuthorizedViewAsync(name);
DeleteAuthorizedViewAsync(AuthorizedViewName, CancellationToken)
public virtual Task DeleteAuthorizedViewAsync(AuthorizedViewName name, CancellationToken cancellationToken)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | AuthorizedViewNameRequired. The unique name of the AuthorizedView to be deleted.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
AuthorizedViewName name = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
// Make the request
await bigtableTableAdminClient.DeleteAuthorizedViewAsync(name);
DeleteAuthorizedViewAsync(DeleteAuthorizedViewRequest, CallSettings)
public virtual Task DeleteAuthorizedViewAsync(DeleteAuthorizedViewRequest request, CallSettings callSettings = null)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthorizedViewRequest request = new DeleteAuthorizedViewRequest
{
AuthorizedViewName = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]"),
Etag = "",
};
// Make the request
await bigtableTableAdminClient.DeleteAuthorizedViewAsync(request);
DeleteAuthorizedViewAsync(DeleteAuthorizedViewRequest, CancellationToken)
public virtual Task DeleteAuthorizedViewAsync(DeleteAuthorizedViewRequest request, CancellationToken cancellationToken)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthorizedViewRequest request = new DeleteAuthorizedViewRequest
{
AuthorizedViewName = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]"),
Etag = "",
};
// Make the request
await bigtableTableAdminClient.DeleteAuthorizedViewAsync(request);
DeleteAuthorizedViewAsync(string, CallSettings)
public virtual Task DeleteAuthorizedViewAsync(string name, CallSettings callSettings = null)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the AuthorizedView to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]/authorizedViews/[AUTHORIZED_VIEW]";
// Make the request
await bigtableTableAdminClient.DeleteAuthorizedViewAsync(name);
DeleteAuthorizedViewAsync(string, CancellationToken)
public virtual Task DeleteAuthorizedViewAsync(string name, CancellationToken cancellationToken)Permanently deletes a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the AuthorizedView to be deleted.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]/authorizedViews/[AUTHORIZED_VIEW]";
// Make the request
await bigtableTableAdminClient.DeleteAuthorizedViewAsync(name);
DeleteBackup(BackupName, CallSettings)
public virtual void DeleteBackup(BackupName name, CallSettings callSettings = null)Deletes a pending or completed Cloud Bigtable backup.
| Parameters | |
|---|---|
| Name | Description |
name | BackupNameRequired. Name of the backup to delete.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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 | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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 | stringRequired. Name of the backup to delete.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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 | BackupNameRequired. Name of the backup to delete.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | BackupNameRequired. Name of the backup to delete.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | stringRequired. Name of the backup to delete.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | stringRequired. Name of the backup to delete.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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.
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 |
name | SnapshotNameRequired. The unique name of the snapshot to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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.
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 |
name | stringRequired. The unique name of the snapshot to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteSnapshotRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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.
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 |
name | SnapshotNameRequired. The unique name of the snapshot to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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.
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 |
name | SnapshotNameRequired. The unique name of the snapshot to be deleted.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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.
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 |
name | stringRequired. The unique name of the snapshot to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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.
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 |
name | stringRequired. The unique name of the snapshot to be deleted.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | DeleteTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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 | TableNameRequired. The unique name of the table to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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 | stringRequired. The unique name of the table to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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 | DeleteTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | DeleteTableRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | TableNameRequired. The unique name of the table to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | TableNameRequired. The unique name of the table to be deleted.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | stringRequired. The unique name of the table to be deleted.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | stringRequired. The unique name of the table to be deleted.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | TableNameThe unique name of the table on which to drop the rows. Must not be null. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | TableNameThe unique name of the table on which to drop the rows. Must not be null. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task that completes when the RPC has completed. |
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 | TableNameThe unique name of the table on which to drop the rows. Must not be null. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task that completes when the RPC has completed. |
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 | DropRowRangeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
// 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 | TableNameThe unique name of the table on which to drop a range of rows. Must not be null. |
rowKeyPrefix | BigtableByteStringThe prefix of all rows which should be dropped. Cannot be null or empty. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | DropRowRangeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | DropRowRangeRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
// 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 | TableNameThe unique name of the table on which to drop a range of rows. Must not be null. |
rowKeyPrefix | BigtableByteStringThe prefix of all rows which should be dropped. Cannot be null or empty. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task that completes when the RPC has completed. |
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 | TableNameThe unique name of the table on which to drop a range of rows. Must not be null. |
rowKeyPrefix | BigtableByteStringThe prefix of all rows which should be dropped. Cannot be null or empty. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task that completes when the RPC has completed. |
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 | GenerateConsistencyTokenRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GenerateConsistencyTokenResponse | The RPC response. |
// 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)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 |
name | TableNameRequired. The unique name of the Table for which to create a consistency
token. Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GenerateConsistencyTokenResponse | The RPC response. |
// 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)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 |
name | stringRequired. The unique name of the Table for which to create a consistency
token. Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GenerateConsistencyTokenResponse | The RPC response. |
// 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)Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateConsistencyTokenRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateConsistencyTokenResponse | A Task containing the RPC response. |
// 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)Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateConsistencyTokenRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateConsistencyTokenResponse | A Task containing the RPC response. |
// 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)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 |
name | TableNameRequired. The unique name of the Table for which to create a consistency
token. Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateConsistencyTokenResponse | A Task containing the RPC response. |
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)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 |
name | TableNameRequired. The unique name of the Table for which to create a consistency
token. Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateConsistencyTokenResponse | A Task containing the RPC response. |
// 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)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 |
name | stringRequired. The unique name of the Table for which to create a consistency
token. Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateConsistencyTokenResponse | A Task containing the RPC response. |
// 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)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 |
name | stringRequired. The unique name of the Table for which to create a consistency
token. Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateConsistencyTokenResponse | A Task containing the RPC response. |
// 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);
GetAuthorizedView(AuthorizedViewName, CallSettings)
public virtual AuthorizedView GetAuthorizedView(AuthorizedViewName name, CallSettings callSettings = null)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | AuthorizedViewNameRequired. The unique name of the requested AuthorizedView.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AuthorizedView | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
AuthorizedViewName name = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
// Make the request
AuthorizedView response = bigtableTableAdminClient.GetAuthorizedView(name);
GetAuthorizedView(GetAuthorizedViewRequest, CallSettings)
public virtual AuthorizedView GetAuthorizedView(GetAuthorizedViewRequest request, CallSettings callSettings = null)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
request | GetAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AuthorizedView | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
GetAuthorizedViewRequest request = new GetAuthorizedViewRequest
{
AuthorizedViewName = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]"),
View = AuthorizedView.Types.ResponseView.Unspecified,
};
// Make the request
AuthorizedView response = bigtableTableAdminClient.GetAuthorizedView(request);
GetAuthorizedView(string, CallSettings)
public virtual AuthorizedView GetAuthorizedView(string name, CallSettings callSettings = null)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested AuthorizedView.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AuthorizedView | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]/authorizedViews/[AUTHORIZED_VIEW]";
// Make the request
AuthorizedView response = bigtableTableAdminClient.GetAuthorizedView(name);
GetAuthorizedViewAsync(AuthorizedViewName, CallSettings)
public virtual Task<AuthorizedView> GetAuthorizedViewAsync(AuthorizedViewName name, CallSettings callSettings = null)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | AuthorizedViewNameRequired. The unique name of the requested AuthorizedView.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthorizedView | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
AuthorizedViewName name = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
// Make the request
AuthorizedView response = await bigtableTableAdminClient.GetAuthorizedViewAsync(name);
GetAuthorizedViewAsync(AuthorizedViewName, CancellationToken)
public virtual Task<AuthorizedView> GetAuthorizedViewAsync(AuthorizedViewName name, CancellationToken cancellationToken)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | AuthorizedViewNameRequired. The unique name of the requested AuthorizedView.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthorizedView | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
AuthorizedViewName name = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
// Make the request
AuthorizedView response = await bigtableTableAdminClient.GetAuthorizedViewAsync(name);
GetAuthorizedViewAsync(GetAuthorizedViewRequest, CallSettings)
public virtual Task<AuthorizedView> GetAuthorizedViewAsync(GetAuthorizedViewRequest request, CallSettings callSettings = null)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
request | GetAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthorizedView | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetAuthorizedViewRequest request = new GetAuthorizedViewRequest
{
AuthorizedViewName = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]"),
View = AuthorizedView.Types.ResponseView.Unspecified,
};
// Make the request
AuthorizedView response = await bigtableTableAdminClient.GetAuthorizedViewAsync(request);
GetAuthorizedViewAsync(GetAuthorizedViewRequest, CancellationToken)
public virtual Task<AuthorizedView> GetAuthorizedViewAsync(GetAuthorizedViewRequest request, CancellationToken cancellationToken)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
request | GetAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthorizedView | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetAuthorizedViewRequest request = new GetAuthorizedViewRequest
{
AuthorizedViewName = AuthorizedViewName.FromProjectInstanceTableAuthorizedView("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]"),
View = AuthorizedView.Types.ResponseView.Unspecified,
};
// Make the request
AuthorizedView response = await bigtableTableAdminClient.GetAuthorizedViewAsync(request);
GetAuthorizedViewAsync(string, CallSettings)
public virtual Task<AuthorizedView> GetAuthorizedViewAsync(string name, CallSettings callSettings = null)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested AuthorizedView.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthorizedView | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]/authorizedViews/[AUTHORIZED_VIEW]";
// Make the request
AuthorizedView response = await bigtableTableAdminClient.GetAuthorizedViewAsync(name);
GetAuthorizedViewAsync(string, CancellationToken)
public virtual Task<AuthorizedView> GetAuthorizedViewAsync(string name, CancellationToken cancellationToken)Gets information from a specified AuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested AuthorizedView.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAuthorizedView | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]/authorizedViews/[AUTHORIZED_VIEW]";
// Make the request
AuthorizedView response = await bigtableTableAdminClient.GetAuthorizedViewAsync(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 | BackupNameRequired. Name of the backup.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
// 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 | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
// 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 | stringRequired. Name of the backup.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
// 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 | BackupNameRequired. Name of the backup.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// 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 | BackupNameRequired. Name of the backup.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// 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 | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// 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 | GetBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// 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 | stringRequired. Name of the backup.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// 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 | stringRequired. Name of the backup.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// 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 | IResourceNameREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
// 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 | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
// 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 | stringREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
// 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 | IResourceNameREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// 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 | IResourceNameREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// 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 | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// 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 | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// 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(string, CallSettings)
public virtual Task<Policy> GetIamPolicyAsync(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 | stringREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await bigtableTableAdminClient.GetIamPolicyAsync(resource);
GetIamPolicyAsync(string, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(string 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 | stringREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await bigtableTableAdminClient.GetIamPolicyAsync(resource);
GetSnapshot(GetSnapshotRequest, CallSettings)
public virtual Snapshot GetSnapshot(GetSnapshotRequest request, CallSettings callSettings = null)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | GetSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Snapshot | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
GetSnapshotRequest request = new GetSnapshotRequest
{
SnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
Snapshot response = bigtableTableAdminClient.GetSnapshot(request);
GetSnapshot(SnapshotName, CallSettings)
public virtual Snapshot GetSnapshot(SnapshotName name, CallSettings callSettings = null)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | SnapshotNameRequired. The unique name of the requested snapshot.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Snapshot | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
SnapshotName name = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
Snapshot response = bigtableTableAdminClient.GetSnapshot(name);
GetSnapshot(string, CallSettings)
public virtual Snapshot GetSnapshot(string name, CallSettings callSettings = null)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested snapshot.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Snapshot | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
Snapshot response = bigtableTableAdminClient.GetSnapshot(name);
GetSnapshotAsync(GetSnapshotRequest, CallSettings)
public virtual Task<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CallSettings callSettings = null)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | GetSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSnapshot | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetSnapshotRequest request = new GetSnapshotRequest
{
SnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
Snapshot response = await bigtableTableAdminClient.GetSnapshotAsync(request);
GetSnapshotAsync(GetSnapshotRequest, CancellationToken)
public virtual Task<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CancellationToken cancellationToken)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | GetSnapshotRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskSnapshot | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetSnapshotRequest request = new GetSnapshotRequest
{
SnapshotName = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]"),
};
// Make the request
Snapshot response = await bigtableTableAdminClient.GetSnapshotAsync(request);
GetSnapshotAsync(SnapshotName, CallSettings)
public virtual Task<Snapshot> GetSnapshotAsync(SnapshotName name, CallSettings callSettings = null)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | SnapshotNameRequired. The unique name of the requested snapshot.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSnapshot | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SnapshotName name = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
Snapshot response = await bigtableTableAdminClient.GetSnapshotAsync(name);
GetSnapshotAsync(SnapshotName, CancellationToken)
public virtual Task<Snapshot> GetSnapshotAsync(SnapshotName name, CancellationToken cancellationToken)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | SnapshotNameRequired. The unique name of the requested snapshot.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskSnapshot | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SnapshotName name = SnapshotName.FromProjectInstanceClusterSnapshot("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
// Make the request
Snapshot response = await bigtableTableAdminClient.GetSnapshotAsync(name);
GetSnapshotAsync(string, CallSettings)
public virtual Task<Snapshot> GetSnapshotAsync(string name, CallSettings callSettings = null)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested snapshot.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSnapshot | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
Snapshot response = await bigtableTableAdminClient.GetSnapshotAsync(name);
GetSnapshotAsync(string, CancellationToken)
public virtual Task<Snapshot> GetSnapshotAsync(string name, CancellationToken cancellationToken)Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested snapshot.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskSnapshot | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]/snapshots/[SNAPSHOT]";
// Make the request
Snapshot response = await bigtableTableAdminClient.GetSnapshotAsync(name);
GetTable(GetTableRequest, CallSettings)
public virtual Table GetTable(GetTableRequest request, CallSettings callSettings = null)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
request | GetTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
GetTableRequest request = new GetTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
View = Table.Types.View.Unspecified,
};
// Make the request
Table response = bigtableTableAdminClient.GetTable(request);
GetTable(TableName, CallSettings)
public virtual Table GetTable(TableName name, CallSettings callSettings = null)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the requested table.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
Table response = bigtableTableAdminClient.GetTable(name);
GetTable(string, CallSettings)
public virtual Table GetTable(string name, CallSettings callSettings = null)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested table.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
Table response = bigtableTableAdminClient.GetTable(name);
GetTableAsync(GetTableRequest, CallSettings)
public virtual Task<Table> GetTableAsync(GetTableRequest request, CallSettings callSettings = null)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
request | GetTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetTableRequest request = new GetTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
View = Table.Types.View.Unspecified,
};
// Make the request
Table response = await bigtableTableAdminClient.GetTableAsync(request);
GetTableAsync(GetTableRequest, CancellationToken)
public virtual Task<Table> GetTableAsync(GetTableRequest request, CancellationToken cancellationToken)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
request | GetTableRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
GetTableRequest request = new GetTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
View = Table.Types.View.Unspecified,
};
// Make the request
Table response = await bigtableTableAdminClient.GetTableAsync(request);
GetTableAsync(TableName, CallSettings)
public virtual Task<Table> GetTableAsync(TableName name, CallSettings callSettings = null)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the requested table.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
Table response = await bigtableTableAdminClient.GetTableAsync(name);
GetTableAsync(TableName, CancellationToken)
public virtual Task<Table> GetTableAsync(TableName name, CancellationToken cancellationToken)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the requested table.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
Table response = await bigtableTableAdminClient.GetTableAsync(name);
GetTableAsync(string, CallSettings)
public virtual Task<Table> GetTableAsync(string name, CallSettings callSettings = null)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested table.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
Table response = await bigtableTableAdminClient.GetTableAsync(name);
GetTableAsync(string, CancellationToken)
public virtual Task<Table> GetTableAsync(string name, CancellationToken cancellationToken)Gets metadata information about the specified table.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the requested table.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
Table response = await bigtableTableAdminClient.GetTableAsync(name);
ListAuthorizedViews(ListAuthorizedViewsRequest, CallSettings)
public virtual PagedEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViews(ListAuthorizedViewsRequest request, CallSettings callSettings = null)Lists all AuthorizedViews from a specific table.
| Parameters | |
|---|---|
| Name | Description |
request | ListAuthorizedViewsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAuthorizedViewsResponseAuthorizedView | A pageable sequence of AuthorizedView resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ListAuthorizedViewsRequest request = new ListAuthorizedViewsRequest
{
ParentAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
View = AuthorizedView.Types.ResponseView.Unspecified,
};
// Make the request
PagedEnumerable<ListAuthorizedViewsResponse, AuthorizedView> response = bigtableTableAdminClient.ListAuthorizedViews(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (AuthorizedView item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAuthorizedViewsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AuthorizedView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthorizedView> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthorizedView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAuthorizedViews(TableName, string, int?, CallSettings)
public virtual PagedEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViews(TableName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all AuthorizedViews from a specific table.
| Parameters | |
|---|---|
| Name | Description |
parent | TableNameRequired. The unique name of the table for which AuthorizedViews should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAuthorizedViewsResponseAuthorizedView | A pageable sequence of AuthorizedView resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName parent = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
PagedEnumerable<ListAuthorizedViewsResponse, AuthorizedView> response = bigtableTableAdminClient.ListAuthorizedViews(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (AuthorizedView item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAuthorizedViewsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AuthorizedView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthorizedView> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthorizedView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAuthorizedViews(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViews(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all AuthorizedViews from a specific table.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The unique name of the table for which AuthorizedViews should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAuthorizedViewsResponseAuthorizedView | A pageable sequence of AuthorizedView resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
PagedEnumerable<ListAuthorizedViewsResponse, AuthorizedView> response = bigtableTableAdminClient.ListAuthorizedViews(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (AuthorizedView item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAuthorizedViewsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AuthorizedView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthorizedView> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthorizedView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAuthorizedViewsAsync(ListAuthorizedViewsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViewsAsync(ListAuthorizedViewsRequest request, CallSettings callSettings = null)Lists all AuthorizedViews from a specific table.
| Parameters | |
|---|---|
| Name | Description |
request | ListAuthorizedViewsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAuthorizedViewsResponseAuthorizedView | A pageable asynchronous sequence of AuthorizedView resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ListAuthorizedViewsRequest request = new ListAuthorizedViewsRequest
{
ParentAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
View = AuthorizedView.Types.ResponseView.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListAuthorizedViewsResponse, AuthorizedView> response = bigtableTableAdminClient.ListAuthorizedViewsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AuthorizedView item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAuthorizedViewsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AuthorizedView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthorizedView> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthorizedView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAuthorizedViewsAsync(TableName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViewsAsync(TableName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all AuthorizedViews from a specific table.
| Parameters | |
|---|---|
| Name | Description |
parent | TableNameRequired. The unique name of the table for which AuthorizedViews should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAuthorizedViewsResponseAuthorizedView | A pageable asynchronous sequence of AuthorizedView resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName parent = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
PagedAsyncEnumerable<ListAuthorizedViewsResponse, AuthorizedView> response = bigtableTableAdminClient.ListAuthorizedViewsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AuthorizedView item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAuthorizedViewsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AuthorizedView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthorizedView> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthorizedView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAuthorizedViewsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListAuthorizedViewsResponse, AuthorizedView> ListAuthorizedViewsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all AuthorizedViews from a specific table.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The unique name of the table for which AuthorizedViews should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAuthorizedViewsResponseAuthorizedView | A pageable asynchronous sequence of AuthorizedView resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
PagedAsyncEnumerable<ListAuthorizedViewsResponse, AuthorizedView> response = bigtableTableAdminClient.ListAuthorizedViewsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AuthorizedView item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAuthorizedViewsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (AuthorizedView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AuthorizedView> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AuthorizedView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBackups(ClusterName, string, int?, CallSettings)
public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Cloud Bigtable backups. Returns both completed and pending backups.
| Parameters | |
|---|---|
| Name | Description |
parent | ClusterNameRequired. The cluster to list backups from. Values are of the
form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupsResponseBackup | A pageable sequence of Backup resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = bigtableTableAdminClient.ListBackups(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Backup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBackups(ListBackupsRequest, CallSettings)
public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)Lists Cloud Bigtable backups. Returns both completed and pending backups.
| Parameters | |
|---|---|
| Name | Description |
request | ListBackupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupsResponseBackup | A pageable sequence of Backup resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = bigtableTableAdminClient.ListBackups(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Backup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBackups(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Cloud Bigtable backups. Returns both completed and pending backups.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The cluster to list backups from. Values are of the
form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupsResponseBackup | A pageable sequence of Backup resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = bigtableTableAdminClient.ListBackups(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Backup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBackupsAsync(ClusterName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Cloud Bigtable backups. Returns both completed and pending backups.
| Parameters | |
|---|---|
| Name | Description |
parent | ClusterNameRequired. The cluster to list backups from. Values are of the
form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupsResponseBackup | A pageable asynchronous sequence of Backup resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = bigtableTableAdminClient.ListBackupsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Backup item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Backup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBackupsAsync(ListBackupsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)Lists Cloud Bigtable backups. Returns both completed and pending backups.
| Parameters | |
|---|---|
| Name | Description |
request | ListBackupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupsResponseBackup | A pageable asynchronous sequence of Backup resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
Filter = "",
OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = bigtableTableAdminClient.ListBackupsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Backup item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Backup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBackupsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists Cloud Bigtable backups. Returns both completed and pending backups.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The cluster to list backups from. Values are of the
form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupsResponseBackup | A pageable asynchronous sequence of Backup resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = bigtableTableAdminClient.ListBackupsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Backup item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Backup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSnapshots(ClusterName, string, int?, CallSettings)
public virtual PagedEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshots(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
parent | ClusterNameRequired. The unique name of the cluster for which snapshots should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListSnapshotsResponseSnapshot | A pageable sequence of Snapshot resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
PagedEnumerable<ListSnapshotsResponse, Snapshot> response = bigtableTableAdminClient.ListSnapshots(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Snapshot item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSnapshotsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Snapshot item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Snapshot> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Snapshot item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSnapshots(ListSnapshotsRequest, CallSettings)
public virtual PagedEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshots(ListSnapshotsRequest request, CallSettings callSettings = null)Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | ListSnapshotsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListSnapshotsResponseSnapshot | A pageable sequence of Snapshot resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ListSnapshotsRequest request = new ListSnapshotsRequest
{
ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
PagedEnumerable<ListSnapshotsResponse, Snapshot> response = bigtableTableAdminClient.ListSnapshots(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Snapshot item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSnapshotsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Snapshot item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Snapshot> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Snapshot item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSnapshots(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshots(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The unique name of the cluster for which snapshots should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListSnapshotsResponseSnapshot | A pageable sequence of Snapshot resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
PagedEnumerable<ListSnapshotsResponse, Snapshot> response = bigtableTableAdminClient.ListSnapshots(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Snapshot item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSnapshotsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Snapshot item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Snapshot> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Snapshot item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSnapshotsAsync(ClusterName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshotsAsync(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
parent | ClusterNameRequired. The unique name of the cluster for which snapshots should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListSnapshotsResponseSnapshot | A pageable asynchronous sequence of Snapshot resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
// Make the request
PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> response = bigtableTableAdminClient.ListSnapshotsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Snapshot item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSnapshotsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Snapshot item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Snapshot> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Snapshot item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSnapshotsAsync(ListSnapshotsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshotsAsync(ListSnapshotsRequest request, CallSettings callSettings = null)Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | ListSnapshotsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListSnapshotsResponseSnapshot | A pageable asynchronous sequence of Snapshot resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ListSnapshotsRequest request = new ListSnapshotsRequest
{
ParentAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
};
// Make the request
PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> response = bigtableTableAdminClient.ListSnapshotsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Snapshot item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSnapshotsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Snapshot item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Snapshot> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Snapshot item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListSnapshotsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshotsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The unique name of the cluster for which snapshots should be
listed. Values are of the form
|
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListSnapshotsResponseSnapshot | A pageable asynchronous sequence of Snapshot resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
// Make the request
PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> response = bigtableTableAdminClient.ListSnapshotsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Snapshot item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSnapshotsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Snapshot item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Snapshot> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Snapshot item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTables(ListTablesRequest, CallSettings)
public virtual PagedEnumerable<ListTablesResponse, Table> ListTables(ListTablesRequest request, CallSettings callSettings = null)Lists all tables served from a specified instance.
| Parameters | |
|---|---|
| Name | Description |
request | ListTablesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTablesResponseTable | A pageable sequence of Table resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ListTablesRequest request = new ListTablesRequest
{
ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
View = Table.Types.View.Unspecified,
};
// Make the request
PagedEnumerable<ListTablesResponse, Table> response = bigtableTableAdminClient.ListTables(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Table item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTablesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Table item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTables(InstanceName, string, int?, CallSettings)
public virtual PagedEnumerable<ListTablesResponse, Table> ListTables(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all tables served from a specified instance.
| Parameters | |
|---|---|
| Name | Description |
parent | InstanceNameRequired. The unique name of the instance for which tables should be
listed. Values are of the form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTablesResponseTable | A pageable sequence of Table resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListTablesResponse, Table> response = bigtableTableAdminClient.ListTables(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Table item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTablesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Table item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTables(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListTablesResponse, Table> ListTables(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all tables served from a specified instance.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The unique name of the instance for which tables should be
listed. Values are of the form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTablesResponseTable | A pageable sequence of Table resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PagedEnumerable<ListTablesResponse, Table> response = bigtableTableAdminClient.ListTables(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Table item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTablesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Table item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTablesAsync(ListTablesRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListTablesResponse, Table> ListTablesAsync(ListTablesRequest request, CallSettings callSettings = null)Lists all tables served from a specified instance.
| Parameters | |
|---|---|
| Name | Description |
request | ListTablesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTablesResponseTable | A pageable asynchronous sequence of Table resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ListTablesRequest request = new ListTablesRequest
{
ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
View = Table.Types.View.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListTablesResponse, Table> response = bigtableTableAdminClient.ListTablesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Table item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTablesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Table item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTablesAsync(InstanceName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListTablesResponse, Table> ListTablesAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all tables served from a specified instance.
| Parameters | |
|---|---|
| Name | Description |
parent | InstanceNameRequired. The unique name of the instance for which tables should be
listed. Values are of the form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTablesResponseTable | A pageable asynchronous sequence of Table resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListTablesResponse, Table> response = bigtableTableAdminClient.ListTablesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Table item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTablesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Table item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTablesAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListTablesResponse, Table> ListTablesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Lists all tables served from a specified instance.
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The unique name of the instance for which tables should be
listed. Values are of the form |
pageToken | stringThe token returned from the previous request. A value of |
pageSize | intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTablesResponseTable | A pageable asynchronous sequence of Table resources. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListTablesResponse, Table> response = bigtableTableAdminClient.ListTablesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Table item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTablesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Table item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ModifyColumnFamilies(ModifyColumnFamiliesRequest, CallSettings)
public virtual Table ModifyColumnFamilies(ModifyColumnFamiliesRequest request, CallSettings callSettings = null)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
request | ModifyColumnFamiliesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
ModifyColumnFamiliesRequest request = new ModifyColumnFamiliesRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
Modifications =
{
new ModifyColumnFamiliesRequest.Types.Modification(),
},
IgnoreWarnings = false,
};
// Make the request
Table response = bigtableTableAdminClient.ModifyColumnFamilies(request);
ModifyColumnFamilies(TableName, IEnumerable<Modification>, CallSettings)
public virtual Table ModifyColumnFamilies(TableName name, IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications, CallSettings callSettings = null)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table whose families should be modified.
Values are of the form
|
modifications | IEnumerableModifyColumnFamiliesRequestTypesModificationRequired. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications = new ModifyColumnFamiliesRequest.Types.Modification[]
{
new ModifyColumnFamiliesRequest.Types.Modification(),
};
// Make the request
Table response = bigtableTableAdminClient.ModifyColumnFamilies(name, modifications);
ModifyColumnFamilies(string, IEnumerable<Modification>, CallSettings)
public virtual Table ModifyColumnFamilies(string name, IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications, CallSettings callSettings = null)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table whose families should be modified.
Values are of the form
|
modifications | IEnumerableModifyColumnFamiliesRequestTypesModificationRequired. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Table | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications = new ModifyColumnFamiliesRequest.Types.Modification[]
{
new ModifyColumnFamiliesRequest.Types.Modification(),
};
// Make the request
Table response = bigtableTableAdminClient.ModifyColumnFamilies(name, modifications);
ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest, CallSettings)
public virtual Task<Table> ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest request, CallSettings callSettings = null)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
request | ModifyColumnFamiliesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ModifyColumnFamiliesRequest request = new ModifyColumnFamiliesRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
Modifications =
{
new ModifyColumnFamiliesRequest.Types.Modification(),
},
IgnoreWarnings = false,
};
// Make the request
Table response = await bigtableTableAdminClient.ModifyColumnFamiliesAsync(request);
ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest, CancellationToken)
public virtual Task<Table> ModifyColumnFamiliesAsync(ModifyColumnFamiliesRequest request, CancellationToken cancellationToken)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
request | ModifyColumnFamiliesRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
ModifyColumnFamiliesRequest request = new ModifyColumnFamiliesRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
Modifications =
{
new ModifyColumnFamiliesRequest.Types.Modification(),
},
IgnoreWarnings = false,
};
// Make the request
Table response = await bigtableTableAdminClient.ModifyColumnFamiliesAsync(request);
ModifyColumnFamiliesAsync(TableName, IEnumerable<Modification>, CallSettings)
public virtual Task<Table> ModifyColumnFamiliesAsync(TableName name, IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications, CallSettings callSettings = null)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table whose families should be modified.
Values are of the form
|
modifications | IEnumerableModifyColumnFamiliesRequestTypesModificationRequired. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications = new ModifyColumnFamiliesRequest.Types.Modification[]
{
new ModifyColumnFamiliesRequest.Types.Modification(),
};
// Make the request
Table response = await bigtableTableAdminClient.ModifyColumnFamiliesAsync(name, modifications);
ModifyColumnFamiliesAsync(TableName, IEnumerable<Modification>, CancellationToken)
public virtual Task<Table> ModifyColumnFamiliesAsync(TableName name, IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications, CancellationToken cancellationToken)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table whose families should be modified.
Values are of the form
|
modifications | IEnumerableModifyColumnFamiliesRequestTypesModificationRequired. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications = new ModifyColumnFamiliesRequest.Types.Modification[]
{
new ModifyColumnFamiliesRequest.Types.Modification(),
};
// Make the request
Table response = await bigtableTableAdminClient.ModifyColumnFamiliesAsync(name, modifications);
ModifyColumnFamiliesAsync(string, IEnumerable<Modification>, CallSettings)
public virtual Task<Table> ModifyColumnFamiliesAsync(string name, IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications, CallSettings callSettings = null)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table whose families should be modified.
Values are of the form
|
modifications | IEnumerableModifyColumnFamiliesRequestTypesModificationRequired. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications = new ModifyColumnFamiliesRequest.Types.Modification[]
{
new ModifyColumnFamiliesRequest.Types.Modification(),
};
// Make the request
Table response = await bigtableTableAdminClient.ModifyColumnFamiliesAsync(name, modifications);
ModifyColumnFamiliesAsync(string, IEnumerable<Modification>, CancellationToken)
public virtual Task<Table> ModifyColumnFamiliesAsync(string name, IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications, CancellationToken cancellationToken)Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table whose families should be modified.
Values are of the form
|
modifications | IEnumerableModifyColumnFamiliesRequestTypesModificationRequired. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTable | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
IEnumerable<ModifyColumnFamiliesRequest.Types.Modification> modifications = new ModifyColumnFamiliesRequest.Types.Modification[]
{
new ModifyColumnFamiliesRequest.Types.Modification(),
};
// Make the request
Table response = await bigtableTableAdminClient.ModifyColumnFamiliesAsync(name, modifications);
PollOnceCopyBackup(string, CallSettings)
public virtual Operation<Backup, CopyBackupMetadata> PollOnceCopyBackup(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of CopyBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCopyBackupMetadata | The result of polling the operation. |
PollOnceCopyBackupAsync(string, CallSettings)
public virtual Task<Operation<Backup, CopyBackupMetadata>> PollOnceCopyBackupAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
CopyBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A task representing the result of polling the operation. |
PollOnceCreateAuthorizedView(string, CallSettings)
public virtual Operation<AuthorizedView, CreateAuthorizedViewMetadata> PollOnceCreateAuthorizedView(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of CreateAuthorizedView
.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAuthorizedViewCreateAuthorizedViewMetadata | The result of polling the operation. |
PollOnceCreateAuthorizedViewAsync(string, CallSettings)
public virtual Task<Operation<AuthorizedView, CreateAuthorizedViewMetadata>> PollOnceCreateAuthorizedViewAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
CreateAuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewCreateAuthorizedViewMetadata | A task representing the result of polling the operation. |
PollOnceCreateBackup(string, CallSettings)
public virtual Operation<Backup, CreateBackupMetadata> PollOnceCreateBackup(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of CreateBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCreateBackupMetadata | The result of polling the operation. |
PollOnceCreateBackupAsync(string, CallSettings)
public virtual Task<Operation<Backup, CreateBackupMetadata>> PollOnceCreateBackupAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
CreateBackup.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A task representing the result of polling the operation. |
PollOnceCreateTableFromSnapshot(string, CallSettings)
public virtual Operation<Table, CreateTableFromSnapshotMetadata> PollOnceCreateTableFromSnapshot(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of
CreateTableFromSnapshot.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableCreateTableFromSnapshotMetadata | The result of polling the operation. |
PollOnceCreateTableFromSnapshotAsync(string, CallSettings)
public virtual Task<Operation<Table, CreateTableFromSnapshotMetadata>> PollOnceCreateTableFromSnapshotAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
CreateTableFromSnapshot.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableCreateTableFromSnapshotMetadata | A task representing the result of polling the operation. |
PollOnceRestoreTable(string, CallSettings)
public virtual Operation<Table, RestoreTableMetadata> PollOnceRestoreTable(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of RestoreTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableRestoreTableMetadata | The result of polling the operation. |
PollOnceRestoreTableAsync(string, CallSettings)
public virtual Task<Operation<Table, RestoreTableMetadata>> PollOnceRestoreTableAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
RestoreTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableRestoreTableMetadata | A task representing the result of polling the operation. |
PollOnceSnapshotTable(string, CallSettings)
public virtual Operation<Snapshot, SnapshotTableMetadata> PollOnceSnapshotTable(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of SnapshotTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationSnapshotSnapshotTableMetadata | The result of polling the operation. |
PollOnceSnapshotTableAsync(string, CallSettings)
public virtual Task<Operation<Snapshot, SnapshotTableMetadata>> PollOnceSnapshotTableAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
SnapshotTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSnapshotSnapshotTableMetadata | A task representing the result of polling the operation. |
PollOnceUndeleteTable(string, CallSettings)
public virtual Operation<Table, UndeleteTableMetadata> PollOnceUndeleteTable(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of UndeleteTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableUndeleteTableMetadata | The result of polling the operation. |
PollOnceUndeleteTableAsync(string, CallSettings)
public virtual Task<Operation<Table, UndeleteTableMetadata>> PollOnceUndeleteTableAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
UndeleteTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUndeleteTableMetadata | A task representing the result of polling the operation. |
PollOnceUpdateAuthorizedView(string, CallSettings)
public virtual Operation<AuthorizedView, UpdateAuthorizedViewMetadata> PollOnceUpdateAuthorizedView(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of UpdateAuthorizedView
.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAuthorizedViewUpdateAuthorizedViewMetadata | The result of polling the operation. |
PollOnceUpdateAuthorizedViewAsync(string, CallSettings)
public virtual Task<Operation<AuthorizedView, UpdateAuthorizedViewMetadata>> PollOnceUpdateAuthorizedViewAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
UpdateAuthorizedView.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewUpdateAuthorizedViewMetadata | A task representing the result of polling the operation. |
PollOnceUpdateTable(string, CallSettings)
public virtual Operation<Table, UpdateTableMetadata> PollOnceUpdateTable(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of UpdateTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableUpdateTableMetadata | The result of polling the operation. |
PollOnceUpdateTableAsync(string, CallSettings)
public virtual Task<Operation<Table, UpdateTableMetadata>> PollOnceUpdateTableAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
UpdateTable.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of a previously invoked operation. Must not be |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUpdateTableMetadata | A task representing the result of polling the operation. |
RestoreTable(RestoreTableRequest, CallSettings)
public virtual Operation<Table, RestoreTableMetadata> RestoreTable(RestoreTableRequest request, CallSettings callSettings = null)Create a new table by restoring from a completed backup. The returned table [long-running operation][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is [Table][google.bigtable.admin.v2.Table], if successful.
| Parameters | |
|---|---|
| Name | Description |
request | RestoreTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableRestoreTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
RestoreTableRequest request = new RestoreTableRequest
{
ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
TableId = "",
BackupAsBackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
Operation<Table, RestoreTableMetadata> response = bigtableTableAdminClient.RestoreTable(request);
// Poll until the returned long-running operation is complete
Operation<Table, RestoreTableMetadata> 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, RestoreTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceRestoreTable(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;
}
RestoreTableAsync(RestoreTableRequest, CallSettings)
public virtual Task<Operation<Table, RestoreTableMetadata>> RestoreTableAsync(RestoreTableRequest request, CallSettings callSettings = null)Create a new table by restoring from a completed backup. The returned table [long-running operation][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is [Table][google.bigtable.admin.v2.Table], if successful.
| Parameters | |
|---|---|
| Name | Description |
request | RestoreTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableRestoreTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
RestoreTableRequest request = new RestoreTableRequest
{
ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
TableId = "",
BackupAsBackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
Operation<Table, RestoreTableMetadata> response = await bigtableTableAdminClient.RestoreTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Table, RestoreTableMetadata> 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, RestoreTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceRestoreTableAsync(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;
}
RestoreTableAsync(RestoreTableRequest, CancellationToken)
public virtual Task<Operation<Table, RestoreTableMetadata>> RestoreTableAsync(RestoreTableRequest request, CancellationToken cancellationToken)Create a new table by restoring from a completed backup. The returned table [long-running operation][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is [Table][google.bigtable.admin.v2.Table], if successful.
| Parameters | |
|---|---|
| Name | Description |
request | RestoreTableRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableRestoreTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
RestoreTableRequest request = new RestoreTableRequest
{
ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
TableId = "",
BackupAsBackupName = BackupName.FromProjectInstanceClusterBackup("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]"),
};
// Make the request
Operation<Table, RestoreTableMetadata> response = await bigtableTableAdminClient.RestoreTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Table, RestoreTableMetadata> 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, RestoreTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceRestoreTableAsync(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;
}
SetIamPolicy(IResourceName, Policy, CallSettings)
public virtual Policy SetIamPolicy(IResourceName resource, Policy policy, CallSettings callSettings = null)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
resource | IResourceNameREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | PolicyREQUIRED: The complete policy to be applied to the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = bigtableTableAdminClient.SetIamPolicy(resource, policy);
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Policy = new Policy(),
UpdateMask = new FieldMask(),
};
// Make the request
Policy response = bigtableTableAdminClient.SetIamPolicy(request);
SetIamPolicy(string, Policy, CallSettings)
public virtual Policy SetIamPolicy(string resource, Policy policy, CallSettings callSettings = null)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
resource | stringREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | PolicyREQUIRED: The complete policy to be applied to the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = bigtableTableAdminClient.SetIamPolicy(resource, policy);
SetIamPolicyAsync(IResourceName, Policy, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, CallSettings callSettings = null)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
resource | IResourceNameREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | PolicyREQUIRED: The complete policy to be applied to the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = await bigtableTableAdminClient.SetIamPolicyAsync(resource, policy);
SetIamPolicyAsync(IResourceName, Policy, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, CancellationToken cancellationToken)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
resource | IResourceNameREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | PolicyREQUIRED: The complete policy to be applied to the |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = await bigtableTableAdminClient.SetIamPolicyAsync(resource, policy);
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Policy = new Policy(),
UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await bigtableTableAdminClient.SetIamPolicyAsync(request);
SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken cancellationToken)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Policy = new Policy(),
UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await bigtableTableAdminClient.SetIamPolicyAsync(request);
SetIamPolicyAsync(string, Policy, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, CallSettings callSettings = null)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
resource | stringREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | PolicyREQUIRED: The complete policy to be applied to the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = await bigtableTableAdminClient.SetIamPolicyAsync(resource, policy);
SetIamPolicyAsync(string, Policy, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, CancellationToken cancellationToken)Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
resource | stringREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | PolicyREQUIRED: The complete policy to be applied to the |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = await bigtableTableAdminClient.SetIamPolicyAsync(resource, policy);
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
| Returns | |
|---|---|
| Type | Description |
Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
SnapshotTable(SnapshotTableRequest, CallSettings)
public virtual Operation<Snapshot, SnapshotTableMetadata> SnapshotTable(SnapshotTableRequest request, CallSettings callSettings = null)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | SnapshotTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationSnapshotSnapshotTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
SnapshotTableRequest request = new SnapshotTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
ClusterAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
SnapshotId = "",
Ttl = new Duration(),
Description = "",
};
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = bigtableTableAdminClient.SnapshotTable(request);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceSnapshotTable(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTable(TableName, ClusterName, string, string, CallSettings)
public virtual Operation<Snapshot, SnapshotTableMetadata> SnapshotTable(TableName name, ClusterName cluster, string snapshotId, string description, CallSettings callSettings = null)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table to have the snapshot taken.
Values are of the form
|
cluster | ClusterNameRequired. The name of the cluster where the snapshot will be created in.
Values are of the form
|
snapshotId | stringRequired. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., |
description | stringDescription of the snapshot. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationSnapshotSnapshotTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ClusterName cluster = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string snapshotId = "";
string description = "";
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = bigtableTableAdminClient.SnapshotTable(name, cluster, snapshotId, description);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceSnapshotTable(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTable(string, string, string, string, CallSettings)
public virtual Operation<Snapshot, SnapshotTableMetadata> SnapshotTable(string name, string cluster, string snapshotId, string description, CallSettings callSettings = null)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table to have the snapshot taken.
Values are of the form
|
cluster | stringRequired. The name of the cluster where the snapshot will be created in.
Values are of the form
|
snapshotId | stringRequired. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., |
description | stringDescription of the snapshot. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationSnapshotSnapshotTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string cluster = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string snapshotId = "";
string description = "";
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = bigtableTableAdminClient.SnapshotTable(name, cluster, snapshotId, description);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceSnapshotTable(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTableAsync(SnapshotTableRequest, CallSettings)
public virtual Task<Operation<Snapshot, SnapshotTableMetadata>> SnapshotTableAsync(SnapshotTableRequest request, CallSettings callSettings = null)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | SnapshotTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSnapshotSnapshotTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SnapshotTableRequest request = new SnapshotTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
ClusterAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
SnapshotId = "",
Ttl = new Duration(),
Description = "",
};
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = await bigtableTableAdminClient.SnapshotTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceSnapshotTableAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTableAsync(SnapshotTableRequest, CancellationToken)
public virtual Task<Operation<Snapshot, SnapshotTableMetadata>> SnapshotTableAsync(SnapshotTableRequest request, CancellationToken cancellationToken)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
request | SnapshotTableRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSnapshotSnapshotTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
SnapshotTableRequest request = new SnapshotTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
ClusterAsClusterName = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]"),
SnapshotId = "",
Ttl = new Duration(),
Description = "",
};
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = await bigtableTableAdminClient.SnapshotTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceSnapshotTableAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTableAsync(TableName, ClusterName, string, string, CallSettings)
public virtual Task<Operation<Snapshot, SnapshotTableMetadata>> SnapshotTableAsync(TableName name, ClusterName cluster, string snapshotId, string description, CallSettings callSettings = null)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table to have the snapshot taken.
Values are of the form
|
cluster | ClusterNameRequired. The name of the cluster where the snapshot will be created in.
Values are of the form
|
snapshotId | stringRequired. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., |
description | stringDescription of the snapshot. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSnapshotSnapshotTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ClusterName cluster = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string snapshotId = "";
string description = "";
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = await bigtableTableAdminClient.SnapshotTableAsync(name, cluster, snapshotId, description);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceSnapshotTableAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTableAsync(TableName, ClusterName, string, string, CancellationToken)
public virtual Task<Operation<Snapshot, SnapshotTableMetadata>> SnapshotTableAsync(TableName name, ClusterName cluster, string snapshotId, string description, CancellationToken cancellationToken)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table to have the snapshot taken.
Values are of the form
|
cluster | ClusterNameRequired. The name of the cluster where the snapshot will be created in.
Values are of the form
|
snapshotId | stringRequired. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., |
description | stringDescription of the snapshot. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSnapshotSnapshotTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ClusterName cluster = ClusterName.FromProjectInstanceCluster("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
string snapshotId = "";
string description = "";
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = await bigtableTableAdminClient.SnapshotTableAsync(name, cluster, snapshotId, description);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceSnapshotTableAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTableAsync(string, string, string, string, CallSettings)
public virtual Task<Operation<Snapshot, SnapshotTableMetadata>> SnapshotTableAsync(string name, string cluster, string snapshotId, string description, CallSettings callSettings = null)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table to have the snapshot taken.
Values are of the form
|
cluster | stringRequired. The name of the cluster where the snapshot will be created in.
Values are of the form
|
snapshotId | stringRequired. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., |
description | stringDescription of the snapshot. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSnapshotSnapshotTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string cluster = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string snapshotId = "";
string description = "";
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = await bigtableTableAdminClient.SnapshotTableAsync(name, cluster, snapshotId, description);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceSnapshotTableAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
SnapshotTableAsync(string, string, string, string, CancellationToken)
public virtual Task<Operation<Snapshot, SnapshotTableMetadata>> SnapshotTableAsync(string name, string cluster, string snapshotId, string description, CancellationToken cancellationToken)Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table to have the snapshot taken.
Values are of the form
|
cluster | stringRequired. The name of the cluster where the snapshot will be created in.
Values are of the form
|
snapshotId | stringRequired. The ID by which the new snapshot should be referred to within the
parent cluster, e.g., |
description | stringDescription of the snapshot. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSnapshotSnapshotTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string cluster = "projects/[PROJECT]/instances/[INSTANCE]/clusters/[CLUSTER]";
string snapshotId = "";
string description = "";
// Make the request
Operation<Snapshot, SnapshotTableMetadata> response = await bigtableTableAdminClient.SnapshotTableAsync(name, cluster, snapshotId, description);
// Poll until the returned long-running operation is complete
Operation<Snapshot, SnapshotTableMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Snapshot 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<Snapshot, SnapshotTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceSnapshotTableAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Snapshot retrievedResult = retrievedResponse.Result;
}
TestIamPermissions(IResourceName, IEnumerable<string>, CallSettings)
public virtual TestIamPermissionsResponse TestIamPermissions(IResourceName resource, IEnumerable<string> permissions, CallSettings callSettings = null)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
resource | IResourceNameREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | IEnumerablestringThe set of permissions to check for the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = bigtableTableAdminClient.TestIamPermissions(resource, permissions);
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = bigtableTableAdminClient.TestIamPermissions(request);
TestIamPermissions(string, IEnumerable<string>, CallSettings)
public virtual TestIamPermissionsResponse TestIamPermissions(string resource, IEnumerable<string> permissions, CallSettings callSettings = null)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
resource | stringREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | IEnumerablestringThe set of permissions to check for the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = bigtableTableAdminClient.TestIamPermissions(resource, permissions);
TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CallSettings)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(IResourceName resource, IEnumerable<string> permissions, CallSettings callSettings = null)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
resource | IResourceNameREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | IEnumerablestringThe set of permissions to check for the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableTableAdminClient.TestIamPermissionsAsync(resource, permissions);
TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(IResourceName resource, IEnumerable<string> permissions, CancellationToken cancellationToken)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
resource | IResourceNameREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | IEnumerablestringThe set of permissions to check for the |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableTableAdminClient.TestIamPermissionsAsync(resource, permissions);
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await bigtableTableAdminClient.TestIamPermissionsAsync(request);
TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CancellationToken cancellationToken)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await bigtableTableAdminClient.TestIamPermissionsAsync(request);
TestIamPermissionsAsync(string, IEnumerable<string>, CallSettings)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(string resource, IEnumerable<string> permissions, CallSettings callSettings = null)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
resource | stringREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | IEnumerablestringThe set of permissions to check for the |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableTableAdminClient.TestIamPermissionsAsync(resource, permissions);
TestIamPermissionsAsync(string, IEnumerable<string>, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(string resource, IEnumerable<string> permissions, CancellationToken cancellationToken)Returns permissions that the caller has on the specified Table or Backup resource.
| Parameters | |
|---|---|
| Name | Description |
resource | stringREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | IEnumerablestringThe set of permissions to check for the |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
IEnumerable<string> permissions = new string[] { "", };
// Make the request
TestIamPermissionsResponse response = await bigtableTableAdminClient.TestIamPermissionsAsync(resource, permissions);
UndeleteTable(UndeleteTableRequest, CallSettings)
public virtual Operation<Table, UndeleteTableMetadata> UndeleteTable(UndeleteTableRequest request, CallSettings callSettings = null)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableUndeleteTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
UndeleteTableRequest request = new UndeleteTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
Operation<Table, UndeleteTableMetadata> response = bigtableTableAdminClient.UndeleteTable(request);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceUndeleteTable(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;
}
UndeleteTable(TableName, CallSettings)
public virtual Operation<Table, UndeleteTableMetadata> UndeleteTable(TableName name, CallSettings callSettings = null)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table to be restored.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableUndeleteTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
Operation<Table, UndeleteTableMetadata> response = bigtableTableAdminClient.UndeleteTable(name);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceUndeleteTable(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;
}
UndeleteTable(string, CallSettings)
public virtual Operation<Table, UndeleteTableMetadata> UndeleteTable(string name, CallSettings callSettings = null)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table to be restored.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableUndeleteTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
Operation<Table, UndeleteTableMetadata> response = bigtableTableAdminClient.UndeleteTable(name);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceUndeleteTable(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;
}
UndeleteTableAsync(UndeleteTableRequest, CallSettings)
public virtual Task<Operation<Table, UndeleteTableMetadata>> UndeleteTableAsync(UndeleteTableRequest request, CallSettings callSettings = null)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUndeleteTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UndeleteTableRequest request = new UndeleteTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
Operation<Table, UndeleteTableMetadata> response = await bigtableTableAdminClient.UndeleteTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUndeleteTableAsync(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;
}
UndeleteTableAsync(UndeleteTableRequest, CancellationToken)
public virtual Task<Operation<Table, UndeleteTableMetadata>> UndeleteTableAsync(UndeleteTableRequest request, CancellationToken cancellationToken)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteTableRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUndeleteTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UndeleteTableRequest request = new UndeleteTableRequest
{
TableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request
Operation<Table, UndeleteTableMetadata> response = await bigtableTableAdminClient.UndeleteTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUndeleteTableAsync(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;
}
UndeleteTableAsync(TableName, CallSettings)
public virtual Task<Operation<Table, UndeleteTableMetadata>> UndeleteTableAsync(TableName name, CallSettings callSettings = null)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table to be restored.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUndeleteTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
Operation<Table, UndeleteTableMetadata> response = await bigtableTableAdminClient.UndeleteTableAsync(name);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUndeleteTableAsync(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;
}
UndeleteTableAsync(TableName, CancellationToken)
public virtual Task<Operation<Table, UndeleteTableMetadata>> UndeleteTableAsync(TableName name, CancellationToken cancellationToken)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
name | TableNameRequired. The unique name of the table to be restored.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUndeleteTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
TableName name = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request
Operation<Table, UndeleteTableMetadata> response = await bigtableTableAdminClient.UndeleteTableAsync(name);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUndeleteTableAsync(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;
}
UndeleteTableAsync(string, CallSettings)
public virtual Task<Operation<Table, UndeleteTableMetadata>> UndeleteTableAsync(string name, CallSettings callSettings = null)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table to be restored.
Values are of the form
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUndeleteTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
Operation<Table, UndeleteTableMetadata> response = await bigtableTableAdminClient.UndeleteTableAsync(name);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUndeleteTableAsync(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;
}
UndeleteTableAsync(string, CancellationToken)
public virtual Task<Operation<Table, UndeleteTableMetadata>> UndeleteTableAsync(string name, CancellationToken cancellationToken)Restores a specified table which was accidentally deleted.
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The unique name of the table to be restored.
Values are of the form
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUndeleteTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request
Operation<Table, UndeleteTableMetadata> response = await bigtableTableAdminClient.UndeleteTableAsync(name);
// Poll until the returned long-running operation is complete
Operation<Table, UndeleteTableMetadata> 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, UndeleteTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUndeleteTableAsync(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;
}
UpdateAuthorizedView(AuthorizedView, FieldMask, CallSettings)
public virtual Operation<AuthorizedView, UpdateAuthorizedViewMetadata> UpdateAuthorizedView(AuthorizedView authorizedView, FieldMask updateMask, CallSettings callSettings = null)Updates an AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
authorizedView | AuthorizedViewRequired. The AuthorizedView to update. The |
updateMask | FieldMaskOptional. The list of fields to update.
A mask specifying which fields in the AuthorizedView resource should be
updated. This mask is relative to the AuthorizedView resource, not to the
request message. A field will be overwritten if it is in the mask. If
empty, all fields set in the request will be overwritten. A special value
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAuthorizedViewUpdateAuthorizedViewMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
AuthorizedView authorizedView = new AuthorizedView();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> response = bigtableTableAdminClient.UpdateAuthorizedView(authorizedView, updateMask);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, UpdateAuthorizedViewMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceUpdateAuthorizedView(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
UpdateAuthorizedView(UpdateAuthorizedViewRequest, CallSettings)
public virtual Operation<AuthorizedView, UpdateAuthorizedViewMetadata> UpdateAuthorizedView(UpdateAuthorizedViewRequest request, CallSettings callSettings = null)Updates an AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAuthorizedViewUpdateAuthorizedViewMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
UpdateAuthorizedViewRequest request = new UpdateAuthorizedViewRequest
{
AuthorizedView = new AuthorizedView(),
UpdateMask = new FieldMask(),
IgnoreWarnings = false,
};
// Make the request
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> response = bigtableTableAdminClient.UpdateAuthorizedView(request);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, UpdateAuthorizedViewMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceUpdateAuthorizedView(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
UpdateAuthorizedViewAsync(AuthorizedView, FieldMask, CallSettings)
public virtual Task<Operation<AuthorizedView, UpdateAuthorizedViewMetadata>> UpdateAuthorizedViewAsync(AuthorizedView authorizedView, FieldMask updateMask, CallSettings callSettings = null)Updates an AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
authorizedView | AuthorizedViewRequired. The AuthorizedView to update. The |
updateMask | FieldMaskOptional. The list of fields to update.
A mask specifying which fields in the AuthorizedView resource should be
updated. This mask is relative to the AuthorizedView resource, not to the
request message. A field will be overwritten if it is in the mask. If
empty, all fields set in the request will be overwritten. A special value
|
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewUpdateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
AuthorizedView authorizedView = new AuthorizedView();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> response = await bigtableTableAdminClient.UpdateAuthorizedViewAsync(authorizedView, updateMask);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, UpdateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
UpdateAuthorizedViewAsync(AuthorizedView, FieldMask, CancellationToken)
public virtual Task<Operation<AuthorizedView, UpdateAuthorizedViewMetadata>> UpdateAuthorizedViewAsync(AuthorizedView authorizedView, FieldMask updateMask, CancellationToken cancellationToken)Updates an AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
authorizedView | AuthorizedViewRequired. The AuthorizedView to update. The |
updateMask | FieldMaskOptional. The list of fields to update.
A mask specifying which fields in the AuthorizedView resource should be
updated. This mask is relative to the AuthorizedView resource, not to the
request message. A field will be overwritten if it is in the mask. If
empty, all fields set in the request will be overwritten. A special value
|
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewUpdateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
AuthorizedView authorizedView = new AuthorizedView();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> response = await bigtableTableAdminClient.UpdateAuthorizedViewAsync(authorizedView, updateMask);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, UpdateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
UpdateAuthorizedViewAsync(UpdateAuthorizedViewRequest, CallSettings)
public virtual Task<Operation<AuthorizedView, UpdateAuthorizedViewMetadata>> UpdateAuthorizedViewAsync(UpdateAuthorizedViewRequest request, CallSettings callSettings = null)Updates an AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewUpdateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateAuthorizedViewRequest request = new UpdateAuthorizedViewRequest
{
AuthorizedView = new AuthorizedView(),
UpdateMask = new FieldMask(),
IgnoreWarnings = false,
};
// Make the request
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> response = await bigtableTableAdminClient.UpdateAuthorizedViewAsync(request);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, UpdateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
UpdateAuthorizedViewAsync(UpdateAuthorizedViewRequest, CancellationToken)
public virtual Task<Operation<AuthorizedView, UpdateAuthorizedViewMetadata>> UpdateAuthorizedViewAsync(UpdateAuthorizedViewRequest request, CancellationToken cancellationToken)Updates an AuthorizedView in a table.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAuthorizedViewRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAuthorizedViewUpdateAuthorizedViewMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateAuthorizedViewRequest request = new UpdateAuthorizedViewRequest
{
AuthorizedView = new AuthorizedView(),
UpdateMask = new FieldMask(),
IgnoreWarnings = false,
};
// Make the request
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> response = await bigtableTableAdminClient.UpdateAuthorizedViewAsync(request);
// Poll until the returned long-running operation is complete
Operation<AuthorizedView, UpdateAuthorizedViewMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AuthorizedView 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<AuthorizedView, UpdateAuthorizedViewMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateAuthorizedViewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
AuthorizedView retrievedResult = retrievedResponse.Result;
}
UpdateBackup(Backup, FieldMask, CallSettings)
public virtual Backup UpdateBackup(Backup backup, FieldMask updateMask, CallSettings callSettings = null)Updates a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
backup | BackupRequired. The backup to update.
|
updateMask | FieldMaskRequired. A mask specifying which fields (e.g. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
Backup backup = new Backup();
FieldMask updateMask = new FieldMask();
// Make the request
Backup response = bigtableTableAdminClient.UpdateBackup(backup, updateMask);
UpdateBackup(UpdateBackupRequest, CallSettings)
public virtual Backup UpdateBackup(UpdateBackupRequest request, CallSettings callSettings = null)Updates a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
UpdateBackupRequest request = new UpdateBackupRequest
{
Backup = new Backup(),
UpdateMask = new FieldMask(),
};
// Make the request
Backup response = bigtableTableAdminClient.UpdateBackup(request);
UpdateBackupAsync(Backup, FieldMask, CallSettings)
public virtual Task<Backup> UpdateBackupAsync(Backup backup, FieldMask updateMask, CallSettings callSettings = null)Updates a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
backup | BackupRequired. The backup to update.
|
updateMask | FieldMaskRequired. A mask specifying which fields (e.g. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
Backup backup = new Backup();
FieldMask updateMask = new FieldMask();
// Make the request
Backup response = await bigtableTableAdminClient.UpdateBackupAsync(backup, updateMask);
UpdateBackupAsync(Backup, FieldMask, CancellationToken)
public virtual Task<Backup> UpdateBackupAsync(Backup backup, FieldMask updateMask, CancellationToken cancellationToken)Updates a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
backup | BackupRequired. The backup to update.
|
updateMask | FieldMaskRequired. A mask specifying which fields (e.g. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
Backup backup = new Backup();
FieldMask updateMask = new FieldMask();
// Make the request
Backup response = await bigtableTableAdminClient.UpdateBackupAsync(backup, updateMask);
UpdateBackupAsync(UpdateBackupRequest, CallSettings)
public virtual Task<Backup> UpdateBackupAsync(UpdateBackupRequest request, CallSettings callSettings = null)Updates a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateBackupRequest request = new UpdateBackupRequest
{
Backup = new Backup(),
UpdateMask = new FieldMask(),
};
// Make the request
Backup response = await bigtableTableAdminClient.UpdateBackupAsync(request);
UpdateBackupAsync(UpdateBackupRequest, CancellationToken)
public virtual Task<Backup> UpdateBackupAsync(UpdateBackupRequest request, CancellationToken cancellationToken)Updates a pending or completed Cloud Bigtable Backup.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateBackupRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateBackupRequest request = new UpdateBackupRequest
{
Backup = new Backup(),
UpdateMask = new FieldMask(),
};
// Make the request
Backup response = await bigtableTableAdminClient.UpdateBackupAsync(request);
UpdateTable(Table, FieldMask, CallSettings)
public virtual Operation<Table, UpdateTableMetadata> UpdateTable(Table table, FieldMask updateMask, CallSettings callSettings = null)Updates a specified table.
| Parameters | |
|---|---|
| Name | Description |
table | TableRequired. The table to update.
The table's |
updateMask | FieldMaskRequired. The list of fields to update.
A mask specifying which fields (e.g.
If |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableUpdateTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
Table table = new Table();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Table, UpdateTableMetadata> response = bigtableTableAdminClient.UpdateTable(table, updateMask);
// Poll until the returned long-running operation is complete
Operation<Table, UpdateTableMetadata> 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, UpdateTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceUpdateTable(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;
}
UpdateTable(UpdateTableRequest, CallSettings)
public virtual Operation<Table, UpdateTableMetadata> UpdateTable(UpdateTableRequest request, CallSettings callSettings = null)Updates a specified table.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationTableUpdateTableMetadata | The RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// Initialize request argument(s)
UpdateTableRequest request = new UpdateTableRequest
{
Table = new Table(),
UpdateMask = new FieldMask(),
};
// Make the request
Operation<Table, UpdateTableMetadata> response = bigtableTableAdminClient.UpdateTable(request);
// Poll until the returned long-running operation is complete
Operation<Table, UpdateTableMetadata> 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, UpdateTableMetadata> retrievedResponse = bigtableTableAdminClient.PollOnceUpdateTable(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;
}
UpdateTableAsync(Table, FieldMask, CallSettings)
public virtual Task<Operation<Table, UpdateTableMetadata>> UpdateTableAsync(Table table, FieldMask updateMask, CallSettings callSettings = null)Updates a specified table.
| Parameters | |
|---|---|
| Name | Description |
table | TableRequired. The table to update.
The table's |
updateMask | FieldMaskRequired. The list of fields to update.
A mask specifying which fields (e.g.
If |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUpdateTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
Table table = new Table();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Table, UpdateTableMetadata> response = await bigtableTableAdminClient.UpdateTableAsync(table, updateMask);
// Poll until the returned long-running operation is complete
Operation<Table, UpdateTableMetadata> 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, UpdateTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateTableAsync(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;
}
UpdateTableAsync(Table, FieldMask, CancellationToken)
public virtual Task<Operation<Table, UpdateTableMetadata>> UpdateTableAsync(Table table, FieldMask updateMask, CancellationToken cancellationToken)Updates a specified table.
| Parameters | |
|---|---|
| Name | Description |
table | TableRequired. The table to update.
The table's |
updateMask | FieldMaskRequired. The list of fields to update.
A mask specifying which fields (e.g.
If |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUpdateTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
Table table = new Table();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Table, UpdateTableMetadata> response = await bigtableTableAdminClient.UpdateTableAsync(table, updateMask);
// Poll until the returned long-running operation is complete
Operation<Table, UpdateTableMetadata> 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, UpdateTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateTableAsync(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;
}
UpdateTableAsync(UpdateTableRequest, CallSettings)
public virtual Task<Operation<Table, UpdateTableMetadata>> UpdateTableAsync(UpdateTableRequest request, CallSettings callSettings = null)Updates a specified table.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateTableRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUpdateTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateTableRequest request = new UpdateTableRequest
{
Table = new Table(),
UpdateMask = new FieldMask(),
};
// Make the request
Operation<Table, UpdateTableMetadata> response = await bigtableTableAdminClient.UpdateTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Table, UpdateTableMetadata> 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, UpdateTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateTableAsync(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;
}
UpdateTableAsync(UpdateTableRequest, CancellationToken)
public virtual Task<Operation<Table, UpdateTableMetadata>> UpdateTableAsync(UpdateTableRequest request, CancellationToken cancellationToken)Updates a specified table.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateTableRequestThe request object containing all of the parameters for the API call. |
cancellationToken | CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationTableUpdateTableMetadata | A Task containing the RPC response. |
// Create client
BigtableTableAdminClient bigtableTableAdminClient = await BigtableTableAdminClient.CreateAsync();
// Initialize request argument(s)
UpdateTableRequest request = new UpdateTableRequest
{
Table = new Table(),
UpdateMask = new FieldMask(),
};
// Make the request
Operation<Table, UpdateTableMetadata> response = await bigtableTableAdminClient.UpdateTableAsync(request);
// Poll until the returned long-running operation is complete
Operation<Table, UpdateTableMetadata> 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, UpdateTableMetadata> retrievedResponse = await bigtableTableAdminClient.PollOnceUpdateTableAsync(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;
}