trait DatabaseAdminClient extends DatabaseAdmin with DatabaseAdminClientPowerApi with AkkaGrpcClient

Linear Supertypes
AkkaGrpcClient, DatabaseAdminClientPowerApi, DatabaseAdmin, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DatabaseAdminClient
  2. AkkaGrpcClient
  3. DatabaseAdminClientPowerApi
  4. DatabaseAdmin
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Future[Done]
    Definition Classes
    AkkaGrpcClient
  2. abstract def closed: Future[Done]
    Definition Classes
    AkkaGrpcClient
  3. abstract def createBackup(in: CreateBackupRequest): Future[Operation]

    Starts creating a new Cloud Spanner Backup.

    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.

    Definition Classes
    DatabaseAdmin
  4. abstract def createDatabase(in: CreateDatabaseRequest): Future[Operation]

    Creates a new Cloud Spanner database and starts to prepare it for serving.

    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.

    Definition Classes
    DatabaseAdmin
  5. abstract def deleteBackup(in: DeleteBackupRequest): Future[Empty]

    Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    Definition Classes
    DatabaseAdmin
  6. abstract def dropDatabase(in: DropDatabaseRequest): Future[Empty]

    Drops (aka deletes) a Cloud Spanner database.

    Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time.

    Definition Classes
    DatabaseAdmin
  7. abstract def getBackup(in: GetBackupRequest): Future[Backup]

    Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    Definition Classes
    DatabaseAdmin
  8. abstract def getDatabase(in: GetDatabaseRequest): Future[Database]

    Gets the state of a Cloud Spanner database.

    Gets the state of a Cloud Spanner database.

    Definition Classes
    DatabaseAdmin
  9. abstract def getDatabaseDdl(in: GetDatabaseDdlRequest): Future[GetDatabaseDdlResponse]

    Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.

    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.

    Definition Classes
    DatabaseAdmin
  10. abstract def getIamPolicy(in: GetIamPolicyRequest): Future[Policy]

    Gets the access control policy for a database or backup resource.

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

    Definition Classes
    DatabaseAdmin
  11. abstract def listBackupOperations(in: ListBackupOperationsRequest): Future[ListBackupOperationsResponse]

    Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.

    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.

    Definition Classes
    DatabaseAdmin
  12. abstract def listBackups(in: ListBackupsRequest): Future[ListBackupsResponse]

    Lists completed and pending backups.

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

    Definition Classes
    DatabaseAdmin
  13. abstract def listDatabaseOperations(in: ListDatabaseOperationsRequest): Future[ListDatabaseOperationsResponse]

    Lists database [longrunning-operations][google.longrunning.Operation].

    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.

    Definition Classes
    DatabaseAdmin
  14. abstract def listDatabases(in: ListDatabasesRequest): Future[ListDatabasesResponse]

    Lists Cloud Spanner databases.

    Lists Cloud Spanner databases.

    Definition Classes
    DatabaseAdmin
  15. abstract def restoreDatabase(in: RestoreDatabaseRequest): Future[Operation]

    Create a new database by restoring from a completed backup.

    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.

    Definition Classes
    DatabaseAdmin
  16. abstract def setIamPolicy(in: SetIamPolicyRequest): Future[Policy]

    Sets the access control policy on a database or backup resource.

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

    Definition Classes
    DatabaseAdmin
  17. abstract def testIamPermissions(in: TestIamPermissionsRequest): Future[TestIamPermissionsResponse]

    Returns permissions that the caller has on the specified database or backup resource.

    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.

    Definition Classes
    DatabaseAdmin
  18. abstract def updateBackup(in: UpdateBackupRequest): Future[Backup]

    Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

    Definition Classes
    DatabaseAdmin
  19. abstract def updateDatabaseDdl(in: UpdateDatabaseDdlRequest): Future[Operation]

    Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

    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.

    Definition Classes
    DatabaseAdmin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def createBackup(): SingleResponseRequestBuilder[CreateBackupRequest, Operation]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer createBackup(com.google.spanner.admin.database.v1.CreateBackupRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  7. def createDatabase(): SingleResponseRequestBuilder[CreateDatabaseRequest, Operation]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer createDatabase(com.google.spanner.admin.database.v1.CreateDatabaseRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  8. def deleteBackup(): SingleResponseRequestBuilder[DeleteBackupRequest, Empty]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer deleteBackup(com.google.spanner.admin.database.v1.DeleteBackupRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  9. def dropDatabase(): SingleResponseRequestBuilder[DropDatabaseRequest, Empty]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer dropDatabase(com.google.spanner.admin.database.v1.DropDatabaseRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def getBackup(): SingleResponseRequestBuilder[GetBackupRequest, Backup]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer getBackup(com.google.spanner.admin.database.v1.GetBackupRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def getDatabase(): SingleResponseRequestBuilder[GetDatabaseRequest, Database]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer getDatabase(com.google.spanner.admin.database.v1.GetDatabaseRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  16. def getDatabaseDdl(): SingleResponseRequestBuilder[GetDatabaseDdlRequest, GetDatabaseDdlResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer getDatabaseDdl(com.google.spanner.admin.database.v1.GetDatabaseDdlRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  17. def getIamPolicy(): SingleResponseRequestBuilder[GetIamPolicyRequest, Policy]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer getIamPolicy(com.google.iam.v1.GetIamPolicyRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def listBackupOperations(): SingleResponseRequestBuilder[ListBackupOperationsRequest, ListBackupOperationsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listBackupOperations(com.google.spanner.admin.database.v1.ListBackupOperationsRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  21. def listBackups(): SingleResponseRequestBuilder[ListBackupsRequest, ListBackupsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listBackups(com.google.spanner.admin.database.v1.ListBackupsRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  22. def listDatabaseOperations(): SingleResponseRequestBuilder[ListDatabaseOperationsRequest, ListDatabaseOperationsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listDatabaseOperations(com.google.spanner.admin.database.v1.ListDatabaseOperationsRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  23. def listDatabases(): SingleResponseRequestBuilder[ListDatabasesRequest, ListDatabasesResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listDatabases(com.google.spanner.admin.database.v1.ListDatabasesRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def restoreDatabase(): SingleResponseRequestBuilder[RestoreDatabaseRequest, Operation]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer restoreDatabase(com.google.spanner.admin.database.v1.RestoreDatabaseRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  28. def setIamPolicy(): SingleResponseRequestBuilder[SetIamPolicyRequest, Policy]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer setIamPolicy(com.google.iam.v1.SetIamPolicyRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def testIamPermissions(): SingleResponseRequestBuilder[TestIamPermissionsRequest, TestIamPermissionsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def updateBackup(): SingleResponseRequestBuilder[UpdateBackupRequest, Backup]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer updateBackup(com.google.spanner.admin.database.v1.UpdateBackupRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  33. def updateDatabaseDdl(): SingleResponseRequestBuilder[UpdateDatabaseDdlRequest, Operation]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer updateDatabaseDdl(com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest) if possible.

    Definition Classes
    DatabaseAdminClientPowerApi
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AkkaGrpcClient

Inherited from DatabaseAdmin

Inherited from AnyRef

Inherited from Any

Ungrouped