com.google.spanner.admin.database.v1

Class DatabaseAdminGrpc.DatabaseAdminBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<DatabaseAdminGrpc.DatabaseAdminBlockingStub>

com.google.spanner.admin.database.v1.DatabaseAdminGrpc.DatabaseAdminBlockingStub

Enclosing class:

DatabaseAdminGrpc

public static final class DatabaseAdminGrpc.DatabaseAdminBlockingStub
extends io.grpc.stub.AbstractStub<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.
 

Method Summary

Modifier and Type	Method and Description
protected DatabaseAdminGrpc.DatabaseAdminBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Operation	createDatabase(CreateDatabaseRequest request) Creates a new Cloud Spanner database and starts to prepare it for serving.
Empty	dropDatabase(DropDatabaseRequest request) Drops (aka deletes) a Cloud Spanner database.
Database	getDatabase(GetDatabaseRequest request) Gets the state of a Cloud Spanner database.
GetDatabaseDdlResponse	getDatabaseDdl(GetDatabaseDdlRequest request) Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
Policy	getIamPolicy(GetIamPolicyRequest request) Gets the access control policy for a database resource.
ListDatabasesResponse	listDatabases(ListDatabasesRequest request) Lists Cloud Spanner databases.
Policy	setIamPolicy(SetIamPolicyRequest request) Sets the access control policy on a database resource.
TestIamPermissionsResponse	testIamPermissions(TestIamPermissionsRequest request) Returns permissions that the caller has on the specified database resource.
Operation	updateDatabaseDdl(UpdateDatabaseDdlRequest request) Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected DatabaseAdminGrpc.DatabaseAdminBlockingStub build(io.grpc.Channel channel,
                                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<DatabaseAdminGrpc.DatabaseAdminBlockingStub>

listDatabases

public ListDatabasesResponse listDatabases(ListDatabasesRequest request)

 Lists Cloud Spanner databases.
 

createDatabase

public Operation createDatabase(CreateDatabaseRequest request)

 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.
 

getDatabase

public Database getDatabase(GetDatabaseRequest request)

 Gets the state of a Cloud Spanner database.
 

updateDatabaseDdl

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][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.
 

dropDatabase

public Empty dropDatabase(DropDatabaseRequest request)

 Drops (aka deletes) a Cloud Spanner database.
 

getDatabaseDdl

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][google.longrunning.Operations] API.
 

setIamPolicy

public Policy setIamPolicy(SetIamPolicyRequest request)

 Sets the access control policy on a database resource. Replaces any
 existing policy.
 Authorization requires `spanner.databases.setIamPolicy` permission on
 [resource][google.iam.v1.SetIamPolicyRequest.resource].
 

getIamPolicy

public Policy getIamPolicy(GetIamPolicyRequest request)

 Gets the access control policy for a database resource. Returns an empty
 policy if a database exists but does not have a policy set.
 Authorization requires `spanner.databases.getIamPolicy` permission on
 [resource][google.iam.v1.GetIamPolicyRequest.resource].
 

testIamPermissions

public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

 Returns permissions that the caller has on the specified database 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.