Type Members

1.  final case class Backup(database: String = "", expireTime: Option[Timestamp] = _root_.scala.None, name: String = "", createTime: Option[Timestamp] = _root_.scala.None, sizeBytes: Long = 0L, state: State = ..., referencingDatabases: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Backup] with Product with Serializable

   A backup of a Cloud Spanner database.

   A backup of a Cloud Spanner database.

   database

   Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

   expireTime

   Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

   name

   Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_&92;-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects/<project>/instances/<instance>.

   createTime

   Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by create_time. create_time is approximately the time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.

   sizeBytes

   Output only. Size of the backup in bytes.

   state

   Output only. The current state of the backup.

   referencingDatabases

   Output only. The names of the restored databases that reference the backup. The database names are of the form projects/<project>/instances/<instance>/databases/<database>. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

   Annotations

   @SerialVersionUID()

2.  final case class BackupInfo(backup: String = "", createTime: Option[Timestamp] = _root_.scala.None, sourceDatabase: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[BackupInfo] with Product with Serializable

   Information about a backup.

   Information about a backup.

   backup

   Name of the backup.

   createTime

   The backup contains an externally consistent copy of source_database at the timestamp specified by create_time.

   sourceDatabase

   Name of the database the backup was created from.

   Annotations

   @SerialVersionUID()

3.  final case class CreateBackupMetadata(name: String = "", database: String = "", progress: Option[OperationProgress] = _root_.scala.None, cancelTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CreateBackupMetadata] with Product with Serializable

   Metadata type for the operation returned by [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].

   Metadata type for the operation returned by [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].

   name

   The name of the backup being created.

   database

   The name of the database the backup is created from.

   progress

   The progress of the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.

   cancelTime

   The time at which cancellation of this operation was received. [Operations.CancelOperation][google.longrunning.Operations.CancelOperation] starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

   Annotations

   @SerialVersionUID()

4.  final case class CreateBackupRequest(parent: String = "", backupId: String = "", backup: Option[Backup] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CreateBackupRequest] with Product with Serializable

   The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].

   The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].

   parent

   Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

   backupId

   Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

   backup

   Required. The backup to create.

   Annotations

   @SerialVersionUID()

5.  final case class CreateDatabaseMetadata(database: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CreateDatabaseMetadata] with Product with Serializable

   Metadata type for the operation returned by [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].

   Metadata type for the operation returned by [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].

   database

   The database being created.

   Annotations

   @SerialVersionUID()

6.  final case class CreateDatabaseRequest(parent: String = "", createStatement: String = "", extraStatements: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CreateDatabaseRequest] with Product with Serializable

   The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].

   The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].

   parent

   Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>.

   createStatement

   Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_&92;-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks ( ).

   extraStatements

   Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.

   Annotations

   @SerialVersionUID()

7.  final case class Database(name: String = "", state: State = ..., createTime: Option[Timestamp] = _root_.scala.None, restoreInfo: Option[RestoreInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Database] with Product with Serializable

   A Cloud Spanner database.

   A Cloud Spanner database.

   name

   Required. The name of the database. Values are of the form projects/<project>/instances/<instance>/databases/<database>, where <database> is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

   state

   Output only. The current database state.

   createTime

   Output only. If exists, the time at which the database creation started.

   restoreInfo

   Output only. Applicable only for restored databases. Contains information about the restore source.

   Annotations

   @SerialVersionUID()

8.  trait DatabaseAdmin extends AnyRef

   Cloud Spanner Database Admin API The Cloud Spanner Database Admin API can be used to create, drop, and list databases.

   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.

9.  trait DatabaseAdminClient extends DatabaseAdmin with DatabaseAdminClientPowerApi with AkkaGrpcClient
10.  trait DatabaseAdminClientPowerApi extends AnyRef
11.  final class DefaultDatabaseAdminClient extends DatabaseAdminClient
12.  final case class DeleteBackupRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DeleteBackupRequest] with Product with Serializable

    The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].

    The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].

    name

    Required. Name of the backup to delete. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

    Annotations

    @SerialVersionUID()

13.  final case class DropDatabaseRequest(database: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DropDatabaseRequest] with Product with Serializable

    The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].

    The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].

    database

    Required. The database to be dropped.

    Annotations

    @SerialVersionUID()

14.  final case class GetBackupRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetBackupRequest] with Product with Serializable

    The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].

    The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].

    name

    Required. Name of the backup. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

    Annotations

    @SerialVersionUID()

15.  final case class GetDatabaseDdlRequest(database: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetDatabaseDdlRequest] with Product with Serializable

    The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].

    The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].

    database

    Required. The database whose schema we wish to get.

    Annotations

    @SerialVersionUID()

16.  final case class GetDatabaseDdlResponse(statements: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetDatabaseDdlResponse] with Product with Serializable

    The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].

    The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].

    statements

    A list of formatted DDL statements defining the schema of the database specified in the request.

    Annotations

    @SerialVersionUID()

17.  final case class GetDatabaseRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetDatabaseRequest] with Product with Serializable

    The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].

    The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].

    name

    Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

    Annotations

    @SerialVersionUID()

18.  final case class ListBackupOperationsRequest(parent: String = "", filter: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListBackupOperationsRequest] with Product with Serializable

    The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

    The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

    parent

    Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

    filter

    An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive. The following fields in the [operation][google.longrunning.Operation] are eligible for filtering: * name - The name of the long-running operation * done - False if the operation is in progress, else true. * metadata.@type - the type of metadata. For example, the type string for [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata. * metadata.<field_name> - any field in metadata.value. * error - Error associated with the long-running operation. * response.@type - the type of response. * response.<field_name> - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * done:true - The operation is complete. * metadata.database:prod - The database the backup was taken from has a name containing the string "prod". * (metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND <br/> (metadata.name:howl) AND <br/> (metadata.progress.start_time < &92;"2018-03-28T14:50:00Z&92;") AND <br/> (error:*) - Returns operations where: * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. * The backup name contains the string "howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error.

    pageSize

    Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

    pageToken

    If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token] from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the same parent and with the same filter.

    Annotations

    @SerialVersionUID()

19.  final case class ListBackupOperationsResponse(operations: Seq[Operation] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListBackupOperationsResponse] with Product with Serializable

    The response for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

    The response for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

    operations

    The list of matching backup [long-running operations][google.longrunning.Operation]. Each operation's name will be prefixed by the backup's name and the operation's [metadata][google.longrunning.Operation.metadata] will be of type [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. Operations returned include those that are pending or have completed/failed/canceled within the last 7 days. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

    nextPageToken

    next_page_token can be sent in a subsequent [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations] call to fetch more of the matching metadata.

    Annotations

    @SerialVersionUID()

20.  final case class ListBackupsRequest(parent: String = "", filter: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListBackupsRequest] with Product with Serializable

    The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].

    The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].

    parent

    Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

    filter

    An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive. The following fields in the [Backup][google.spanner.admin.database.v1.Backup] are eligible for filtering: * name * database * state * create_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * size_bytes You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * name:Howl - The backup's name contains the string "howl". * database:prod

    • The database's name contains the string "prod". * state:CREATING - The backup is pending creation. * state:READY - The backup is fully created and ready for use. * (name:howl) AND (create_time < &92;"2018-03-28T14:50:00Z&92;")
    • The backup name contains the string "howl" and create_time of the backup is before 2018-03-28T14:50:00Z. * expire_time < &92;"2018-03-28T14:50:00Z&92;"
    • The backup expire_time is before 2018-03-28T14:50:00Z. * size_bytes > 10000000000 - The backup's size is greater than 10GB

    pageSize

    Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

    pageToken

    If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same parent and with the same filter.

    Annotations

    @SerialVersionUID()

21.  final case class ListBackupsResponse(backups: Seq[Backup] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListBackupsResponse] with Product with Serializable

    The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].

    The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].

    backups

    The list of matching backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

    nextPageToken

    next_page_token can be sent in a subsequent [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups] call to fetch more of the matching backups.

    Annotations

    @SerialVersionUID()

22.  final case class ListDatabaseOperationsRequest(parent: String = "", filter: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListDatabaseOperationsRequest] with Product with Serializable

    The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].

    The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].

    parent

    Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.

    filter

    An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive. The following fields in the [Operation][google.longrunning.Operation] are eligible for filtering: * name - The name of the long-running operation * done - False if the operation is in progress, else true. * metadata.@type - the type of metadata. For example, the type string for [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata] is type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata. * metadata.<field_name> - any field in metadata.value. * error - Error associated with the long-running operation. * response.@type - the type of response. * response.<field_name> - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * done:true - The operation is complete. * (metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND <br/> (metadata.source_type:BACKUP) AND <br/> (metadata.backup_info.backup:backup_howl) AND <br/> (metadata.name:restored_howl) AND <br/> (metadata.progress.start_time < &92;"2018-03-28T14:50:00Z&92;") AND <br/> (error:*) - Return operations where: * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. * The database is restored from a backup. * The backup name contains "backup_howl". * The restored database's name contains "restored_howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error.

    pageSize

    Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

    pageToken

    If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token] from a previous [ListDatabaseOperationsResponse][google.spanner.admin.database.v1.ListDatabaseOperationsResponse] to the same parent and with the same filter.

    Annotations

    @SerialVersionUID()

23.  final case class ListDatabaseOperationsResponse(operations: Seq[Operation] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListDatabaseOperationsResponse] with Product with Serializable

    The response for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].

    The response for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].

    operations

    The list of matching database [long-running operations][google.longrunning.Operation]. Each operation's name will be prefixed by the database's name. The operation's [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata.

    nextPageToken

    next_page_token can be sent in a subsequent [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations] call to fetch more of the matching metadata.

    Annotations

    @SerialVersionUID()

24.  final case class ListDatabasesRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListDatabasesRequest] with Product with Serializable

    The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].

    The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].

    parent

    Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.

    pageSize

    Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

    pageToken

    If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].

    Annotations

    @SerialVersionUID()

25.  final case class ListDatabasesResponse(databases: Seq[Database] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListDatabasesResponse] with Product with Serializable

    The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].

    The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].

    databases

    Databases that matched the request.

    nextPageToken

    next_page_token can be sent in a subsequent [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more of the matching databases.

    Annotations

    @SerialVersionUID()

26.  final case class OperationProgress(progressPercent: Int = 0, startTime: Option[Timestamp] = _root_.scala.None, endTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[OperationProgress] with Product with Serializable

    Encapsulates progress related information for a Cloud Spanner long running operation.

    Encapsulates progress related information for a Cloud Spanner long running operation.

    progressPercent

    Percent completion of the operation. Values are between 0 and 100 inclusive.

    startTime

    Time the request was received.

    endTime

    If set, the time at which this operation failed or was completed successfully.

    Annotations

    @SerialVersionUID()

27.  final case class OptimizeRestoredDatabaseMetadata(name: String = "", progress: Option[OperationProgress] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[OptimizeRestoredDatabaseMetadata] with Product with Serializable

    Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database.

    Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database. This long-running operation is automatically created by the system after the successful completion of a database restore, and cannot be cancelled.

    name

    Name of the restored database being optimized.

    progress

    The progress of the post-restore optimizations.

    Annotations

    @SerialVersionUID()

28.  final case class RestoreDatabaseMetadata(name: String = "", sourceType: RestoreSourceType = ..., sourceInfo: SourceInfo = ..., progress: Option[OperationProgress] = _root_.scala.None, cancelTime: Option[Timestamp] = _root_.scala.None, optimizeDatabaseOperationName: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[RestoreDatabaseMetadata] with Product with Serializable

    Metadata type for the long-running operation returned by [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

    Metadata type for the long-running operation returned by [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

    name

    Name of the database being created and restored to.

    sourceType

    The type of the restore source.

    progress

    The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.

    cancelTime

    The time at which cancellation of this operation was received. [Operations.CancelOperation][google.longrunning.Operations.CancelOperation] starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

    optimizeDatabaseOperationName

    If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation> where the <database> is the name of database being created and restored to. The metadata type of the long-running operation is [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata]. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.

    Annotations

    @SerialVersionUID()

29.  final case class RestoreDatabaseRequest(parent: String = "", databaseId: String = "", source: Source = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[RestoreDatabaseRequest] with Product with Serializable

    The request for [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

    The request for [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

    parent

    Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

    databaseId

    Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

    Annotations

    @SerialVersionUID()

30.  final case class RestoreInfo(sourceType: RestoreSourceType = ..., sourceInfo: SourceInfo = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[RestoreInfo] with Product with Serializable

    Information about the database restore.

    Information about the database restore.

    sourceType

    The type of the restore source.

    Annotations

    @SerialVersionUID()

31.  sealed abstract class RestoreSourceType extends GeneratedEnum

    Indicates the type of the restore source.

32.  final case class UpdateBackupRequest(backup: Option[Backup] = _root_.scala.None, updateMask: Option[FieldMask] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateBackupRequest] with Product with Serializable

    The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].

    The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].

    backup

    Required. The backup to update. backup.name, and the fields to be updated as specified by update_mask are required. Other fields are ignored. Update is only supported for the following fields: * backup.expire_time.

    updateMask

    Required. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

    Annotations

    @SerialVersionUID()

33.  final case class UpdateDatabaseDdlMetadata(database: String = "", statements: Seq[String] = _root_.scala.Seq.empty, commitTimestamps: Seq[Timestamp] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateDatabaseDdlMetadata] with Product with Serializable

    Metadata type for the operation returned by [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].

    Metadata type for the operation returned by [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].

    database

    The database being modified.

    statements

    For an update this list contains all the statements. For an individual statement, this list contains only that statement.

    commitTimestamps

    Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

    Annotations

    @SerialVersionUID()

34.  final case class UpdateDatabaseDdlRequest(database: String = "", statements: Seq[String] = _root_.scala.Seq.empty, operationId: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateDatabaseDdlRequest] with Product with Serializable

    Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future.

    Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a NULL value in a column to which NOT NULL would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled.

    Each batch of statements is assigned a name which can be used with the [Operations][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more details.

    database

    Required. The database to update.

    statements

    Required. DDL statements to be applied to the database.

    operationId

    If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, operation_id is used to construct the name of the resulting [Operation][google.longrunning.Operation]. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] call is replayed, or the return value is otherwise lost: the [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database] and operation_id fields can be combined to form the [name][google.longrunning.Operation.name] of the resulting [longrunning.Operation][google.longrunning.Operation]: <database>/operations/<operation_id>. operation_id should be unique within the database, and must be a valid identifier: [a-z][a-z0-9_]*. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] returns ALREADY_EXISTS.

    Annotations

    @SerialVersionUID()