public sealed class DatabaseAdminClientImpl : DatabaseAdminClientReference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class DatabaseAdminClientImpl.
DatabaseAdmin client wrapper implementation, for convenient use.
Namespace
GoogleCloudGoogle.Cloud.SpannerGoogle.Cloud.Spanner.AdminGoogle.Cloud.Spanner.Admin.DatabaseV1Assembly
Google.Cloud.Spanner.Admin.Database.V1.dll
Remarks
Cloud Spanner Database Admin API
The Cloud Spanner Database Admin API can be used to:
- create, drop, and list databases
- update the schema of pre-existing databases
- create, delete and list backups for a database
- restore a database from an existing backup
Constructors
DatabaseAdminClientImpl(DatabaseAdminClient, DatabaseAdminSettings, ILogger)
public DatabaseAdminClientImpl(DatabaseAdmin.DatabaseAdminClient grpcClient, DatabaseAdminSettings settings, ILogger logger)Constructs a client wrapper for the DatabaseAdmin service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | DatabaseAdminDatabaseAdminClientThe underlying gRPC client. |
settings | DatabaseAdminSettingsThe base DatabaseAdminSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Fields
ResourcePrefixHeader
public const string ResourcePrefixHeader = "google-cloud-resource-prefix"The name of the header used for efficiently routing requests.
| Field Value | |
|---|---|
| Type | Description |
string | |
This should be set to the instance resource name ("projects/{projectId}/instances/{instanceId}") for some RPCs and to the database resource name for others ("projects/{projectId}/instances/{instanceId}/databases/{databaseId}"). For non-streaming calls, DatabaseAdminClientImpl performs this automatically. This cannot be performed automatically for streaming calls due to the separation between initializing the stream and sending requests, so client code should set the value in a CallSettings. Typically this is performed with either the FromHeader(string, string) factory method or the WithHeader(CallSettings, string, string) extension method.
Properties
CopyBackupOperationsClient
public override OperationsClient CopyBackupOperationsClient { get; }The long-running operations client for CopyBackup.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateBackupOperationsClient
public override OperationsClient CreateBackupOperationsClient { get; }The long-running operations client for CreateBackup.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateDatabaseOperationsClient
public override OperationsClient CreateDatabaseOperationsClient { get; }The long-running operations client for CreateDatabase.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override DatabaseAdmin.DatabaseAdminClient GrpcClient { get; }The underlying gRPC DatabaseAdmin client
| Property Value | |
|---|---|
| Type | Description |
DatabaseAdminDatabaseAdminClient | |
RestoreDatabaseOperationsClient
public override OperationsClient RestoreDatabaseOperationsClient { get; }The long-running operations client for RestoreDatabase.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateDatabaseDdlOperationsClient
public override OperationsClient UpdateDatabaseDdlOperationsClient { get; }The long-running operations client for UpdateDatabaseDdl.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CopyBackup(CopyBackupRequest, CallSettings)
public override Operation<Backup, CopyBackupMetadata> CopyBackup(CopyBackupRequest request, CallSettings callSettings = null)Starts copying a Cloud Spanner Backup.
The returned backup [long-running operation][google.longrunning.Operation]
will have a name of the format
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>
and can be used to track copying of the backup. The operation is associated
with the destination backup.
The [metadata][google.longrunning.Operation.metadata] field type is
[CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
The [response][google.longrunning.Operation.response] field type is
[Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
copying and delete the backup.
Concurrent CopyBackup requests can run on the same source backup.
| Parameters | |
|---|---|
| Name | Description |
request | CopyBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCopyBackupMetadata | The RPC response. |
CopyBackupAsync(CopyBackupRequest, CallSettings)
public override Task<Operation<Backup, CopyBackupMetadata>> CopyBackupAsync(CopyBackupRequest request, CallSettings callSettings = null)Starts copying a Cloud Spanner Backup.
The returned backup [long-running operation][google.longrunning.Operation]
will have a name of the format
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>
and can be used to track copying of the backup. The operation is associated
with the destination backup.
The [metadata][google.longrunning.Operation.metadata] field type is
[CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
The [response][google.longrunning.Operation.response] field type is
[Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
copying and delete the backup.
Concurrent CopyBackup requests can run on the same source backup.
| Parameters | |
|---|---|
| Name | Description |
request | CopyBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCopyBackupMetadata | A Task containing the RPC response. |
CreateBackup(CreateBackupRequest, CallSettings)
public override Operation<Backup, CreateBackupMetadata> CreateBackup(CreateBackupRequest request, CallSettings callSettings = null)Starts creating a new Cloud Spanner Backup.
The returned backup [long-running operation][google.longrunning.Operation]
will have a name of the format
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>
and can be used to track creation of the backup. The
[metadata][google.longrunning.Operation.metadata] field type is
[CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The
[response][google.longrunning.Operation.response] field type is
[Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
creation and delete the backup.
There can be only one pending backup creation per database. Backup creation
of different databases can run concurrently.
| Parameters | |
|---|---|
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationBackupCreateBackupMetadata | The RPC response. |
CreateBackupAsync(CreateBackupRequest, CallSettings)
public override Task<Operation<Backup, CreateBackupMetadata>> CreateBackupAsync(CreateBackupRequest request, CallSettings callSettings = null)Starts creating a new Cloud Spanner Backup.
The returned backup [long-running operation][google.longrunning.Operation]
will have a name of the format
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>
and can be used to track creation of the backup. The
[metadata][google.longrunning.Operation.metadata] field type is
[CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The
[response][google.longrunning.Operation.response] field type is
[Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
creation and delete the backup.
There can be only one pending backup creation per database. Backup creation
of different databases can run concurrently.
| Parameters | |
|---|---|
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationBackupCreateBackupMetadata | A Task containing the RPC response. |
CreateDatabase(CreateDatabaseRequest, CallSettings)
public override Operation<Database, CreateDatabaseMetadata> CreateDatabase(CreateDatabaseRequest request, CallSettings callSettings = null)Creates a new Cloud Spanner database and starts to prepare it for serving.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format <database_name>/operations/<operation_id> and
can be used to track preparation of the database. The
[metadata][google.longrunning.Operation.metadata] field type is
[CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
[response][google.longrunning.Operation.response] field type is
[Database][google.spanner.admin.database.v1.Database], if successful.
| Parameters | |
|---|---|
| Name | Description |
request | CreateDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDatabaseCreateDatabaseMetadata | The RPC response. |
CreateDatabaseAsync(CreateDatabaseRequest, CallSettings)
public override Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(CreateDatabaseRequest request, CallSettings callSettings = null)Creates a new Cloud Spanner database and starts to prepare it for serving.
The returned [long-running operation][google.longrunning.Operation] will
have a name of the format <database_name>/operations/<operation_id> and
can be used to track preparation of the database. The
[metadata][google.longrunning.Operation.metadata] field type is
[CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
[response][google.longrunning.Operation.response] field type is
[Database][google.spanner.admin.database.v1.Database], if successful.
| Parameters | |
|---|---|
| Name | Description |
request | CreateDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDatabaseCreateDatabaseMetadata | A Task containing the RPC response. |
DeleteBackup(DeleteBackupRequest, CallSettings)
public override void DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
| Parameters | |
|---|---|
| Name | Description |
request | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteBackupAsync(DeleteBackupRequest, CallSettings)
public override Task DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
| Parameters | |
|---|---|
| Name | Description |
request | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DropDatabase(DropDatabaseRequest, CallSettings)
public override void DropDatabase(DropDatabaseRequest request, CallSettings callSettings = null)Drops (aka deletes) a Cloud Spanner database.
Completed backups for the database will be retained according to their
expire_time.
Note: Cloud Spanner might continue to accept requests for a few seconds
after the database has been deleted.
| Parameters | |
|---|---|
| Name | Description |
request | DropDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DropDatabaseAsync(DropDatabaseRequest, CallSettings)
public override Task DropDatabaseAsync(DropDatabaseRequest request, CallSettings callSettings = null)Drops (aka deletes) a Cloud Spanner database.
Completed backups for the database will be retained according to their
expire_time.
Note: Cloud Spanner might continue to accept requests for a few seconds
after the database has been deleted.
| Parameters | |
|---|---|
| Name | Description |
request | DropDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetBackup(GetBackupRequest, CallSettings)
public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
| Parameters | |
|---|---|
| Name | Description |
request | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
GetBackupAsync(GetBackupRequest, CallSettings)
public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
| Parameters | |
|---|---|
| Name | Description |
request | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
GetDatabase(GetDatabaseRequest, CallSettings)
public override Database GetDatabase(GetDatabaseRequest request, CallSettings callSettings = null)Gets the state of a Cloud Spanner database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Database | The RPC response. |
GetDatabaseAsync(GetDatabaseRequest, CallSettings)
public override Task<Database> GetDatabaseAsync(GetDatabaseRequest request, CallSettings callSettings = null)Gets the state of a Cloud Spanner database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDatabase | A Task containing the RPC response. |
GetDatabaseDdl(GetDatabaseDdlRequest, CallSettings)
public override GetDatabaseDdlResponse GetDatabaseDdl(GetDatabaseDdlRequest request, CallSettings callSettings = null)Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseDdlRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GetDatabaseDdlResponse | The RPC response. |
GetDatabaseDdlAsync(GetDatabaseDdlRequest, CallSettings)
public override Task<GetDatabaseDdlResponse> GetDatabaseDdlAsync(GetDatabaseDdlRequest request, CallSettings callSettings = null)Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseDdlRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGetDatabaseDdlResponse | A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.
Authorization requires spanner.databases.getIamPolicy permission on
[resource][google.iam.v1.GetIamPolicyRequest.resource].
For backups, authorization requires spanner.backups.getIamPolicy
permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.
Authorization requires spanner.databases.getIamPolicy permission on
[resource][google.iam.v1.GetIamPolicyRequest.resource].
For backups, authorization requires spanner.backups.getIamPolicy
permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
ListBackupOperations(ListBackupOperationsRequest, CallSettings)
public override PagedEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperations(ListBackupOperationsRequest request, CallSettings callSettings = null)Lists the backup [long-running operations][google.longrunning.Operation] in
the given instance. A backup operation has a name of the form
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>.
The long-running operation
[metadata][google.longrunning.Operation.metadata] field type
metadata.type_url describes the type of the metadata. Operations returned
include those that have completed/failed/canceled within the last 7 days,
and pending operations. Operations returned are ordered by
operation.metadata.value.progress.start_time in descending order starting
from the most recently started operation.
| Parameters | |
|---|---|
| Name | Description |
request | ListBackupOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupOperationsResponseOperation | A pageable sequence of Operation resources. |
ListBackupOperationsAsync(ListBackupOperationsRequest, CallSettings)
public override PagedAsyncEnumerable<ListBackupOperationsResponse, Operation> ListBackupOperationsAsync(ListBackupOperationsRequest request, CallSettings callSettings = null)Lists the backup [long-running operations][google.longrunning.Operation] in
the given instance. A backup operation has a name of the form
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>.
The long-running operation
[metadata][google.longrunning.Operation.metadata] field type
metadata.type_url describes the type of the metadata. Operations returned
include those that have completed/failed/canceled within the last 7 days,
and pending operations. Operations returned are ordered by
operation.metadata.value.progress.start_time in descending order starting
from the most recently started operation.
| Parameters | |
|---|---|
| Name | Description |
request | ListBackupOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupOperationsResponseOperation | A pageable asynchronous sequence of Operation resources. |
ListBackups(ListBackupsRequest, CallSettings)
public override PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)Lists completed and pending backups.
Backups returned are ordered by create_time in descending order,
starting from the most recent create_time.
| Parameters | |
|---|---|
| Name | Description |
request | ListBackupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBackupsResponseBackup | A pageable sequence of Backup resources. |
ListBackupsAsync(ListBackupsRequest, CallSettings)
public override PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)Lists completed and pending backups.
Backups returned are ordered by create_time in descending order,
starting from the most recent create_time.
| Parameters | |
|---|---|
| Name | Description |
request | ListBackupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBackupsResponseBackup | A pageable asynchronous sequence of Backup resources. |
ListDatabaseOperations(ListDatabaseOperationsRequest, CallSettings)
public override PagedEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperations(ListDatabaseOperationsRequest request, CallSettings callSettings = null)Lists database [longrunning-operations][google.longrunning.Operation].
A database operation has a name of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>.
The long-running operation
[metadata][google.longrunning.Operation.metadata] field type
metadata.type_url describes the type of the metadata. Operations returned
include those that have completed/failed/canceled within the last 7 days,
and pending operations.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabaseOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDatabaseOperationsResponseOperation | A pageable sequence of Operation resources. |
ListDatabaseOperationsAsync(ListDatabaseOperationsRequest, CallSettings)
public override PagedAsyncEnumerable<ListDatabaseOperationsResponse, Operation> ListDatabaseOperationsAsync(ListDatabaseOperationsRequest request, CallSettings callSettings = null)Lists database [longrunning-operations][google.longrunning.Operation].
A database operation has a name of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>.
The long-running operation
[metadata][google.longrunning.Operation.metadata] field type
metadata.type_url describes the type of the metadata. Operations returned
include those that have completed/failed/canceled within the last 7 days,
and pending operations.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabaseOperationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDatabaseOperationsResponseOperation | A pageable asynchronous sequence of Operation resources. |
ListDatabaseRoles(ListDatabaseRolesRequest, CallSettings)
public override PagedEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRoles(ListDatabaseRolesRequest request, CallSettings callSettings = null)Lists Cloud Spanner database roles.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabaseRolesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDatabaseRolesResponseDatabaseRole | A pageable sequence of DatabaseRole resources. |
ListDatabaseRolesAsync(ListDatabaseRolesRequest, CallSettings)
public override PagedAsyncEnumerable<ListDatabaseRolesResponse, DatabaseRole> ListDatabaseRolesAsync(ListDatabaseRolesRequest request, CallSettings callSettings = null)Lists Cloud Spanner database roles.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabaseRolesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDatabaseRolesResponseDatabaseRole | A pageable asynchronous sequence of DatabaseRole resources. |
ListDatabases(ListDatabasesRequest, CallSettings)
public override PagedEnumerable<ListDatabasesResponse, Database> ListDatabases(ListDatabasesRequest request, CallSettings callSettings = null)Lists Cloud Spanner databases.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDatabasesResponseDatabase | A pageable sequence of Database resources. |
ListDatabasesAsync(ListDatabasesRequest, CallSettings)
public override PagedAsyncEnumerable<ListDatabasesResponse, Database> ListDatabasesAsync(ListDatabasesRequest request, CallSettings callSettings = null)Lists Cloud Spanner databases.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDatabasesResponseDatabase | A pageable asynchronous sequence of Database resources. |
RestoreDatabase(RestoreDatabaseRequest, CallSettings)
public override Operation<Database, RestoreDatabaseMetadata> RestoreDatabase(RestoreDatabaseRequest request, CallSettings callSettings = null)Create a new database by restoring from a completed backup. The new
database must be in the same project and in an instance with the same
instance configuration as the instance containing
the backup. The returned database [long-running
operation][google.longrunning.Operation] has a name of the format
projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>,
and can be used to track the progress of the operation, and to cancel it.
The [metadata][google.longrunning.Operation.metadata] field type is
[RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
The [response][google.longrunning.Operation.response] type
is [Database][google.spanner.admin.database.v1.Database], if
successful. Cancelling the returned operation will stop the restore and
delete the database.
There can be only one database being restored into an instance at a time.
Once the restore operation completes, a new restore operation can be
initiated, without waiting for the optimize operation associated with the
first restore to complete.
| Parameters | |
|---|---|
| Name | Description |
request | RestoreDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDatabaseRestoreDatabaseMetadata | The RPC response. |
RestoreDatabaseAsync(RestoreDatabaseRequest, CallSettings)
public override Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(RestoreDatabaseRequest request, CallSettings callSettings = null)Create a new database by restoring from a completed backup. The new
database must be in the same project and in an instance with the same
instance configuration as the instance containing
the backup. The returned database [long-running
operation][google.longrunning.Operation] has a name of the format
projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>,
and can be used to track the progress of the operation, and to cancel it.
The [metadata][google.longrunning.Operation.metadata] field type is
[RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
The [response][google.longrunning.Operation.response] type
is [Database][google.spanner.admin.database.v1.Database], if
successful. Cancelling the returned operation will stop the restore and
delete the database.
There can be only one database being restored into an instance at a time.
Once the restore operation completes, a new restore operation can be
initiated, without waiting for the optimize operation associated with the
first restore to complete.
| Parameters | |
|---|---|
| Name | Description |
request | RestoreDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDatabaseRestoreDatabaseMetadata | A Task containing the RPC response. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)Sets the access control policy on a database or backup resource. Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
For backups, authorization requires spanner.backups.setIamPolicy
permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)Sets the access control policy on a database or backup resource. Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
For backups, authorization requires spanner.backups.setIamPolicy
permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)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 | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)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 | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
UpdateBackup(UpdateBackupRequest, CallSettings)
public override Backup UpdateBackup(UpdateBackupRequest request, CallSettings callSettings = null)Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Backup | The RPC response. |
UpdateBackupAsync(UpdateBackupRequest, CallSettings)
public override Task<Backup> UpdateBackupAsync(UpdateBackupRequest request, CallSettings callSettings = null)Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskBackup | A Task containing the RPC response. |
UpdateDatabaseDdl(UpdateDatabaseDdlRequest, CallSettings)
public override Operation<Empty, UpdateDatabaseDdlMetadata> UpdateDatabaseDdl(UpdateDatabaseDdlRequest request, CallSettings callSettings = null)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 | UpdateDatabaseDdlRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyUpdateDatabaseDdlMetadata | The RPC response. |
UpdateDatabaseDdlAsync(UpdateDatabaseDdlRequest, CallSettings)
public override Task<Operation<Empty, UpdateDatabaseDdlMetadata>> UpdateDatabaseDdlAsync(UpdateDatabaseDdlRequest request, CallSettings callSettings = null)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 | UpdateDatabaseDdlRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyUpdateDatabaseDdlMetadata | A Task containing the RPC response. |