Google Cloud Spanner Database Administration v1 API - Class DatabaseAdminClient (4.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public abstract class DatabaseAdminClient

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class DatabaseAdminClient.

DatabaseAdmin client wrapper, for convenient use.

Inheritance

Object > DatabaseAdminClient

Derived Types

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Remarks

Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to:

  • create, drop, and list databases
  • update the schema of pre-existing databases
  • create, delete and list backups for a database
  • restore a database from an existing backup

Properties

CopyBackupOperationsClient

public virtual OperationsClient CopyBackupOperationsClient { get; }

The long-running operations client for CopyBackup.

Property Value
TypeDescription
OperationsClient

CreateBackupOperationsClient

public virtual OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value
TypeDescription
OperationsClient

CreateDatabaseOperationsClient

public virtual OperationsClient CreateDatabaseOperationsClient { get; }

The long-running operations client for CreateDatabase.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DatabaseAdmin scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

GrpcClient

public virtual DatabaseAdmin.DatabaseAdminClient GrpcClient { get; }

The underlying gRPC DatabaseAdmin client

Property Value
TypeDescription
DatabaseAdmin.DatabaseAdminClient

RestoreDatabaseOperationsClient

public virtual OperationsClient RestoreDatabaseOperationsClient { get; }

The long-running operations client for RestoreDatabase.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UpdateDatabaseDdlOperationsClient

public virtual OperationsClient UpdateDatabaseDdlOperationsClient { get; }

The long-running operations client for UpdateDatabaseDdl.

Property Value
TypeDescription
OperationsClient

Methods

CopyBackup(CopyBackupRequest, CallSettings)

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

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
requestCopyBackupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Backup, CopyBackupMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
CopyBackupRequest request = new CopyBackupRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    BackupId = "",
    SourceBackupAsBackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
    ExpireTime = new Timestamp(),
    EncryptionConfig = new CopyBackupEncryptionConfig(),
};
// Make the request
Operation<Backup, CopyBackupMetadata> response = databaseAdminClient.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 = databaseAdminClient.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(InstanceName, String, BackupName, Timestamp, CallSettings)

public virtual Operation<Backup, CopyBackupMetadata> CopyBackup(InstanceName parent, string backupId, BackupName sourceBackup, Timestamp expireTime, CallSettings callSettings = null)

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects/&lt;project>/instances/&lt;instance>.

backupIdString

Required. The id of the backup copy. The backup_id appended to parent forms the full backup_uri of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

sourceBackupBackupName

Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. 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: projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

expireTimeTimestamp

Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Backup, CopyBackupMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string backupId = "";
BackupName sourceBackup = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = databaseAdminClient.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 = databaseAdminClient.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)

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
parentString

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects/&lt;project>/instances/&lt;instance>.

backupIdString

Required. The id of the backup copy. The backup_id appended to parent forms the full backup_uri of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

sourceBackupString

Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. 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: projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

expireTimeTimestamp

Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Backup, CopyBackupMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string backupId = "";
string sourceBackup = "projects/[PROJECT]/instances/[INSTANCE]/backups/[BACKUP]";
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = databaseAdminClient.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 = databaseAdminClient.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(CopyBackupRequest, CallSettings)

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

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
requestCopyBackupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Backup, CopyBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CopyBackupRequest request = new CopyBackupRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    BackupId = "",
    SourceBackupAsBackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
    ExpireTime = new Timestamp(),
    EncryptionConfig = new CopyBackupEncryptionConfig(),
};
// Make the request
Operation<Backup, CopyBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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)

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
requestCopyBackupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Backup, CopyBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CopyBackupRequest request = new CopyBackupRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    BackupId = "",
    SourceBackupAsBackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
    ExpireTime = new Timestamp(),
    EncryptionConfig = new CopyBackupEncryptionConfig(),
};
// Make the request
Operation<Backup, CopyBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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(InstanceName, String, BackupName, Timestamp, CallSettings)

public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(InstanceName parent, string backupId, BackupName sourceBackup, Timestamp expireTime, CallSettings callSettings = null)

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects/&lt;project>/instances/&lt;instance>.

backupIdString

Required. The id of the backup copy. The backup_id appended to parent forms the full backup_uri of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

sourceBackupBackupName

Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. 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: projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

expireTimeTimestamp

Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Backup, CopyBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string backupId = "";
BackupName sourceBackup = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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(InstanceName, String, BackupName, Timestamp, CancellationToken)

public virtual Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(InstanceName parent, string backupId, BackupName sourceBackup, Timestamp expireTime, CancellationToken cancellationToken)

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects/&lt;project>/instances/&lt;instance>.

backupIdString

Required. The id of the backup copy. The backup_id appended to parent forms the full backup_uri of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

sourceBackupBackupName

Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. 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: projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

expireTimeTimestamp

Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Backup, CopyBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string backupId = "";
BackupName sourceBackup = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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)

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
parentString

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects/&lt;project>/instances/&lt;instance>.

backupIdString

Required. The id of the backup copy. The backup_id appended to parent forms the full backup_uri of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

sourceBackupString

Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. 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: projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

expireTimeTimestamp

Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Backup, CopyBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string backupId = "";
string sourceBackup = "projects/[PROJECT]/instances/[INSTANCE]/backups/[BACKUP]";
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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)

Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
NameDescription
parentString

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects/&lt;project>/instances/&lt;instance>.

backupIdString

Required. The id of the backup copy. The backup_id appended to parent forms the full backup_uri of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

sourceBackupString

Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. 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: projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

expireTimeTimestamp

Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Backup, CopyBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string backupId = "";
string sourceBackup = "projects/[PROJECT]/instances/[INSTANCE]/backups/[BACKUP]";
Timestamp expireTime = new Timestamp();
// Make the request
Operation<Backup, CopyBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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 DatabaseAdminClient Create()

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

Returns
TypeDescription
DatabaseAdminClient

The created DatabaseAdminClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<DatabaseAdminClient>

The task representing the created DatabaseAdminClient.

CreateBackup(CreateBackupRequest, CallSettings)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
requestCreateBackupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Backup, CreateBackupMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    BackupId = "",
    Backup = new Backup(),
    EncryptionConfig = new CreateBackupEncryptionConfig(),
};
// Make the request
Operation<Backup, CreateBackupMetadata> response = databaseAdminClient.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 = databaseAdminClient.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(InstanceName, Backup, String, CallSettings)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/&lt;project>/instances/&lt;instance>.

backupBackup

Required. The backup to create.

backupIdString

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup_id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Backup, CreateBackupMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, CreateBackupMetadata> response = databaseAdminClient.CreateBackup(parent, backup, backupId);

// 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 = databaseAdminClient.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, Backup, String, CallSettings)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
parentString

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/&lt;project>/instances/&lt;instance>.

backupBackup

Required. The backup to create.

backupIdString

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup_id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Backup, CreateBackupMetadata>

The RPC response.

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

// 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 = databaseAdminClient.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(CreateBackupRequest, CallSettings)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
requestCreateBackupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Backup, CreateBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    BackupId = "",
    Backup = new Backup(),
    EncryptionConfig = new CreateBackupEncryptionConfig(),
};
// Make the request
Operation<Backup, CreateBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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 Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
requestCreateBackupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Backup, CreateBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    BackupId = "",
    Backup = new Backup(),
    EncryptionConfig = new CreateBackupEncryptionConfig(),
};
// Make the request
Operation<Backup, CreateBackupMetadata> response = await databaseAdminClient.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 databaseAdminClient.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(InstanceName, Backup, String, CallSettings)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/&lt;project>/instances/&lt;instance>.

backupBackup

Required. The backup to create.

backupIdString

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup_id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Backup, CreateBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, CreateBackupMetadata> response = await databaseAdminClient.CreateBackupAsync(parent, backup, backupId);

// 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 databaseAdminClient.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(InstanceName, Backup, String, CancellationToken)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/&lt;project>/instances/&lt;instance>.

backupBackup

Required. The backup to create.

backupIdString

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup_id>.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Backup, CreateBackupMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, CreateBackupMetadata> response = await databaseAdminClient.CreateBackupAsync(parent, backup, backupId);

// 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 databaseAdminClient.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, Backup, String, CallSettings)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
parentString

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/&lt;project>/instances/&lt;instance>.

backupBackup

Required. The backup to create.

backupIdString

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup_id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Backup, CreateBackupMetadata>>

A Task containing the RPC response.

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

// 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 databaseAdminClient.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, Backup, String, CancellationToken)

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

Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Parameters
NameDescription
parentString

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/&lt;project>/instances/&lt;instance>.

backupBackup

Required. The backup to create.

backupIdString

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup_id>.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Backup, CreateBackupMetadata>>

A Task containing the RPC response.

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

// 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 databaseAdminClient.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;
}

CreateDatabase(CreateDatabaseRequest, CallSettings)

public virtual Operation<Database, CreateDatabaseMetadata> CreateDatabase(CreateDatabaseRequest request, CallSettings callSettings = null)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
requestCreateDatabaseRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Database, CreateDatabaseMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
CreateDatabaseRequest request = new CreateDatabaseRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    CreateStatement = "",
    ExtraStatements = { "", },
    EncryptionConfig = new EncryptionConfig(),
    DatabaseDialect = DatabaseDialect.Unspecified,
};
// Make the request
Operation<Database, CreateDatabaseMetadata> response = databaseAdminClient.CreateDatabase(request);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = databaseAdminClient.PollOnceCreateDatabase(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabase(InstanceName, String, CallSettings)

public virtual Operation<Database, CreateDatabaseMetadata> CreateDatabase(InstanceName parent, string createStatement, CallSettings callSettings = null)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance that will serve the new database. Values are of the form projects/&lt;project>/instances/&lt;instance>.

createStatementString

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (` ).

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Database, CreateDatabaseMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string createStatement = "";
// Make the request
Operation<Database, CreateDatabaseMetadata> response = databaseAdminClient.CreateDatabase(parent, createStatement);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = databaseAdminClient.PollOnceCreateDatabase(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabase(String, String, CallSettings)

public virtual Operation<Database, CreateDatabaseMetadata> CreateDatabase(string parent, string createStatement, CallSettings callSettings = null)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
parentString

Required. The name of the instance that will serve the new database. Values are of the form projects/&lt;project>/instances/&lt;instance>.

createStatementString

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (` ).

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Database, CreateDatabaseMetadata>

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string createStatement = "";
// Make the request
Operation<Database, CreateDatabaseMetadata> response = databaseAdminClient.CreateDatabase(parent, createStatement);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = databaseAdminClient.PollOnceCreateDatabase(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabaseAsync(CreateDatabaseRequest, CallSettings)

public virtual Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(CreateDatabaseRequest request, CallSettings callSettings = null)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
requestCreateDatabaseRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Database, CreateDatabaseMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CreateDatabaseRequest request = new CreateDatabaseRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    CreateStatement = "",
    ExtraStatements = { "", },
    EncryptionConfig = new EncryptionConfig(),
    DatabaseDialect = DatabaseDialect.Unspecified,
};
// Make the request
Operation<Database, CreateDatabaseMetadata> response = await databaseAdminClient.CreateDatabaseAsync(request);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceCreateDatabaseAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabaseAsync(CreateDatabaseRequest, CancellationToken)

public virtual Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(CreateDatabaseRequest request, CancellationToken cancellationToken)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
requestCreateDatabaseRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Database, CreateDatabaseMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CreateDatabaseRequest request = new CreateDatabaseRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    CreateStatement = "",
    ExtraStatements = { "", },
    EncryptionConfig = new EncryptionConfig(),
    DatabaseDialect = DatabaseDialect.Unspecified,
};
// Make the request
Operation<Database, CreateDatabaseMetadata> response = await databaseAdminClient.CreateDatabaseAsync(request);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceCreateDatabaseAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabaseAsync(InstanceName, String, CallSettings)

public virtual Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(InstanceName parent, string createStatement, CallSettings callSettings = null)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance that will serve the new database. Values are of the form projects/&lt;project>/instances/&lt;instance>.

createStatementString

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (` ).

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Database, CreateDatabaseMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string createStatement = "";
// Make the request
Operation<Database, CreateDatabaseMetadata> response = await databaseAdminClient.CreateDatabaseAsync(parent, createStatement);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceCreateDatabaseAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabaseAsync(InstanceName, String, CancellationToken)

public virtual Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(InstanceName parent, string createStatement, CancellationToken cancellationToken)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
parentGoogle.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance that will serve the new database. Values are of the form projects/&lt;project>/instances/&lt;instance>.

createStatementString

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (` ).

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Database, CreateDatabaseMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string createStatement = "";
// Make the request
Operation<Database, CreateDatabaseMetadata> response = await databaseAdminClient.CreateDatabaseAsync(parent, createStatement);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceCreateDatabaseAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabaseAsync(String, String, CallSettings)

public virtual Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(string parent, string createStatement, CallSettings callSettings = null)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
parentString

Required. The name of the instance that will serve the new database. Values are of the form projects/&lt;project>/instances/&lt;instance>.

createStatementString

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (` ).

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Database, CreateDatabaseMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string createStatement = "";
// Make the request
Operation<Database, CreateDatabaseMetadata> response = await databaseAdminClient.CreateDatabaseAsync(parent, createStatement);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceCreateDatabaseAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

CreateDatabaseAsync(String, String, CancellationToken)

public virtual Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(string parent, string createStatement, CancellationToken cancellationToken)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
NameDescription
parentString

Required. The name of the instance that will serve the new database. Values are of the form projects/&lt;project>/instances/&lt;instance>.

createStatementString

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (` ).

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Database, CreateDatabaseMetadata>>

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string createStatement = "";
// Make the request
Operation<Database, CreateDatabaseMetadata> response = await databaseAdminClient.CreateDatabaseAsync(parent, createStatement);

// Poll until the returned long-running operation is complete
Operation<Database, CreateDatabaseMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Database 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<Database, CreateDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceCreateDatabaseAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Database retrievedResult = retrievedResponse.Result;
}

DeleteBackup(BackupName, CallSettings)

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

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
nameBackupName

Required. Name of the backup to delete. Values are of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
// Make the request
databaseAdminClient.DeleteBackup(name);

DeleteBackup(DeleteBackupRequest, CallSettings)

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

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
requestDeleteBackupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
};
// Make the request
databaseAdminClient.DeleteBackup(request);

DeleteBackup(String, CallSettings)

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

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
nameString

Required. Name of the backup to delete. Values are of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/backups/[BACKUP]";
// Make the request
databaseAdminClient.DeleteBackup(name);

DeleteBackupAsync(BackupName, CallSettings)

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

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
nameBackupName

Required. Name of the backup to delete. Values are of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
// Make the request
await databaseAdminClient.DeleteBackupAsync(name);

DeleteBackupAsync(BackupName, CancellationToken)

public virtual Task DeleteBackupAsync(BackupName name, CancellationToken cancellationToken)

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
nameBackupName

Required. Name of the backup to delete. Values are of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
// Make the request
await databaseAdminClient.DeleteBackupAsync(name);

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

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

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
requestDeleteBackupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
};
// Make the request
await databaseAdminClient.DeleteBackupAsync(request);

DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

public virtual Task DeleteBackupAsync(DeleteBackupRequest request, CancellationToken cancellationToken)

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
requestDeleteBackupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
};
// Make the request
await databaseAdminClient.DeleteBackupAsync(request);

DeleteBackupAsync(String, CallSettings)

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

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
nameString

Required. Name of the backup to delete. Values are of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

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

DeleteBackupAsync(String, CancellationToken)

public virtual Task DeleteBackupAsync(string name, CancellationToken cancellationToken)

Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
nameString

Required. Name of the backup to delete. Values are of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

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

DropDatabase(DropDatabaseRequest, CallSettings)

public virtual void DropDatabase(DropDatabaseRequest request, CallSettings callSettings = null)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
requestDropDatabaseRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
DropDatabaseRequest request = new DropDatabaseRequest
{
    DatabaseAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
};
// Make the request
databaseAdminClient.DropDatabase(request);

DropDatabase(DatabaseName, CallSettings)

public virtual void DropDatabase(DatabaseName database, CallSettings callSettings = null)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
databaseGoogle.Cloud.Spanner.Common.V1.DatabaseName

Required. The database to be dropped.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
DatabaseName database = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
// Make the request
databaseAdminClient.DropDatabase(database);

DropDatabase(String, CallSettings)

public virtual void DropDatabase(string database, CallSettings callSettings = null)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
databaseString

Required. The database to be dropped.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string database = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
// Make the request
databaseAdminClient.DropDatabase(database);

DropDatabaseAsync(DropDatabaseRequest, CallSettings)

public virtual Task DropDatabaseAsync(DropDatabaseRequest request, CallSettings callSettings = null)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
requestDropDatabaseRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DropDatabaseRequest request = new DropDatabaseRequest
{
    DatabaseAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
};
// Make the request
await databaseAdminClient.DropDatabaseAsync(request);

DropDatabaseAsync(DropDatabaseRequest, CancellationToken)

public virtual Task DropDatabaseAsync(DropDatabaseRequest request, CancellationToken cancellationToken)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
requestDropDatabaseRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DropDatabaseRequest request = new DropDatabaseRequest
{
    DatabaseAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
};
// Make the request
await databaseAdminClient.DropDatabaseAsync(request);

DropDatabaseAsync(DatabaseName, CallSettings)

public virtual Task DropDatabaseAsync(DatabaseName database, CallSettings callSettings = null)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
databaseGoogle.Cloud.Spanner.Common.V1.DatabaseName

Required. The database to be dropped.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DatabaseName database = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
// Make the request
await databaseAdminClient.DropDatabaseAsync(database);

DropDatabaseAsync(DatabaseName, CancellationToken)

public virtual Task DropDatabaseAsync(DatabaseName database, CancellationToken cancellationToken)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
databaseGoogle.Cloud.Spanner.Common.V1.DatabaseName

Required. The database to be dropped.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DatabaseName database = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
// Make the request
await databaseAdminClient.DropDatabaseAsync(database);

DropDatabaseAsync(String, CallSettings)

public virtual Task DropDatabaseAsync(string database, CallSettings callSettings = null)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
databaseString

Required. The database to be dropped.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string database = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
// Make the request
await databaseAdminClient.DropDatabaseAsync(database);

DropDatabaseAsync(String, CancellationToken)

public virtual Task DropDatabaseAsync(string database, CancellationToken cancellationToken)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

Parameters
NameDescription
databaseString

Required. The database to be dropped.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string database = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
// Make the request
await databaseAdminClient.DropDatabaseAsync(database);

GetBackup(BackupName, CallSettings)

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

Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
nameBackupName

Required. Name of the backup. Values are of the form projects/&lt;project>/instances/&lt;instance>/backups/&lt;backup>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Backup

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
// Make the request
Backup response = databaseAdminClient.GetBackup(name);

GetBackup(GetBackupRequest, CallSettings)

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

Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription
requestGetBackupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Backup

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
};
// Make the request
Backup response = databaseAdminClient.GetBackup(request);

GetBackup(String, CallSettings)

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

Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

Parameters
NameDescription