# Cloud Firestore V1 Client - Class RestoreDatabaseMetadata (2.2.0-RC1)

2.2.0-RC1 2.1.0 (latest) 2.0.2-RC1 1.55.0 1.54.4 1.53.1 1.52.0 1.51.0 1.50.0 1.48.1 1.47.3 1.46.0 1.45.2 1.44.1 1.43.3 1.40.0 1.39.0 1.38.0 1.37.7 1.36.1 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.28.0 1.27.3 Reference documentation and code samples for the Cloud Firestore V1 Client class RestoreDatabaseMetadata.

Metadata for the long-running operation from
the RestoreDatabase request.

Generated from protobuf message `google.firestore.admin.v1.RestoreDatabaseMetadata`

## Namespace

Google \\ Cloud \\ Firestore \\ Admin \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ start_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time the restore was started. |
| `↳ end_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time the restore finished, unset for ongoing restores. |
| `↳ operation_state` | `int` The operation state of the restore. |
| `↳ database` | `string` The name of the database being restored to. |
| `↳ backup` | `string` The name of the backup restoring from. |
| `↳ progress_percentage` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/Admin.V1.Progress` How far along the restore is as an estimated percentage of remaining time. |

### getStartTime

The time the restore was started.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasStartTime

### clearStartTime

### setStartTime

The time the restore was started.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEndTime

The time the restore finished, unset for ongoing restores.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasEndTime

### clearEndTime

### setEndTime

The time the restore finished, unset for ongoing restores.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOperationState

The operation state of the restore.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [OperationState](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/Admin.V1.OperationState). |

### setOperationState

The operation state of the restore.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [OperationState](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/Admin.V1.OperationState). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDatabase

The name of the database being restored to.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDatabase

The name of the database being restored to.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBackup

The name of the backup restoring from.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setBackup

The name of the backup restoring from.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getProgressPercentage

How far along the restore is as an estimated percentage of remaining time.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/Admin.V1.Progress|null` |   |

### hasProgressPercentage

### clearProgressPercentage

### setProgressPercentage

How far along the restore is as an estimated percentage of remaining time.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/Admin.V1.Progress` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |