Package com.google.spanner.admin.database.v1

Class DatabaseAdminGrpc.DatabaseAdminStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractAsyncStub<DatabaseAdminGrpc.DatabaseAdminStub>
com.google.spanner.admin.database.v1.DatabaseAdminGrpc.DatabaseAdminStub
Enclosing class:
DatabaseAdminGrpc
public static final class DatabaseAdminGrpc.DatabaseAdminStub extends io.grpc.stub.AbstractAsyncStub<DatabaseAdminGrpc.DatabaseAdminStub>
A stub to allow clients to do asynchronous 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 and list backups for a database
   * restore a database from an existing backup

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    protected DatabaseAdminGrpc.DatabaseAdminStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    void
    copyBackup(CopyBackupRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
    Starts copying a Cloud Spanner Backup.
    void
    createBackup(CreateBackupRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
    Starts creating a new Cloud Spanner Backup.
    void
    createDatabase(CreateDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
    Creates a new Cloud Spanner database and starts to prepare it for serving.
    void
    deleteBackup(DeleteBackupRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
    Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
    void
    dropDatabase(DropDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
    Drops (aka deletes) a Cloud Spanner database.
    void
    getBackup(GetBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver)
    Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
    void
    getDatabase(GetDatabaseRequest request, io.grpc.stub.StreamObserver<Database> responseObserver)
    Gets the state of a Cloud Spanner database.
    void
    getDatabaseDdl(GetDatabaseDdlRequest request, io.grpc.stub.StreamObserver<GetDatabaseDdlResponse> responseObserver)
    Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
    void
    getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
    Gets the access control policy for a database or backup resource.
    void
    listBackupOperations(ListBackupOperationsRequest request, io.grpc.stub.StreamObserver<ListBackupOperationsResponse> responseObserver)
    Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.
    void
    listBackups(ListBackupsRequest request, io.grpc.stub.StreamObserver<ListBackupsResponse> responseObserver)
    Lists completed and pending backups.
    void
    listDatabaseOperations(ListDatabaseOperationsRequest request, io.grpc.stub.StreamObserver<ListDatabaseOperationsResponse> responseObserver)
    Lists database [longrunning-operations][google.longrunning.Operation].
    void
    listDatabaseRoles(ListDatabaseRolesRequest request, io.grpc.stub.StreamObserver<ListDatabaseRolesResponse> responseObserver)
    Lists Cloud Spanner database roles.
    void
    listDatabases(ListDatabasesRequest request, io.grpc.stub.StreamObserver<ListDatabasesResponse> responseObserver)
    Lists Cloud Spanner databases.
    void
    restoreDatabase(RestoreDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
    Create a new database by restoring from a completed backup.
    void
    setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
    Sets the access control policy on a database or backup resource.
    void
    testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
    Returns permissions that the caller has on the specified database or backup resource.
    void
    updateBackup(UpdateBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver)
    Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
    void
    updateDatabase(UpdateDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
    Updates a Cloud Spanner database.
    void
    updateDatabaseDdl(UpdateDatabaseDdlRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
    Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

    Methods inherited from class io.grpc.stub.AbstractAsyncStub

    newStub, newStub

    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 Details

    • build

      protected DatabaseAdminGrpc.DatabaseAdminStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<DatabaseAdminGrpc.DatabaseAdminStub>

    • listDatabases

      public void listDatabases(ListDatabasesRequest request, io.grpc.stub.StreamObserver<ListDatabasesResponse> responseObserver)
       Lists Cloud Spanner databases.

    • createDatabase

      public void createDatabase(CreateDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       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 void getDatabase(GetDatabaseRequest request, io.grpc.stub.StreamObserver<Database> responseObserver)
       Gets the state of a Cloud Spanner database.

    • updateDatabase

      public void updateDatabase(UpdateDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       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.

    • updateDatabaseDdl

      public void updateDatabaseDdl(UpdateDatabaseDdlRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       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 void dropDatabase(DropDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       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.

    • getDatabaseDdl

      public void getDatabaseDdl(GetDatabaseDdlRequest request, io.grpc.stub.StreamObserver<GetDatabaseDdlResponse> responseObserver)
       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 void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
       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].

    • getIamPolicy

      public void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
       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].

    • testIamPermissions

      public void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
       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.

    • createBackup

      public void createBackup(CreateBackupRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       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.

    • copyBackup

      public void copyBackup(CopyBackupRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       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.

    • getBackup

      public void getBackup(GetBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver)
       Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    • updateBackup

      public void updateBackup(UpdateBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver)
       Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    • deleteBackup

      public void deleteBackup(DeleteBackupRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    • listBackups

      public void listBackups(ListBackupsRequest request, io.grpc.stub.StreamObserver<ListBackupsResponse> responseObserver)
       Lists completed and pending backups.
 Backups returned are ordered by `create_time` in descending order,
 starting from the most recent `create_time`.

    • restoreDatabase

      public void restoreDatabase(RestoreDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       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.

    • listDatabaseOperations

      public void listDatabaseOperations(ListDatabaseOperationsRequest request, io.grpc.stub.StreamObserver<ListDatabaseOperationsResponse> responseObserver)
       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.

    • listBackupOperations

      public void listBackupOperations(ListBackupOperationsRequest request, io.grpc.stub.StreamObserver<ListBackupOperationsResponse> responseObserver)
       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.

    • listDatabaseRoles

      public void listDatabaseRoles(ListDatabaseRolesRequest request, io.grpc.stub.StreamObserver<ListDatabaseRolesResponse> responseObserver)
       Lists Cloud Spanner database roles.