# CloneDatabaseMetadata

Metadata for the `https://firebase.google.com/docs/firestore/reference/rest/Shared.Types/Operation` from the \[databases.clone\]\[google.firestore.admin.v1.CloneDatabase\] request.

| JSON representation |
|---|
| ``` { "startTime": string, "endTime": string, "operationState": enum (`https://firebase.google.com/docs/firestore/reference/rest/Shared.Types/OperationState`), "database": string, "pitrSnapshot": { object (`https://firebase.google.com/docs/firestore/reference/rest/Shared.Types/CloneDatabaseMetadata#PitrSnapshot`) }, "progressPercentage": { object (`https://firebase.google.com/docs/firestore/reference/rest/Shared.Types/Progress`) } } ``` |

| Fields ||
|---|---|
| `startTime` | ``string (`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 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"`. |
| `endTime` | ``string (`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 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"`. |
| `operationState` | ``enum (`https://firebase.google.com/docs/firestore/reference/rest/Shared.Types/OperationState`)`` The operation state of the clone. |
| `database` | `string` The name of the database being cloned to. |
| `pitrSnapshot` | ``object (`https://firebase.google.com/docs/firestore/reference/rest/Shared.Types/CloneDatabaseMetadata#PitrSnapshot`)`` The snapshot from which this database was cloned. |
| `progressPercentage` | ``object (`https://firebase.google.com/docs/firestore/reference/rest/Shared.Types/Progress`)`` How far along the clone is as an estimated percentage of remaining time. |

## PitrSnapshot

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

| JSON representation |
|---|
| ``` { "database": string, "databaseUid": string, "snapshotTime": string } ``` |

| Fields ||
|---|---|
| `database` | `string` Required. The name of the database that this was a snapshot of. Format: `projects/{project}/databases/{database}`. |
| `databaseUid` | `string (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. |
| `snapshotTime` | ``string (`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 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"`. |