RestoreDatabaseMetadata

Metadata type for the long-running operation returned bydatabases.restore.

JSON representation
{"name":string,"sourceType":enum (RestoreSourceType),"progress":{object (OperationProgress)},"cancelTime":string,"optimizeDatabaseOperationName":string,// Union fieldsource_info can be only one of the following:"backupInfo":{object (BackupInfo)}// End of list of possible types for union fieldsource_info.}
Fields
name

string

Name of the database being created and restored to.

sourceType

enum (RestoreSourceType)

The type of the restore source.

progress

object (OperationProgress)

The progress of thedatabases.restore operation.

cancelTime

string (Timestamp format)

The time at which cancellation of this operation was received.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 useOperations.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 agoogle.rpc.Status.code of 1, corresponding toCode.CANCELLED.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

optimizeDatabaseOperationName

string

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 formprojects/<project>/instances/<instance>/databases/<database>/operations/<operation> where the is the name of database being created and restored to. The metadata type of the long-running operation isOptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the databases.restore long-running operation completes successfully. This operation will not be created if the restore was not successful.

Union fieldsource_info. Information about the source used to restore the database, as specified bysource inRestoreDatabaseRequest.source_info can be only one of the following:
backupInfo

object (BackupInfo)

Information about the backup used to restore the database.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-04 UTC.