Class DatabaseAdminGrpc.DatabaseAdminBlockingStub (6.74.0)

public static final class DatabaseAdminGrpc.DatabaseAdminBlockingStub extends AbstractBlockingStub<DatabaseAdminGrpc.DatabaseAdminBlockingStub>

A stub to allow clients to do synchronous rpc calls to service DatabaseAdmin.

Cloud Spanner Database Admin API The Cloud Spanner Database Admin API can be used to:

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DatabaseAdminGrpc.DatabaseAdminBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected DatabaseAdminGrpc.DatabaseAdminBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DatabaseAdminGrpc.DatabaseAdminBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

copyBackup(CopyBackupRequest request)

public Operation copyBackup(CopyBackupRequest request)

Starts copying a Cloud Spanner Backup. The returned backup long-running 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 field type is CopyBackupMetadata. The response field type is 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.

Parameter
Name Description
request CopyBackupRequest
Returns
Type Description
Operation

createBackup(CreateBackupRequest request)

public Operation createBackup(CreateBackupRequest request)

Starts creating a new Cloud Spanner Backup. The returned backup long-running 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 field type is CreateBackupMetadata. The response field type is 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.

Parameter
Name Description
request CreateBackupRequest
Returns
Type Description
Operation

createBackupSchedule(CreateBackupScheduleRequest request)

public BackupSchedule createBackupSchedule(CreateBackupScheduleRequest request)

Creates a new backup schedule.

Parameter
Name Description
request CreateBackupScheduleRequest
Returns
Type Description
BackupSchedule

createDatabase(CreateDatabaseRequest request)

public Operation createDatabase(CreateDatabaseRequest request)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running 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 field type is CreateDatabaseMetadata. The response field type is Database, if successful.

Parameter
Name Description
request CreateDatabaseRequest
Returns
Type Description
Operation

deleteBackup(DeleteBackupRequest request)

public Empty deleteBackup(DeleteBackupRequest request)

Deletes a pending or completed Backup.

Parameter
Name Description
request DeleteBackupRequest
Returns
Type Description
Empty

deleteBackupSchedule(DeleteBackupScheduleRequest request)

public Empty deleteBackupSchedule(DeleteBackupScheduleRequest request)

Deletes a backup schedule.

Parameter
Name Description
request DeleteBackupScheduleRequest
Returns
Type Description
Empty

dropDatabase(DropDatabaseRequest request)

public Empty dropDatabase(DropDatabaseRequest request)

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.

Parameter
Name Description
request DropDatabaseRequest
Returns
Type Description
Empty

getBackup(GetBackupRequest request)

public Backup getBackup(GetBackupRequest request)

Gets metadata on a pending or completed Backup.

Parameter
Name Description
request GetBackupRequest
Returns
Type Description
Backup

getBackupSchedule(GetBackupScheduleRequest request)

public BackupSchedule getBackupSchedule(GetBackupScheduleRequest request)

Gets backup schedule for the input schedule name.

Parameter
Name Description
request GetBackupScheduleRequest
Returns
Type Description
BackupSchedule

getDatabase(GetDatabaseRequest request)

public Database getDatabase(GetDatabaseRequest request)

Gets the state of a Cloud Spanner database.

Parameter
Name Description
request GetDatabaseRequest
Returns
Type Description
Database

getDatabaseDdl(GetDatabaseDdlRequest request)

public GetDatabaseDdlResponse getDatabaseDdl(GetDatabaseDdlRequest request)

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 API.

Parameter
Name Description
request GetDatabaseDdlRequest
Returns
Type Description
GetDatabaseDdlResponse

getIamPolicy(GetIamPolicyRequest request)

public Policy getIamPolicy(GetIamPolicyRequest request)

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. For backups, authorization requires spanner.backups.getIamPolicy permission on resource.

Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest
Returns
Type Description
com.google.iam.v1.Policy

listBackupOperations(ListBackupOperationsRequest request)

public ListBackupOperationsResponse listBackupOperations(ListBackupOperationsRequest request)

Lists the backup long-running operations 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 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.

Parameter
Name Description
request ListBackupOperationsRequest
Returns
Type Description
ListBackupOperationsResponse

listBackupSchedules(ListBackupSchedulesRequest request)

public ListBackupSchedulesResponse listBackupSchedules(ListBackupSchedulesRequest request)

Lists all the backup schedules for the database.

Parameter
Name Description
request ListBackupSchedulesRequest
Returns
Type Description
ListBackupSchedulesResponse

listBackups(ListBackupsRequest request)

public ListBackupsResponse listBackups(ListBackupsRequest request)

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

Parameter
Name Description
request ListBackupsRequest
Returns
Type Description
ListBackupsResponse

listDatabaseOperations(ListDatabaseOperationsRequest request)

public ListDatabaseOperationsResponse listDatabaseOperations(ListDatabaseOperationsRequest request)

Lists database longrunning-operations. A database