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

Version latest

• 5.0.0-beta04 (latest)
• 5.0.0-beta03
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.15.1
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0

public class DatabaseAdmin.DatabaseAdminClient : ClientBase<DatabaseAdmin.DatabaseAdminClient>

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

Client for DatabaseAdmin

Inheritance

object > ClientBase > ClientBaseDatabaseAdminDatabaseAdminClient > DatabaseAdmin.DatabaseAdminClient

Inherited Members

ClientBase<DatabaseAdmin.DatabaseAdminClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

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

Constructors

DatabaseAdminClient()

protected DatabaseAdminClient()

Protected parameterless constructor to allow creation of test doubles.

DatabaseAdminClient(CallInvoker)

public DatabaseAdminClient(CallInvoker callInvoker)

Creates a new client for DatabaseAdmin that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

DatabaseAdminClient(ChannelBase)

public DatabaseAdminClient(ChannelBase channel)

Creates a new client for DatabaseAdmin

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

DatabaseAdminClient(ClientBaseConfiguration)

protected DatabaseAdminClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CopyBackup(CopyBackupRequest, CallOptions)

public virtual Operation CopyBackup(CopyBackupRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CopyBackup(CopyBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CopyBackup(CopyBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CopyBackupAsync(CopyBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CopyBackupAsync(CopyBackupRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CopyBackupAsync(CopyBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CopyBackupAsync(CopyBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateBackup(CreateBackupRequest, CallOptions)

public virtual Operation CreateBackup(CreateBackupRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateBackup(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateBackup(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateBackupAsync(CreateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateBackupAsync(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateBackupSchedule(CreateBackupScheduleRequest, CallOptions)

public virtual BackupSchedule CreateBackupSchedule(CreateBackupScheduleRequest request, CallOptions options)

Creates a new backup schedule.

Parameters
Name	Description
request	CreateBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BackupSchedule	The response received from the server.

CreateBackupSchedule(CreateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual BackupSchedule CreateBackupSchedule(CreateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new backup schedule.

Parameters
Name	Description
request	CreateBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BackupSchedule	The response received from the server.

CreateBackupScheduleAsync(CreateBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<BackupSchedule> CreateBackupScheduleAsync(CreateBackupScheduleRequest request, CallOptions options)

Creates a new backup schedule.

Parameters
Name	Description
request	CreateBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackupSchedule	The call object.

CreateBackupScheduleAsync(CreateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackupSchedule> CreateBackupScheduleAsync(CreateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new backup schedule.

Parameters
Name	Description
request	CreateBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackupSchedule	The call object.

CreateDatabase(CreateDatabaseRequest, CallOptions)

public virtual Operation CreateDatabase(CreateDatabaseRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateDatabase(CreateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateDatabase(CreateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateDatabaseAsync(CreateDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDatabaseAsync(CreateDatabaseRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateDatabaseAsync(CreateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateDatabaseAsync(CreateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteBackup(DeleteBackupRequest, CallOptions)

public virtual Empty DeleteBackup(DeleteBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteBackup(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteBackup(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteBackupAsync(DeleteBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteBackupAsync(DeleteBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteBackupAsync(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteBackupAsync(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteBackupSchedule(DeleteBackupScheduleRequest, CallOptions)

public virtual Empty DeleteBackupSchedule(DeleteBackupScheduleRequest request, CallOptions options)

Deletes a backup schedule.

Parameters
Name	Description
request	DeleteBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteBackupSchedule(DeleteBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteBackupSchedule(DeleteBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup schedule.

Parameters
Name	Description
request	DeleteBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteBackupScheduleAsync(DeleteBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteBackupScheduleAsync(DeleteBackupScheduleRequest request, CallOptions options)

Deletes a backup schedule.

Parameters
Name	Description
request	DeleteBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteBackupScheduleAsync(DeleteBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteBackupScheduleAsync(DeleteBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup schedule.

Parameters
Name	Description
request	DeleteBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DropDatabase(DropDatabaseRequest, CallOptions)

public virtual Empty DropDatabase(DropDatabaseRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DropDatabase(DropDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DropDatabase(DropDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DropDatabaseAsync(DropDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DropDatabaseAsync(DropDatabaseRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DropDatabaseAsync(DropDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DropDatabaseAsync(DropDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetBackup(GetBackupRequest, CallOptions)

public virtual Backup GetBackup(GetBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Backup	The response received from the server.

GetBackup(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup GetBackup(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Backup	The response received from the server.

GetBackupAsync(GetBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

GetBackupAsync(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

GetBackupSchedule(GetBackupScheduleRequest, CallOptions)

public virtual BackupSchedule GetBackupSchedule(GetBackupScheduleRequest request, CallOptions options)

Gets backup schedule for the input schedule name.

Parameters
Name	Description
request	GetBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BackupSchedule	The response received from the server.

GetBackupSchedule(GetBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual BackupSchedule GetBackupSchedule(GetBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets backup schedule for the input schedule name.

Parameters
Name	Description
request	GetBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BackupSchedule	The response received from the server.

GetBackupScheduleAsync(GetBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<BackupSchedule> GetBackupScheduleAsync(GetBackupScheduleRequest request, CallOptions options)

Gets backup schedule for the input schedule name.

Parameters
Name	Description
request	GetBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackupSchedule	The call object.

GetBackupScheduleAsync(GetBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackupSchedule> GetBackupScheduleAsync(GetBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets backup schedule for the input schedule name.

Parameters
Name	Description
request	GetBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackupSchedule	The call object.

GetDatabase(GetDatabaseRequest, CallOptions)

public virtual Database GetDatabase(GetDatabaseRequest request, CallOptions options)

Gets the state of a Cloud Spanner database.

Parameters
Name	Description
request	GetDatabaseRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Database	The response received from the server.

GetDatabase(GetDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Database GetDatabase(GetDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the state of a Cloud Spanner database.

Parameters
Name	Description
request	GetDatabaseRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Database	The response received from the server.

GetDatabaseAsync(GetDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Database> GetDatabaseAsync(GetDatabaseRequest request, CallOptions options)

Gets the state of a Cloud Spanner database.

Parameters
Name	Description
request	GetDatabaseRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDatabase	The call object.

GetDatabaseAsync(GetDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Database> GetDatabaseAsync(GetDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the state of a Cloud Spanner database.

Parameters
Name	Description
request	GetDatabaseRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDatabase	The call object.

GetDatabaseDdl(GetDatabaseDdlRequest, CallOptions)

public virtual GetDatabaseDdlResponse GetDatabaseDdl(GetDatabaseDdlRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GetDatabaseDdlResponse	The response received from the server.

GetDatabaseDdl(GetDatabaseDdlRequest, Metadata, DateTime?, CancellationToken)

public virtual GetDatabaseDdlResponse GetDatabaseDdl(GetDatabaseDdlRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
GetDatabaseDdlResponse	The response received from the server.

GetDatabaseDdlAsync(GetDatabaseDdlRequest, CallOptions)

public virtual AsyncUnaryCall<GetDatabaseDdlResponse> GetDatabaseDdlAsync(GetDatabaseDdlRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallGetDatabaseDdlResponse	The call object.

GetDatabaseDdlAsync(GetDatabaseDdlRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetDatabaseDdlResponse> GetDatabaseDdlAsync(GetDatabaseDdlRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallGetDatabaseDdlResponse	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

ListBackupOperations(ListBackupOperationsRequest, CallOptions)

public virtual ListBackupOperationsResponse ListBackupOperations(ListBackupOperationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListBackupOperationsResponse	The response received from the server.

ListBackupOperations(ListBackupOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupOperationsResponse ListBackupOperations(ListBackupOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListBackupOperationsResponse	The response received from the server.

ListBackupOperationsAsync(ListBackupOperationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupOperationsResponse> ListBackupOperationsAsync(ListBackupOperationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListBackupOperationsResponse	The call object.

ListBackupOperationsAsync(ListBackupOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupOperationsResponse> ListBackupOperationsAsync(ListBackupOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListBackupOperationsResponse	The call object.

ListBackupSchedules(ListBackupSchedulesRequest, CallOptions)

public virtual ListBackupSchedulesResponse ListBackupSchedules(ListBackupSchedulesRequest request, CallOptions options)

Lists all the backup schedules for the database.

Parameters
Name	Description
request	ListBackupSchedulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListBackupSchedulesResponse	The response received from the server.

ListBackupSchedules(ListBackupSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupSchedulesResponse ListBackupSchedules(ListBackupSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the backup schedules for the database.

Parameters
Name	Description
request	ListBackupSchedulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListBackupSchedulesResponse	The response received from the server.

ListBackupSchedulesAsync(ListBackupSchedulesRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupSchedulesResponse> ListBackupSchedulesAsync(ListBackupSchedulesRequest request, CallOptions options)

Lists all the backup schedules for the database.

Parameters
Name	Description
request	ListBackupSchedulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListBackupSchedulesResponse	The call object.

ListBackupSchedulesAsync(ListBackupSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupSchedulesResponse> ListBackupSchedulesAsync(ListBackupSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the backup schedules for the database.

Parameters
Name	Description
request	ListBackupSchedulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListBackupSchedulesResponse	The call object.

ListBackups(ListBackupsRequest, CallOptions)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListBackupsResponse	The response received from the server.

ListBackups(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListBackupsResponse	The response received from the server.

ListBackupsAsync(ListBackupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListBackupsResponse	The call object.

ListBackupsAsync(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListBackupsResponse	The call object.

ListDatabaseOperations(ListDatabaseOperationsRequest, CallOptions)

public virtual ListDatabaseOperationsResponse ListDatabaseOperations(ListDatabaseOperationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDatabaseOperationsResponse	The response received from the server.

ListDatabaseOperations(ListDatabaseOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDatabaseOperationsResponse ListDatabaseOperations(ListDatabaseOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDatabaseOperationsResponse	The response received from the server.

ListDatabaseOperationsAsync(ListDatabaseOperationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDatabaseOperationsResponse> ListDatabaseOperationsAsync(ListDatabaseOperationsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDatabaseOperationsResponse	The call object.

ListDatabaseOperationsAsync(ListDatabaseOperationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDatabaseOperationsResponse> ListDatabaseOperationsAsync(ListDatabaseOperationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDatabaseOperationsResponse	The call object.

ListDatabaseRoles(ListDatabaseRolesRequest, CallOptions)

public virtual ListDatabaseRolesResponse ListDatabaseRoles(ListDatabaseRolesRequest request, CallOptions options)

Lists Cloud Spanner database roles.

Parameters
Name	Description
request	ListDatabaseRolesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDatabaseRolesResponse	The response received from the server.

ListDatabaseRoles(ListDatabaseRolesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDatabaseRolesResponse ListDatabaseRoles(ListDatabaseRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Cloud Spanner database roles.

Parameters
Name	Description
request	ListDatabaseRolesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDatabaseRolesResponse	The response received from the server.

ListDatabaseRolesAsync(ListDatabaseRolesRequest, CallOptions)

public virtual AsyncUnaryCall<ListDatabaseRolesResponse> ListDatabaseRolesAsync(ListDatabaseRolesRequest request, CallOptions options)

Lists Cloud Spanner database roles.

Parameters
Name	Description
request	ListDatabaseRolesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDatabaseRolesResponse	The call object.

ListDatabaseRolesAsync(ListDatabaseRolesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDatabaseRolesResponse> ListDatabaseRolesAsync(ListDatabaseRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Cloud Spanner database roles.

Parameters
Name	Description
request	ListDatabaseRolesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDatabaseRolesResponse	The call object.

ListDatabases(ListDatabasesRequest, CallOptions)

public virtual ListDatabasesResponse ListDatabases(ListDatabasesRequest request, CallOptions options)

Lists Cloud Spanner databases.

Parameters
Name	Description
request	ListDatabasesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDatabasesResponse	The response received from the server.

ListDatabases(ListDatabasesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDatabasesResponse ListDatabases(ListDatabasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Cloud Spanner databases.

Parameters
Name	Description
request	ListDatabasesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDatabasesResponse	The response received from the server.

ListDatabasesAsync(ListDatabasesRequest, CallOptions)

public virtual AsyncUnaryCall<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, CallOptions options)

Lists Cloud Spanner databases.

Parameters
Name	Description
request	ListDatabasesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDatabasesResponse	The call object.

ListDatabasesAsync(ListDatabasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Cloud Spanner databases.

Parameters
Name	Description
request	ListDatabasesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDatabasesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override DatabaseAdmin.DatabaseAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DatabaseAdminDatabaseAdminClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Spanner.Admin.Database.V1.DatabaseAdmin.DatabaseAdminClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RestoreDatabase(RestoreDatabaseRequest, CallOptions)

public virtual Operation RestoreDatabase(RestoreDatabaseRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RestoreDatabase(RestoreDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RestoreDatabase(RestoreDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RestoreDatabaseAsync(RestoreDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestoreDatabaseAsync(RestoreDatabaseRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RestoreDatabaseAsync(RestoreDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestoreDatabaseAsync(RestoreDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Returns permissions that the caller has on the specified database or backup resource.

Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has spanner.databases.list permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has spanner.backups.list permission on the containing instance.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that the caller has on the specified database or backup resource.

Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has spanner.databases.list permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has spanner.backups.list permission on the containing instance.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

Returns permissions that the caller has on the specified database or backup resource.

Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has spanner.databases.list permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has spanner.backups.list permission on the containing instance.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that the caller has on the specified database or backup resource.

Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has spanner.databases.list permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has spanner.backups.list permission on the containing instance.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

UpdateBackup(UpdateBackupRequest, CallOptions)

public virtual Backup UpdateBackup(UpdateBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Backup	The response received from the server.

UpdateBackup(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup UpdateBackup(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Backup	The response received from the server.

UpdateBackupAsync(UpdateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> UpdateBackupAsync(UpdateBackupRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

UpdateBackupAsync(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> UpdateBackupAsync(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

UpdateBackupSchedule(UpdateBackupScheduleRequest, CallOptions)

public virtual BackupSchedule UpdateBackupSchedule(UpdateBackupScheduleRequest request, CallOptions options)

Updates a backup schedule.

Parameters
Name	Description
request	UpdateBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BackupSchedule	The response received from the server.

UpdateBackupSchedule(UpdateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual BackupSchedule UpdateBackupSchedule(UpdateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a backup schedule.

Parameters
Name	Description
request	UpdateBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BackupSchedule	The response received from the server.

UpdateBackupScheduleAsync(UpdateBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<BackupSchedule> UpdateBackupScheduleAsync(UpdateBackupScheduleRequest request, CallOptions options)

Updates a backup schedule.

Parameters
Name	Description
request	UpdateBackupScheduleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackupSchedule	The call object.

UpdateBackupScheduleAsync(UpdateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackupSchedule> UpdateBackupScheduleAsync(UpdateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a backup schedule.

Parameters
Name	Description
request	UpdateBackupScheduleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackupSchedule	The call object.

UpdateDatabase(UpdateDatabaseRequest, CallOptions)

public virtual Operation UpdateDatabase(UpdateDatabaseRequest request, CallOptions options)

Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns NOT_FOUND.

While the operation is pending:

• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true.
• Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a CANCELLED status.
• New UpdateDatabase requests will return a FAILED_PRECONDITION error until the pending operation is done (returns successfully or with error).
• Reading the database via the API continues to give the pre-request values.

Upon completion of the returned operation:

• The new values are in effect and readable via the API.
• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id> and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
Name	Description
request	UpdateDatabaseRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateDatabase(UpdateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateDatabase(UpdateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns NOT_FOUND.

While the operation is pending:

• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true.
• Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a CANCELLED status.
• New UpdateDatabase requests will return a FAILED_PRECONDITION error until the pending operation is done (returns successfully or with error).
• Reading the database via the API continues to give the pre-request values.

Upon completion of the returned operation:

• The new values are in effect and readable via the API.
• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id> and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
Name	Description
request	UpdateDatabaseRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateDatabaseAsync(UpdateDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDatabaseAsync(UpdateDatabaseRequest request, CallOptions options)

Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns NOT_FOUND.

While the operation is pending:

• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true.
• Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a CANCELLED status.
• New UpdateDatabase requests will return a FAILED_PRECONDITION error until the pending operation is done (returns successfully or with error).
• Reading the database via the API continues to give the pre-request values.

Upon completion of the returned operation:

• The new values are in effect and readable via the API.
• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id> and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
Name	Description
request	UpdateDatabaseRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateDatabaseAsync(UpdateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateDatabaseAsync(UpdateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns NOT_FOUND.

While the operation is pending:

• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true.
• Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a CANCELLED status.
• New UpdateDatabase requests will return a FAILED_PRECONDITION error until the pending operation is done (returns successfully or with error).
• Reading the database via the API continues to give the pre-request values.

Upon completion of the returned operation:

• The new values are in effect and readable via the API.
• The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id> and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

Parameters
Name	Description
request	UpdateDatabaseRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateDatabaseDdl(UpdateDatabaseDdlRequest, CallOptions)

public virtual Operation UpdateDatabaseDdl(UpdateDatabaseDdlRequest request, CallOptions options)

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. 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 execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.

Parameters
Name	Description
request	UpdateDatabaseDdlRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateDatabaseDdl(UpdateDatabaseDdlRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateDatabaseDdl(UpdateDatabaseDdlRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. 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 execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.

Parameters
Name	Description
request	UpdateDatabaseDdlRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateDatabaseDdlAsync(UpdateDatabaseDdlRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDatabaseDdlAsync(UpdateDatabaseDdlRequest request, CallOptions options)

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. 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 execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.

Parameters
Name	Description
request	UpdateDatabaseDdlRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateDatabaseDdlAsync(UpdateDatabaseDdlRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateDatabaseDdlAsync(UpdateDatabaseDdlRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. 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 execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.

Parameters
Name	Description
request	UpdateDatabaseDdlRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.