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

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, copy 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
Type Description
OperationsClient

CreateBackupOperationsClient

public virtual OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value
Type Description
OperationsClient

CreateDatabaseOperationsClient

public virtual OperationsClient CreateDatabaseOperationsClient { get; }

The long-running operations client for CreateDatabase.

Property Value
Type Description
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
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DatabaseAdmin scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

GrpcClient

public virtual DatabaseAdmin.DatabaseAdminClient GrpcClient { get; }

The underlying gRPC DatabaseAdmin client

Property Value
Type Description
DatabaseAdminDatabaseAdminClient

RestoreDatabaseOperationsClient

public virtual OperationsClient RestoreDatabaseOperationsClient { get; }

The long-running operations client for RestoreDatabase.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateDatabaseDdlOperationsClient

public virtual OperationsClient UpdateDatabaseDdlOperationsClient { get; }

The long-running operations client for UpdateDatabaseDdl.

Property Value
Type Description
OperationsClient

UpdateDatabaseOperationsClient

public virtual OperationsClient UpdateDatabaseOperationsClient { get; }

The long-running operations client for UpdateDatabase.

Property Value
Type Description
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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
request CopyBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

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

backupId string

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

sourceBackup BackupName

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/<project>/instances/<instance>/backups/<backup>.

expireTime Timestamp

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
parent string

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

backupId string

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

sourceBackup string

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/<project>/instances/<instance>/backups/<backup>.

expireTime Timestamp

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
request CopyBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
request CopyBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

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

backupId string

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

sourceBackup BackupName

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/<project>/instances/<instance>/backups/<backup>.

expireTime Timestamp

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

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

backupId string

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

sourceBackup BackupName

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/<project>/instances/<instance>/backups/<backup>.

expireTime Timestamp

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
parent string

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

backupId string

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

sourceBackup string

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/<project>/instances/<instance>/backups/<backup>.

expireTime Timestamp

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCopyBackupMetadata

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 destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters
Name Description
parent string

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

backupId string

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

sourceBackup string

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/<project>/instances/<instance>/backups/<backup>.

expireTime Timestamp

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupCopyBackupMetadata

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
Type Description
DatabaseAdminClient

The created DatabaseAdminClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDatabaseAdminClient

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
Name Description
request CreateBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCreateBackupMetadata

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
Name Description
parent Google.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/<project>/instances/<instance>.

backup Backup

Required. The backup to create.

backupId string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCreateBackupMetadata

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
Name Description
parent string

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/<project>/instances/<instance>.

backup Backup

Required. The backup to create.

backupId string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCreateBackupMetadata

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
Name Description
request CreateBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCreateBackupMetadata

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
Name Description
request CreateBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupCreateBackupMetadata

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
Name Description
parent Google.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/<project>/instances/<instance>.

backup Backup

Required. The backup to create.

backupId string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCreateBackupMetadata

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
Name Description
parent Google.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/<project>/instances/<instance>.

backup Backup

Required. The backup to create.

backupId string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupCreateBackupMetadata

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
Name Description
parent string

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/<project>/instances/<instance>.

backup Backup

Required. The backup to create.

backupId string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCreateBackupMetadata

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
Name Description
parent string

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/<project>/instances/<instance>.

backup Backup

Required. The backup to create.

backupId string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupCreateBackupMetadata

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;
}

CreateBackupSchedule(CreateBackupScheduleRequest, CallSettings)

public virtual BackupSchedule CreateBackupSchedule(CreateBackupScheduleRequest request, CallSettings callSettings = null)

Creates a new backup schedule.

Parameters
Name Description
request CreateBackupScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupSchedule

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
CreateBackupScheduleRequest request = new CreateBackupScheduleRequest
{
    ParentAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
    BackupScheduleId = "",
    BackupSchedule = new BackupSchedule(),
};
// Make the request
BackupSchedule response = databaseAdminClient.CreateBackupSchedule(request);

CreateBackupSchedule(DatabaseName, BackupSchedule, string, CallSettings)

public virtual BackupSchedule CreateBackupSchedule(DatabaseName parent, BackupSchedule backupSchedule, string backupScheduleId, CallSettings callSettings = null)

Creates a new backup schedule.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The name of the database that this backup schedule applies to.

backupSchedule BackupSchedule

Required. The backup schedule to create.

backupScheduleId string

Required. The Id to use for the backup schedule. The backup_schedule_id appended to parent forms the full backup schedule name of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupSchedule

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
DatabaseName parent = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
BackupSchedule backupSchedule = new BackupSchedule();
string backupScheduleId = "";
// Make the request
BackupSchedule response = databaseAdminClient.CreateBackupSchedule(parent, backupSchedule, backupScheduleId);

CreateBackupSchedule(string, BackupSchedule, string, CallSettings)

public virtual BackupSchedule CreateBackupSchedule(string parent, BackupSchedule backupSchedule, string backupScheduleId, CallSettings callSettings = null)

Creates a new backup schedule.

Parameters
Name Description
parent string

Required. The name of the database that this backup schedule applies to.

backupSchedule BackupSchedule

Required. The backup schedule to create.

backupScheduleId string

Required. The Id to use for the backup schedule. The backup_schedule_id appended to parent forms the full backup schedule name of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupSchedule

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
BackupSchedule backupSchedule = new BackupSchedule();
string backupScheduleId = "";
// Make the request
BackupSchedule response = databaseAdminClient.CreateBackupSchedule(parent, backupSchedule, backupScheduleId);

CreateBackupScheduleAsync(CreateBackupScheduleRequest, CallSettings)

public virtual Task<BackupSchedule> CreateBackupScheduleAsync(CreateBackupScheduleRequest request, CallSettings callSettings = null)

Creates a new backup schedule.

Parameters
Name Description
request CreateBackupScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CreateBackupScheduleRequest request = new CreateBackupScheduleRequest
{
    ParentAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
    BackupScheduleId = "",
    BackupSchedule = new BackupSchedule(),
};
// Make the request
BackupSchedule response = await databaseAdminClient.CreateBackupScheduleAsync(request);

CreateBackupScheduleAsync(CreateBackupScheduleRequest, CancellationToken)

public virtual Task<BackupSchedule> CreateBackupScheduleAsync(CreateBackupScheduleRequest request, CancellationToken cancellationToken)

Creates a new backup schedule.

Parameters
Name Description
request CreateBackupScheduleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
CreateBackupScheduleRequest request = new CreateBackupScheduleRequest
{
    ParentAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
    BackupScheduleId = "",
    BackupSchedule = new BackupSchedule(),
};
// Make the request
BackupSchedule response = await databaseAdminClient.CreateBackupScheduleAsync(request);

CreateBackupScheduleAsync(DatabaseName, BackupSchedule, string, CallSettings)

public virtual Task<BackupSchedule> CreateBackupScheduleAsync(DatabaseName parent, BackupSchedule backupSchedule, string backupScheduleId, CallSettings callSettings = null)

Creates a new backup schedule.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The name of the database that this backup schedule applies to.

backupSchedule BackupSchedule

Required. The backup schedule to create.

backupScheduleId string

Required. The Id to use for the backup schedule. The backup_schedule_id appended to parent forms the full backup schedule name of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DatabaseName parent = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
BackupSchedule backupSchedule = new BackupSchedule();
string backupScheduleId = "";
// Make the request
BackupSchedule response = await databaseAdminClient.CreateBackupScheduleAsync(parent, backupSchedule, backupScheduleId);

CreateBackupScheduleAsync(DatabaseName, BackupSchedule, string, CancellationToken)

public virtual Task<BackupSchedule> CreateBackupScheduleAsync(DatabaseName parent, BackupSchedule backupSchedule, string backupScheduleId, CancellationToken cancellationToken)

Creates a new backup schedule.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The name of the database that this backup schedule applies to.

backupSchedule BackupSchedule

Required. The backup schedule to create.

backupScheduleId string

Required. The Id to use for the backup schedule. The backup_schedule_id appended to parent forms the full backup schedule name of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DatabaseName parent = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
BackupSchedule backupSchedule = new BackupSchedule();
string backupScheduleId = "";
// Make the request
BackupSchedule response = await databaseAdminClient.CreateBackupScheduleAsync(parent, backupSchedule, backupScheduleId);

CreateBackupScheduleAsync(string, BackupSchedule, string, CallSettings)

public virtual Task<BackupSchedule> CreateBackupScheduleAsync(string parent, BackupSchedule backupSchedule, string backupScheduleId, CallSettings callSettings = null)

Creates a new backup schedule.

Parameters
Name Description
parent string

Required. The name of the database that this backup schedule applies to.

backupSchedule BackupSchedule

Required. The backup schedule to create.

backupScheduleId string

Required. The Id to use for the backup schedule. The backup_schedule_id appended to parent forms the full backup schedule name of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
BackupSchedule backupSchedule = new BackupSchedule();
string backupScheduleId = "";
// Make the request
BackupSchedule response = await databaseAdminClient.CreateBackupScheduleAsync(parent, backupSchedule, backupScheduleId);

CreateBackupScheduleAsync(string, BackupSchedule, string, CancellationToken)

public virtual Task<BackupSchedule> CreateBackupScheduleAsync(string parent, BackupSchedule backupSchedule, string backupScheduleId, CancellationToken cancellationToken)

Creates a new backup schedule.

Parameters
Name Description
parent string

Required. The name of the database that this backup schedule applies to.

backupSchedule BackupSchedule

Required. The backup schedule to create.

backupScheduleId string

Required. The Id to use for the backup schedule. The backup_schedule_id appended to parent forms the full backup schedule name of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
BackupSchedule backupSchedule = new BackupSchedule();
string backupScheduleId = "";
// Make the request
BackupSchedule response = await databaseAdminClient.CreateBackupScheduleAsync(parent, backupSchedule, backupScheduleId);

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
Name Description
request CreateDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseCreateDatabaseMetadata

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,
    ProtoDescriptors = ByteString.Empty,
};
// 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
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

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

createStatement string

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 (` ).

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseCreateDatabaseMetadata

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
Name Description
parent string

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

createStatement string

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 (` ).

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseCreateDatabaseMetadata

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
Name Description
request CreateDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseCreateDatabaseMetadata

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,
    ProtoDescriptors = ByteString.Empty,
};
// 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
Name Description
request CreateDatabaseRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatabaseCreateDatabaseMetadata

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,
    ProtoDescriptors = ByteString.Empty,
};
// 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
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

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

createStatement string

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 (` ).

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseCreateDatabaseMetadata

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
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

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

createStatement string

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 (` ).

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatabaseCreateDatabaseMetadata

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
Name Description
parent string

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

createStatement string

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 (` ).

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseCreateDatabaseMetadata

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
Name Description
parent string

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

createStatement string

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 (` ).

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatabaseCreateDatabaseMetadata

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
Name Description
name BackupName

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

callSettings CallSettings

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
Name Description
request DeleteBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
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
Name Description
name string

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

callSettings CallSettings

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
Name Description
name BackupName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
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
Name Description
name BackupName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
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
Name Description
request DeleteBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
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
Name Description
request DeleteBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
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
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
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
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
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);

DeleteBackupSchedule(BackupScheduleName, CallSettings)

public virtual void DeleteBackupSchedule(BackupScheduleName name, CallSettings callSettings = null)

Deletes a backup schedule.

Parameters
Name Description
name BackupScheduleName

Required. The name of the schedule to delete. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
BackupScheduleName name = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]");
// Make the request
databaseAdminClient.DeleteBackupSchedule(name);

DeleteBackupSchedule(DeleteBackupScheduleRequest, CallSettings)

public virtual void DeleteBackupSchedule(DeleteBackupScheduleRequest request, CallSettings callSettings = null)

Deletes a backup schedule.

Parameters
Name Description
request DeleteBackupScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
DeleteBackupScheduleRequest request = new DeleteBackupScheduleRequest
{
    BackupScheduleName = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]"),
};
// Make the request
databaseAdminClient.DeleteBackupSchedule(request);

DeleteBackupSchedule(string, CallSettings)

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

Deletes a backup schedule.

Parameters
Name Description
name string

Required. The name of the schedule to delete. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

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]/databases/[DATABASE]/backupSchedules/[SCHEDULE]";
// Make the request
databaseAdminClient.DeleteBackupSchedule(name);

DeleteBackupScheduleAsync(BackupScheduleName, CallSettings)

public virtual Task DeleteBackupScheduleAsync(BackupScheduleName name, CallSettings callSettings = null)

Deletes a backup schedule.

Parameters
Name Description
name BackupScheduleName

Required. The name of the schedule to delete. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
BackupScheduleName name = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]");
// Make the request
await databaseAdminClient.DeleteBackupScheduleAsync(name);

DeleteBackupScheduleAsync(BackupScheduleName, CancellationToken)

public virtual Task DeleteBackupScheduleAsync(BackupScheduleName name, CancellationToken cancellationToken)

Deletes a backup schedule.

Parameters
Name Description
name BackupScheduleName

Required. The name of the schedule to delete. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
BackupScheduleName name = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]");
// Make the request
await databaseAdminClient.DeleteBackupScheduleAsync(name);

DeleteBackupScheduleAsync(DeleteBackupScheduleRequest, CallSettings)

public virtual Task DeleteBackupScheduleAsync(DeleteBackupScheduleRequest request, CallSettings callSettings = null)

Deletes a backup schedule.

Parameters
Name Description
request DeleteBackupScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupScheduleRequest request = new DeleteBackupScheduleRequest
{
    BackupScheduleName = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]"),
};
// Make the request
await databaseAdminClient.DeleteBackupScheduleAsync(request);

DeleteBackupScheduleAsync(DeleteBackupScheduleRequest, CancellationToken)

public virtual Task DeleteBackupScheduleAsync(DeleteBackupScheduleRequest request, CancellationToken cancellationToken)

Deletes a backup schedule.

Parameters
Name Description
request DeleteBackupScheduleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupScheduleRequest request = new DeleteBackupScheduleRequest
{
    BackupScheduleName = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]"),
};
// Make the request
await databaseAdminClient.DeleteBackupScheduleAsync(request);

DeleteBackupScheduleAsync(string, CallSettings)

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

Deletes a backup schedule.

Parameters
Name Description
name string

Required. The name of the schedule to delete. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
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]/databases/[DATABASE]/backupSchedules/[SCHEDULE]";
// Make the request
await databaseAdminClient.DeleteBackupScheduleAsync(name);

DeleteBackupScheduleAsync(string, CancellationToken)

public virtual Task DeleteBackupScheduleAsync(string name, CancellationToken cancellationToken)

Deletes a backup schedule.

Parameters
Name Description
name string

Required. The name of the schedule to delete. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
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]/databases/[DATABASE]/backupSchedules/[SCHEDULE]";
// Make the request
await databaseAdminClient.DeleteBackupScheduleAsync(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
Name Description
request DropDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
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
Name Description
database Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database to be dropped.

callSettings CallSettings

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
Name Description
database string

Required. The database to be dropped.

callSettings CallSettings

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
Name Description
request DropDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
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
Name Description
request DropDatabaseRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
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
Name Description
database Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database to be dropped.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
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
Name Description
database Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database to be dropped.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
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
Name Description
database string

Required. The database to be dropped.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
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
Name Description
database string

Required. The database to be dropped.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
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
Name Description
name BackupName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
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
Name Description
request GetBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Backup

The RPC response.

Example
// Create client
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
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Backup

The RPC response.

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

GetBackupAsync(BackupName, CallSettings)

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

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

Parameters
Name Description
name BackupName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

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
Backup response = await databaseAdminClient.GetBackupAsync(name);

GetBackupAsync(BackupName, CancellationToken)

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

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

Parameters
Name Description
name BackupName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

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
Backup response = await databaseAdminClient.GetBackupAsync(name);

GetBackupAsync(GetBackupRequest, CallSettings)

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

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

Parameters
Name Description
request GetBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

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

GetBackupAsync(GetBackupRequest, CancellationToken)

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

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

Parameters
Name Description
request GetBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

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

GetBackupAsync(string, CallSettings)

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

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

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

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
Backup response = await databaseAdminClient.GetBackupAsync(name);

GetBackupAsync(string, CancellationToken)

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

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

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

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
Backup response = await databaseAdminClient.GetBackupAsync(name);

GetBackupSchedule(BackupScheduleName, CallSettings)

public virtual BackupSchedule GetBackupSchedule(BackupScheduleName name, CallSettings callSettings = null)

Gets backup schedule for the input schedule name.

Parameters
Name Description
name BackupScheduleName

Required. The name of the schedule to retrieve. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupSchedule

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
BackupScheduleName name = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]");
// Make the request
BackupSchedule response = databaseAdminClient.GetBackupSchedule(name);

GetBackupSchedule(GetBackupScheduleRequest, CallSettings)

public virtual BackupSchedule GetBackupSchedule(GetBackupScheduleRequest request, CallSettings callSettings = null)

Gets backup schedule for the input schedule name.

Parameters
Name Description
request GetBackupScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupSchedule

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
GetBackupScheduleRequest request = new GetBackupScheduleRequest
{
    BackupScheduleName = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]"),
};
// Make the request
BackupSchedule response = databaseAdminClient.GetBackupSchedule(request);

GetBackupSchedule(string, CallSettings)

public virtual BackupSchedule GetBackupSchedule(string name, CallSettings callSettings = null)

Gets backup schedule for the input schedule name.

Parameters
Name Description
name string

Required. The name of the schedule to retrieve. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupSchedule

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]/backupSchedules/[SCHEDULE]";
// Make the request
BackupSchedule response = databaseAdminClient.GetBackupSchedule(name);

GetBackupScheduleAsync(BackupScheduleName, CallSettings)

public virtual Task<BackupSchedule> GetBackupScheduleAsync(BackupScheduleName name, CallSettings callSettings = null)

Gets backup schedule for the input schedule name.

Parameters
Name Description
name BackupScheduleName

Required. The name of the schedule to retrieve. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
BackupScheduleName name = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]");
// Make the request
BackupSchedule response = await databaseAdminClient.GetBackupScheduleAsync(name);

GetBackupScheduleAsync(BackupScheduleName, CancellationToken)

public virtual Task<BackupSchedule> GetBackupScheduleAsync(BackupScheduleName name, CancellationToken cancellationToken)

Gets backup schedule for the input schedule name.

Parameters
Name Description
name BackupScheduleName

Required. The name of the schedule to retrieve. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
BackupScheduleName name = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]");
// Make the request
BackupSchedule response = await databaseAdminClient.GetBackupScheduleAsync(name);

GetBackupScheduleAsync(GetBackupScheduleRequest, CallSettings)

public virtual Task<BackupSchedule> GetBackupScheduleAsync(GetBackupScheduleRequest request, CallSettings callSettings = null)

Gets backup schedule for the input schedule name.

Parameters
Name Description
request GetBackupScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
GetBackupScheduleRequest request = new GetBackupScheduleRequest
{
    BackupScheduleName = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]"),
};
// Make the request
BackupSchedule response = await databaseAdminClient.GetBackupScheduleAsync(request);

GetBackupScheduleAsync(GetBackupScheduleRequest, CancellationToken)

public virtual Task<BackupSchedule> GetBackupScheduleAsync(GetBackupScheduleRequest request, CancellationToken cancellationToken)

Gets backup schedule for the input schedule name.

Parameters
Name Description
request GetBackupScheduleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
GetBackupScheduleRequest request = new GetBackupScheduleRequest
{
    BackupScheduleName = BackupScheduleName.FromProjectInstanceDatabaseSchedule("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SCHEDULE]"),
};
// Make the request
BackupSchedule response = await databaseAdminClient.GetBackupScheduleAsync(request);

GetBackupScheduleAsync(string, CallSettings)

public virtual Task<BackupSchedule> GetBackupScheduleAsync(string name, CallSettings callSettings = null)

Gets backup schedule for the input schedule name.

Parameters
Name Description
name string

Required. The name of the schedule to retrieve. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]/backupSchedules/[SCHEDULE]";
// Make the request
BackupSchedule response = await databaseAdminClient.GetBackupScheduleAsync(name);

GetBackupScheduleAsync(string, CancellationToken)

public virtual Task<BackupSchedule> GetBackupScheduleAsync(string name, CancellationToken cancellationToken)

Gets backup schedule for the input schedule name.

Parameters
Name Description
name string

Required. The name of the schedule to retrieve. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/<backup_schedule_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupSchedule

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]/backupSchedules/[SCHEDULE]";
// Make the request
BackupSchedule response = await databaseAdminClient.GetBackupScheduleAsync(name);

GetDatabase(GetDatabaseRequest, CallSettings)

public virtual Database GetDatabase(GetDatabaseRequest request, CallSettings callSettings = null)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
request GetDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Database

The RPC response.

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

GetDatabase(DatabaseName, CallSettings)

public virtual Database GetDatabase(DatabaseName name, CallSettings callSettings = null)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
name Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Database

The RPC response.

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

GetDatabase(string, CallSettings)

public virtual Database GetDatabase(string name, CallSettings callSettings = null)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
name string

Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Database

The RPC response.

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

GetDatabaseAsync(GetDatabaseRequest, CallSettings)

public virtual Task<Database> GetDatabaseAsync(GetDatabaseRequest request, CallSettings callSettings = null)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
request GetDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatabase

A Task containing the RPC response.

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

GetDatabaseAsync(GetDatabaseRequest, CancellationToken)

public virtual Task<Database> GetDatabaseAsync(GetDatabaseRequest request, CancellationToken cancellationToken)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
request GetDatabaseRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatabase

A Task containing the RPC response.

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

GetDatabaseAsync(DatabaseName, CallSettings)

public virtual Task<Database> GetDatabaseAsync(DatabaseName name, CallSettings callSettings = null)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
name Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatabase

A Task containing the RPC response.

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

GetDatabaseAsync(DatabaseName, CancellationToken)

public virtual Task<Database> GetDatabaseAsync(DatabaseName name, CancellationToken cancellationToken)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
name Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatabase

A Task containing the RPC response.

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

GetDatabaseAsync(string, CallSettings)

public virtual Task<Database> GetDatabaseAsync(string name, CallSettings callSettings = null)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
name string

Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatabase

A Task containing the RPC response.

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

GetDatabaseAsync(string, CancellationToken)

public virtual Task<Database> GetDatabaseAsync(string name, CancellationToken cancellationToken)

Gets the state of a Cloud Spanner database.

Parameters
Name Description
name string

Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatabase

A Task containing the RPC response.

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

GetDatabaseDdl(GetDatabaseDdlRequest, CallSettings)

public virtual GetDatabaseDdlResponse GetDatabaseDdl(GetDatabaseDdlRequest request, CallSettings callSettings = null)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
request GetDatabaseDdlRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetDatabaseDdlResponse

The RPC response.

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

GetDatabaseDdl(DatabaseName, CallSettings)

public virtual GetDatabaseDdlResponse GetDatabaseDdl(DatabaseName database, CallSettings callSettings = null)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
database Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database whose schema we wish to get. Values are of the form projects/<project>/instances/<instance>/databases/<database>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetDatabaseDdlResponse

The RPC response.

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

GetDatabaseDdl(string, CallSettings)

public virtual GetDatabaseDdlResponse GetDatabaseDdl(string database, CallSettings callSettings = null)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
database string

Required. The database whose schema we wish to get. Values are of the form projects/<project>/instances/<instance>/databases/<database>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetDatabaseDdlResponse

The RPC response.

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

GetDatabaseDdlAsync(GetDatabaseDdlRequest, CallSettings)

public virtual Task<GetDatabaseDdlResponse> GetDatabaseDdlAsync(GetDatabaseDdlRequest request, CallSettings callSettings = null)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
request GetDatabaseDdlRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetDatabaseDdlResponse

A Task containing the RPC response.

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

GetDatabaseDdlAsync(GetDatabaseDdlRequest, CancellationToken)

public virtual Task<GetDatabaseDdlResponse> GetDatabaseDdlAsync(GetDatabaseDdlRequest request, CancellationToken cancellationToken)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
request GetDatabaseDdlRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetDatabaseDdlResponse

A Task containing the RPC response.

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

GetDatabaseDdlAsync(DatabaseName, CallSettings)

public virtual Task<GetDatabaseDdlResponse> GetDatabaseDdlAsync(DatabaseName database, CallSettings callSettings = null)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
database Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database whose schema we wish to get. Values are of the form projects/<project>/instances/<instance>/databases/<database>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetDatabaseDdlResponse

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
GetDatabaseDdlResponse response = await databaseAdminClient.GetDatabaseDdlAsync(database);

GetDatabaseDdlAsync(DatabaseName, CancellationToken)

public virtual Task<GetDatabaseDdlResponse> GetDatabaseDdlAsync(DatabaseName database, CancellationToken cancellationToken)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
database Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database whose schema we wish to get. Values are of the form projects/<project>/instances/<instance>/databases/<database>

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetDatabaseDdlResponse

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
GetDatabaseDdlResponse response = await databaseAdminClient.GetDatabaseDdlAsync(database);

GetDatabaseDdlAsync(string, CallSettings)

public virtual Task<GetDatabaseDdlResponse> GetDatabaseDdlAsync(string database, CallSettings callSettings = null)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
database string

Required. The database whose schema we wish to get. Values are of the form projects/<project>/instances/<instance>/databases/<database>

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetDatabaseDdlResponse

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
GetDatabaseDdlResponse response = await databaseAdminClient.GetDatabaseDdlAsync(database);

GetDatabaseDdlAsync(string, CancellationToken)

public virtual Task<GetDatabaseDdlResponse> GetDatabaseDdlAsync(string database, CancellationToken cancellationToken)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

Parameters
Name Description
database string

Required. The database whose schema we wish to get. Values are of the form projects/<project>/instances/<instance>/databases/<database>

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetDatabaseDdlResponse

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
GetDatabaseDdlResponse response = await databaseAdminClient.GetDatabaseDdlAsync(database);

GetIamPolicy(IResourceName, CallSettings)

public virtual Policy GetIamPolicy(IResourceName resource, CallSettings callSettings = null)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

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

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
request GetIamPolicyRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

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

GetIamPolicy(string, CallSettings)

public virtual Policy GetIamPolicy(string resource, CallSettings callSettings = null)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

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

GetIamPolicyAsync(IResourceName, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CallSettings callSettings = null)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

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

GetIamPolicyAsync(IResourceName, CancellationToken)

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

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

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

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
request GetIamPolicyRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

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

GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

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

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
request GetIamPolicyRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

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

GetIamPolicyAsync(string, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(string resource, CallSettings callSettings = null)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await databaseAdminClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(string, CancellationToken)

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

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.

Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await databaseAdminClient.GetIamPolicyAsync(resource);

ListBackupOperations(ListBackupOperationsRequest, CallSettings)

public virtual PagedEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperations(ListBackupOperationsRequest request, CallSettings callSettings = null)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

Parameters
Name Description
request ListBackupOperationsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupOperationsResponseOperation

A pageable sequence of Operation resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
ListBackupOperationsRequest request = new ListBackupOperationsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListBackupOperationsResponse, Operation> response = databaseAdminClient.ListBackupOperations(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Operation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupOperationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupOperations(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperations(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupOperationsResponseOperation

A pageable sequence of Operation resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListBackupOperationsResponse, Operation> response = databaseAdminClient.ListBackupOperations(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Operation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupOperationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupOperations(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperations(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

Parameters
Name Description
parent string

Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupOperationsResponseOperation

A pageable sequence of Operation resources.

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

// Iterate over all response items, lazily performing RPCs as required
foreach (Operation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupOperationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupOperationsAsync(ListBackupOperationsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperationsAsync(ListBackupOperationsRequest request, CallSettings callSettings = null)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

Parameters
Name Description
request ListBackupOperationsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupOperationsResponseOperation

A pageable asynchronous sequence of Operation resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
ListBackupOperationsRequest request = new ListBackupOperationsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListBackupOperationsResponse, Operation> response = databaseAdminClient.ListBackupOperationsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupOperationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupOperationsAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperationsAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupOperationsResponseOperation

A pageable asynchronous sequence of Operation resources.

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

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupOperationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupOperationsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperationsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

Parameters
Name Description
parent string

Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupOperationsResponseOperation

A pageable asynchronous sequence of Operation resources.

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

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupOperationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupSchedules(ListBackupSchedulesRequest, CallSettings)

public virtual PagedEnumerable<ListBackupSchedulesResponse, BackupSchedule> ListBackupSchedules(ListBackupSchedulesRequest request, CallSettings callSettings = null)

Lists all the backup schedules for the database.

Parameters
Name Description
request ListBackupSchedulesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupSchedulesResponseBackupSchedule

A pageable sequence of BackupSchedule resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
ListBackupSchedulesRequest request = new ListBackupSchedulesRequest
{
    ParentAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
};
// Make the request
PagedEnumerable<ListBackupSchedulesResponse, BackupSchedule> response = databaseAdminClient.ListBackupSchedules(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (BackupSchedule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupSchedulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupSchedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupSchedule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupSchedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupSchedules(DatabaseName, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupSchedulesResponse, BackupSchedule> ListBackupSchedules(DatabaseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the backup schedules for the database.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.DatabaseName

Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupSchedulesResponseBackupSchedule

A pageable sequence of BackupSchedule resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
DatabaseName parent = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
// Make the request
PagedEnumerable<ListBackupSchedulesResponse, BackupSchedule> response = databaseAdminClient.ListBackupSchedules(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (BackupSchedule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupSchedulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupSchedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupSchedule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupSchedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupSchedules(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupSchedulesResponse, BackupSchedule> ListBackupSchedules(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the backup schedules for the database.

Parameters
Name Description
parent string

Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupSchedulesResponseBackupSchedule

A pageable sequence of BackupSchedule resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
// Make the request
PagedEnumerable<ListBackupSchedulesResponse, BackupSchedule> response = databaseAdminClient.ListBackupSchedules(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (BackupSchedule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupSchedulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupSchedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupSchedule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupSchedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupSchedulesAsync(ListBackupSchedulesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupSchedulesResponse, BackupSchedule> ListBackupSchedulesAsync(ListBackupSchedulesRequest request, CallSettings callSettings = null)

Lists all the backup schedules for the database.

Parameters
Name Description
request ListBackupSchedulesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupSchedulesResponseBackupSchedule

A pageable asynchronous sequence of BackupSchedule resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
ListBackupSchedulesRequest request = new ListBackupSchedulesRequest
{
    ParentAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
};
// Make the request
PagedAsyncEnumerable<ListBackupSchedulesResponse, BackupSchedule> response = databaseAdminClient.ListBackupSchedulesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((BackupSchedule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupSchedulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupSchedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupSchedule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupSchedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupSchedulesAsync(DatabaseName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupSchedulesResponse, BackupSchedule> ListBackupSchedulesAsync(DatabaseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the backup schedules for the database.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.DatabaseName

Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupSchedulesResponseBackupSchedule

A pageable asynchronous sequence of BackupSchedule resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DatabaseName parent = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
// Make the request
PagedAsyncEnumerable<ListBackupSchedulesResponse, BackupSchedule> response = databaseAdminClient.ListBackupSchedulesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((BackupSchedule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupSchedulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupSchedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupSchedule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupSchedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupSchedulesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupSchedulesResponse, BackupSchedule> ListBackupSchedulesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the backup schedules for the database.

Parameters
Name Description
parent string

Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupSchedulesResponseBackupSchedule

A pageable asynchronous sequence of BackupSchedule resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
// Make the request
PagedAsyncEnumerable<ListBackupSchedulesResponse, BackupSchedule> response = databaseAdminClient.ListBackupSchedulesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((BackupSchedule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupSchedulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (BackupSchedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<BackupSchedule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (BackupSchedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackups(ListBackupsRequest, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

Parameters
Name Description
request ListBackupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = databaseAdminClient.ListBackups(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackups(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = databaseAdminClient.ListBackups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackups(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

Parameters
Name Description
parent string

Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = databaseAdminClient.ListBackups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Backup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBackupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupsAsync(ListBackupsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

Parameters
Name Description
request ListBackupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = databaseAdminClient.ListBackupsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Backup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupsAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = databaseAdminClient.ListBackupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Backup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListBackupsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

Parameters
Name Description
parent string

Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = databaseAdminClient.ListBackupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Backup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBackupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Backup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Backup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Backup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseOperations(ListDatabaseOperationsRequest, CallSettings)

public virtual PagedEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperations(ListDatabaseOperationsRequest request, CallSettings callSettings = null)

Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

Parameters
Name Description
request ListDatabaseOperationsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabaseOperationsResponseOperation

A pageable sequence of Operation resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
ListDatabaseOperationsRequest request = new ListDatabaseOperationsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListDatabaseOperationsResponse, Operation> response = databaseAdminClient.ListDatabaseOperations(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Operation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabaseOperationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseOperations(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperations(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabaseOperationsResponseOperation

A pageable sequence of Operation resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListDatabaseOperationsResponse, Operation> response = databaseAdminClient.ListDatabaseOperations(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Operation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabaseOperationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseOperations(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperations(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

Parameters
Name Description
parent string

Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabaseOperationsResponseOperation

A pageable sequence of Operation resources.

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

// Iterate over all response items, lazily performing RPCs as required
foreach (Operation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabaseOperationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseOperationsAsync(ListDatabaseOperationsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperationsAsync(ListDatabaseOperationsRequest request, CallSettings callSettings = null)

Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

Parameters
Name Description
request ListDatabaseOperationsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabaseOperationsResponseOperation

A pageable asynchronous sequence of Operation resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
ListDatabaseOperationsRequest request = new ListDatabaseOperationsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListDatabaseOperationsResponse, Operation> response = databaseAdminClient.ListDatabaseOperationsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabaseOperationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseOperationsAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperationsAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabaseOperationsResponseOperation

A pageable asynchronous sequence of Operation resources.

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

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabaseOperationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseOperationsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperationsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

Parameters
Name Description
parent string

Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabaseOperationsResponseOperation

A pageable asynchronous sequence of Operation resources.

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

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Operation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabaseOperationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Operation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Operation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Operation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseRoles(ListDatabaseRolesRequest, CallSettings)

public virtual PagedEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRoles(ListDatabaseRolesRequest request, CallSettings callSettings = null)

Lists Cloud Spanner database roles.

Parameters
Name Description
request ListDatabaseRolesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabaseRolesResponseDatabaseRole

A pageable sequence of DatabaseRole resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
ListDatabaseRolesRequest request = new ListDatabaseRolesRequest
{
    ParentAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
};
// Make the request
PagedEnumerable<ListDatabaseRolesResponse, DatabaseRole> response = databaseAdminClient.ListDatabaseRoles(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DatabaseRole item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabaseRolesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DatabaseRole item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DatabaseRole> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DatabaseRole item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseRoles(DatabaseName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRoles(DatabaseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner database roles.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database whose roles should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabaseRolesResponseDatabaseRole

A pageable sequence of DatabaseRole resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
DatabaseName parent = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
// Make the request
PagedEnumerable<ListDatabaseRolesResponse, DatabaseRole> response = databaseAdminClient.ListDatabaseRoles(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DatabaseRole item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabaseRolesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DatabaseRole item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DatabaseRole> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DatabaseRole item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseRoles(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRoles(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner database roles.

Parameters
Name Description
parent string

Required. The database whose roles should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabaseRolesResponseDatabaseRole

A pageable sequence of DatabaseRole resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
// Make the request
PagedEnumerable<ListDatabaseRolesResponse, DatabaseRole> response = databaseAdminClient.ListDatabaseRoles(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DatabaseRole item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabaseRolesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DatabaseRole item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DatabaseRole> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DatabaseRole item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseRolesAsync(ListDatabaseRolesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRolesAsync(ListDatabaseRolesRequest request, CallSettings callSettings = null)

Lists Cloud Spanner database roles.

Parameters
Name Description
request ListDatabaseRolesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabaseRolesResponseDatabaseRole

A pageable asynchronous sequence of DatabaseRole resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
ListDatabaseRolesRequest request = new ListDatabaseRolesRequest
{
    ParentAsDatabaseName = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]"),
};
// Make the request
PagedAsyncEnumerable<ListDatabaseRolesResponse, DatabaseRole> response = databaseAdminClient.ListDatabaseRolesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DatabaseRole item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabaseRolesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DatabaseRole item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DatabaseRole> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DatabaseRole item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseRolesAsync(DatabaseName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRolesAsync(DatabaseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner database roles.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.DatabaseName

Required. The database whose roles should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabaseRolesResponseDatabaseRole

A pageable asynchronous sequence of DatabaseRole resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
DatabaseName parent = DatabaseName.FromProjectInstanceDatabase("[PROJECT]", "[INSTANCE]", "[DATABASE]");
// Make the request
PagedAsyncEnumerable<ListDatabaseRolesResponse, DatabaseRole> response = databaseAdminClient.ListDatabaseRolesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DatabaseRole item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabaseRolesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DatabaseRole item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DatabaseRole> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DatabaseRole item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabaseRolesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRolesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner database roles.

Parameters
Name Description
parent string

Required. The database whose roles should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabaseRolesResponseDatabaseRole

A pageable asynchronous sequence of DatabaseRole resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE]";
// Make the request
PagedAsyncEnumerable<ListDatabaseRolesResponse, DatabaseRole> response = databaseAdminClient.ListDatabaseRolesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DatabaseRole item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabaseRolesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DatabaseRole item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DatabaseRole> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DatabaseRole item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabases(ListDatabasesRequest, CallSettings)

public virtual PagedEnumerable<ListDatabasesResponse, Database> ListDatabases(ListDatabasesRequest request, CallSettings callSettings = null)

Lists Cloud Spanner databases.

Parameters
Name Description
request ListDatabasesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabasesResponseDatabase

A pageable sequence of Database resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
ListDatabasesRequest request = new ListDatabasesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
PagedEnumerable<ListDatabasesResponse, Database> response = databaseAdminClient.ListDatabases(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Database item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabasesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Database item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Database> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Database item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabases(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatabasesResponse, Database> ListDatabases(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner databases.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabasesResponseDatabase

A pageable sequence of Database resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListDatabasesResponse, Database> response = databaseAdminClient.ListDatabases(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Database item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabasesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Database item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Database> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Database item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabases(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatabasesResponse, Database> ListDatabases(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner databases.

Parameters
Name Description
parent string

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatabasesResponseDatabase

A pageable sequence of Database resources.

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

// Iterate over all response items, lazily performing RPCs as required
foreach (Database item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatabasesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Database item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Database> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Database item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabasesAsync(ListDatabasesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabasesResponse, Database> ListDatabasesAsync(ListDatabasesRequest request, CallSettings callSettings = null)

Lists Cloud Spanner databases.

Parameters
Name Description
request ListDatabasesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabasesResponseDatabase

A pageable asynchronous sequence of Database resources.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
ListDatabasesRequest request = new ListDatabasesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
PagedAsyncEnumerable<ListDatabasesResponse, Database> response = databaseAdminClient.ListDatabasesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Database item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabasesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Database item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Database> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Database item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabasesAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabasesResponse, Database> ListDatabasesAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner databases.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabasesResponseDatabase

A pageable asynchronous sequence of Database resources.

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

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Database item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabasesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Database item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Database> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Database item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatabasesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatabasesResponse, Database> ListDatabasesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Cloud Spanner databases.

Parameters
Name Description
parent string

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatabasesResponseDatabase

A pageable asynchronous sequence of Database resources.

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

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Database item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatabasesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Database item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Database> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Database item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCopyBackup(string, CallSettings)

public virtual Operation<Backup, CopyBackupMetadata> PollOnceCopyBackup(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CopyBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCopyBackupMetadata

The result of polling the operation.

PollOnceCopyBackupAsync(string, CallSettings)

public virtual Task<Operation<Backup, CopyBackupMetadata>> PollOnceCopyBackupAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CopyBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCopyBackupMetadata

A task representing the result of polling the operation.

PollOnceCreateBackup(string, CallSettings)

public virtual Operation<Backup, CreateBackupMetadata> PollOnceCreateBackup(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupCreateBackupMetadata

The result of polling the operation.

PollOnceCreateBackupAsync(string, CallSettings)

public virtual Task<Operation<Backup, CreateBackupMetadata>> PollOnceCreateBackupAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateBackup.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupCreateBackupMetadata

A task representing the result of polling the operation.

PollOnceCreateDatabase(string, CallSettings)

public virtual Operation<Database, CreateDatabaseMetadata> PollOnceCreateDatabase(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateDatabase.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseCreateDatabaseMetadata

The result of polling the operation.

PollOnceCreateDatabaseAsync(string, CallSettings)

public virtual Task<Operation<Database, CreateDatabaseMetadata>> PollOnceCreateDatabaseAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateDatabase.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseCreateDatabaseMetadata

A task representing the result of polling the operation.

PollOnceRestoreDatabase(string, CallSettings)

public virtual Operation<Database, RestoreDatabaseMetadata> PollOnceRestoreDatabase(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RestoreDatabase.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseRestoreDatabaseMetadata

The result of polling the operation.

PollOnceRestoreDatabaseAsync(string, CallSettings)

public virtual Task<Operation<Database, RestoreDatabaseMetadata>> PollOnceRestoreDatabaseAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RestoreDatabase.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseRestoreDatabaseMetadata

A task representing the result of polling the operation.

PollOnceUpdateDatabase(string, CallSettings)

public virtual Operation<Database, UpdateDatabaseMetadata> PollOnceUpdateDatabase(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateDatabase.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseUpdateDatabaseMetadata

The result of polling the operation.

PollOnceUpdateDatabaseAsync(string, CallSettings)

public virtual Task<Operation<Database, UpdateDatabaseMetadata>> PollOnceUpdateDatabaseAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateDatabase.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseUpdateDatabaseMetadata

A task representing the result of polling the operation.

PollOnceUpdateDatabaseDdl(string, CallSettings)

public virtual Operation<Empty, UpdateDatabaseDdlMetadata> PollOnceUpdateDatabaseDdl(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateDatabaseDdl .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyUpdateDatabaseDdlMetadata

The result of polling the operation.

PollOnceUpdateDatabaseDdlAsync(string, CallSettings)

public virtual Task<Operation<Empty, UpdateDatabaseDdlMetadata>> PollOnceUpdateDatabaseDdlAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateDatabaseDdl.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyUpdateDatabaseDdlMetadata

A task representing the result of polling the operation.

RestoreDatabase(RestoreDatabaseRequest, CallSettings)

public virtual Operation<Database, RestoreDatabaseMetadata> RestoreDatabase(RestoreDatabaseRequest request, CallSettings callSettings = null)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
request RestoreDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseRestoreDatabaseMetadata

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
RestoreDatabaseRequest request = new RestoreDatabaseRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DatabaseId = "",
    BackupAsBackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
    EncryptionConfig = new RestoreDatabaseEncryptionConfig(),
};
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = databaseAdminClient.RestoreDatabase(request);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = databaseAdminClient.PollOnceRestoreDatabase(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;
}

RestoreDatabase(InstanceName, string, BackupName, CallSettings)

public virtual Operation<Database, RestoreDatabaseMetadata> RestoreDatabase(InstanceName parent, string databaseId, BackupName backup, CallSettings callSettings = null)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

databaseId string

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

backup BackupName

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseRestoreDatabaseMetadata

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string databaseId = "";
BackupName backup = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = databaseAdminClient.RestoreDatabase(parent, databaseId, backup);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = databaseAdminClient.PollOnceRestoreDatabase(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;
}

RestoreDatabase(string, string, string, CallSettings)

public virtual Operation<Database, RestoreDatabaseMetadata> RestoreDatabase(string parent, string databaseId, string backup, CallSettings callSettings = null)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
parent string

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

databaseId string

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

backup string

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatabaseRestoreDatabaseMetadata

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/instances/[INSTANCE]";
string databaseId = "";
string backup = "projects/[PROJECT]/instances/[INSTANCE]/backups/[BACKUP]";
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = databaseAdminClient.RestoreDatabase(parent, databaseId, backup);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = databaseAdminClient.PollOnceRestoreDatabase(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;
}

RestoreDatabaseAsync(RestoreDatabaseRequest, CallSettings)

public virtual Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(RestoreDatabaseRequest request, CallSettings callSettings = null)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
request RestoreDatabaseRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseRestoreDatabaseMetadata

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
RestoreDatabaseRequest request = new RestoreDatabaseRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DatabaseId = "",
    BackupAsBackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
    EncryptionConfig = new RestoreDatabaseEncryptionConfig(),
};
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = await databaseAdminClient.RestoreDatabaseAsync(request);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceRestoreDatabaseAsync(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;
}

RestoreDatabaseAsync(RestoreDatabaseRequest, CancellationToken)

public virtual Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(RestoreDatabaseRequest request, CancellationToken cancellationToken)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
request RestoreDatabaseRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatabaseRestoreDatabaseMetadata

A Task containing the RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = await DatabaseAdminClient.CreateAsync();
// Initialize request argument(s)
RestoreDatabaseRequest request = new RestoreDatabaseRequest
{
    ParentAsInstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DatabaseId = "",
    BackupAsBackupName = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]"),
    EncryptionConfig = new RestoreDatabaseEncryptionConfig(),
};
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = await databaseAdminClient.RestoreDatabaseAsync(request);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceRestoreDatabaseAsync(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;
}

RestoreDatabaseAsync(InstanceName, string, BackupName, CallSettings)

public virtual Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(InstanceName parent, string databaseId, BackupName backup, CallSettings callSettings = null)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

databaseId string

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

backup BackupName

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseRestoreDatabaseMetadata

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 databaseId = "";
BackupName backup = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = await databaseAdminClient.RestoreDatabaseAsync(parent, databaseId, backup);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceRestoreDatabaseAsync(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;
}

RestoreDatabaseAsync(InstanceName, string, BackupName, CancellationToken)

public virtual Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(InstanceName parent, string databaseId, BackupName backup, CancellationToken cancellationToken)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
parent Google.Cloud.Spanner.Common.V1.InstanceName

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

databaseId string

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

backup BackupName

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatabaseRestoreDatabaseMetadata

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 databaseId = "";
BackupName backup = BackupName.FromProjectInstanceBackup("[PROJECT]", "[INSTANCE]", "[BACKUP]");
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = await databaseAdminClient.RestoreDatabaseAsync(parent, databaseId, backup);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceRestoreDatabaseAsync(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;
}

RestoreDatabaseAsync(string, string, string, CallSettings)

public virtual Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(string parent, string databaseId, string backup, CallSettings callSettings = null)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
parent string

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

databaseId string

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

backup string

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatabaseRestoreDatabaseMetadata

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 databaseId = "";
string backup = "projects/[PROJECT]/instances/[INSTANCE]/backups/[BACKUP]";
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = await databaseAdminClient.RestoreDatabaseAsync(parent, databaseId, backup);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceRestoreDatabaseAsync(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;
}

RestoreDatabaseAsync(string, string, string, CancellationToken)

public virtual Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(string parent, string databaseId, string backup, CancellationToken cancellationToken)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Parameters
Name Description
parent string

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

databaseId string

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

backup string

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatabaseRestoreDatabaseMetadata

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 databaseId = "";
string backup = "projects/[PROJECT]/instances/[INSTANCE]/backups/[BACKUP]";
// Make the request
Operation<Database, RestoreDatabaseMetadata> response = await databaseAdminClient.RestoreDatabaseAsync(parent, databaseId, backup);

// Poll until the returned long-running operation is complete
Operation<Database, RestoreDatabaseMetadata> 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, RestoreDatabaseMetadata> retrievedResponse = await databaseAdminClient.PollOnceRestoreDatabaseAsync(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;
}

SetIamPolicy(IResourceName, Policy, CallSettings)

public virtual Policy SetIamPolicy(IResourceName resource, Policy policy, CallSettings callSettings = null)

Sets the access control policy on a database or backup resource. Replaces any existing policy.

Authorization requires spanner.databases.setIamPolicy permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.setIamPolicy permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy Policy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Example
// Create client
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = databaseAdminClient.SetIamPolicy(resource, policy);

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on a database or backup resource. Replaces any existing policy.

Authorization requires spanner.databases.setIamPolicy permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.setIamPolicy permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters