CloneDatabaseMetadata
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-26 UTC.
[null,null,["Last updated 2025-08-26 UTC."],[],[],null,["# CloneDatabaseMetadata\n\nMetadata for the [long-running operation](/docs/firestore/reference/rest/Shared.Types/Operation) from the \\[databases.clone\\]\\[google.firestore.admin.v1.CloneDatabase\\] request.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"startTime\": string, \"endTime\": string, \"operationState\": enum (/docs/firestore/reference/rest/Shared.Types/OperationState), \"database\": string, \"pitrSnapshot\": { object (/docs/firestore/reference/rest/Shared.Types/CloneDatabaseMetadata#PitrSnapshot) }, \"progressPercentage\": { object (/docs/firestore/reference/rest/Shared.Types/Progress) } } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `startTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` The time the clone was started. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n| `endTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` The time the clone finished, unset for ongoing clones. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n| `operationState` | `enum (`[OperationState](/docs/firestore/reference/rest/Shared.Types/OperationState)`)` The operation state of the clone. |\n| `database` | `string` The name of the database being cloned to. |\n| `pitrSnapshot` | `object (`[PitrSnapshot](/docs/firestore/reference/rest/Shared.Types/CloneDatabaseMetadata#PitrSnapshot)`)` The snapshot from which this database was cloned. |\n| `progressPercentage` | `object (`[Progress](/docs/firestore/reference/rest/Shared.Types/Progress)`)` How far along the clone is as an estimated percentage of remaining time. |\n\nPitrSnapshot\n------------\n\nA consistent snapshot of a database at a specific point in time. A PITR (Point-in-time recovery) snapshot with previous versions of a database's data is available for every minute up to the associated database's data retention period. If the PITR feature is enabled, the retention period is 7 days; otherwise, it is one hour.\n\n| JSON representation |\n|-------------------------------------------------------------------------------|\n| ``` { \"database\": string, \"databaseUid\": string, \"snapshotTime\": string } ``` |\n\n| Fields ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `database` | `string` Required. The name of the database that this was a snapshot of. Format: `projects/{project}/databases/{database}`. |\n| `databaseUid` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` Output only. Public UUID of the database the snapshot was associated with. A base64-encoded string. |\n| `snapshotTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Required. Snapshot time of the database. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |"]]
