public static final class DatabaseAdminGrpc.DatabaseAdminBlockingStub extends AbstractBlockingStub<DatabaseAdminGrpc.DatabaseAdminBlockingStub>
Cloud Spanner Database Admin API
The Cloud Spanner Database Admin API can be used to create, drop, and
list databases. It also enables updating the schema of pre-existing
databases. It can be also used to create, delete and list backups for a
database and to restore from an existing backup.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
DatabaseAdminGrpc.DatabaseAdminBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
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
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
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.
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.
deleteBackup(DeleteBackupRequest request)
public Empty deleteBackup(DeleteBackupRequest request)
Deletes a pending or completed Backup.
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.
getBackup(GetBackupRequest request)
public Backup getBackup(GetBackupRequest request)
Gets metadata on a pending or completed Backup.
getDatabase(GetDatabaseRequest request)
public Database getDatabase(GetDatabaseRequest request)
Gets the state of a Cloud Spanner 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.
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.
| 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.
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.
listDatabaseOperations(ListDatabaseOperationsRequest request)
public ListDatabaseOperationsResponse listDatabaseOperations(ListDatabaseOperationsRequest request)
Lists database longrunning-operations.
A database operation has a name of the form
projects/<project>/instances/<instance>/databases/<database>/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.
listDatabases(ListDatabasesRequest request)
public ListDatabasesResponse listDatabases(ListDatabasesRequest request)
Lists Cloud Spanner databases.
restoreDatabase(RestoreDatabaseRequest request)
public Operation restoreDatabase(RestoreDatabaseRequest request)
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 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 field type is
RestoreDatabaseMetadata.
The response type
is 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.
setIamPolicy(SetIamPolicyRequest request)
public Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on a database or backup resource.
Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on resource.
For backups, authorization requires spanner.backups.setIamPolicy
permission on resource.
| Name |
Description |
| request |
com.google.iam.v1.SetIamPolicyRequest
|
Returns
| Type |
Description |
| com.google.iam.v1.Policy |
|
testIamPermissions(TestIamPermissionsRequest request)
public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
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.
| Name |
Description |
| request |
com.google.iam.v1.TestIamPermissionsRequest
|
Returns
| Type |
Description |
| com.google.iam.v1.TestIamPermissionsResponse |
|
updateBackup(UpdateBackupRequest request)
public Backup updateBackup(UpdateBackupRequest request)
Updates a pending or completed Backup.
updateDatabaseDdl(UpdateDatabaseDdlRequest request)
public Operation updateDatabaseDdl(UpdateDatabaseDdlRequest request)
Updates the schema of a Cloud Spanner database by
creating/altering/dropping tables, columns, indexes, etc. The returned
long-running 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 field type is
UpdateDatabaseDdlMetadata. The operation has no response.
