# Cloud Bigtable V2 Client - Class RestoreTableMetadata (2.25.0)

2.25.0 (latest) 2.24.0 2.23.0 2.22.0 2.21.1 2.20.2 2.19.2 2.18.0 2.17.1 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.1 2.9.1 2.8.0 2.7.0 2.6.3 2.5.0 2.4.0 2.3.0 2.2.1 2.1.0 2.0.1 1.32.1 1.31.1 1.30.0 1.29.2 1.28.3 1.27.0 1.26.2 1.25.0 1.24.1 1.23.0 1.22.2 1.21.1 1.20.3 Reference documentation and code samples for the Cloud Bigtable V2 Client class RestoreTableMetadata.

Metadata type for the long-running operation returned by
[RestoreTable](https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__restoreTable__).

Generated from protobuf message `google.bigtable.admin.v2.RestoreTableMetadata`

## Namespace

Google \\ Cloud \\ Bigtable \\ Admin \\ V2

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Name of the table being created and restored to. |
| `↳ source_type` | `int` The type of the restore source. |
| `↳ backup_info` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.BackupInfo` |
| `↳ optimize_table_operation_name` | `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 table. The metadata type of the long-running operation is OptimizeRestoreTableMetadata. The response type is [Empty](https://protobuf.dev/reference/php/api-docs/Empty). This long-running operation may be automatically created by the system if applicable after the RestoreTable long-running operation completes successfully. This operation may not be created if the table is already optimized or the restore was not successful. |
| `↳ progress` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.OperationProgress` The progress of the [RestoreTable](https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__restoreTable__) operation. |

### getName

Name of the table being created and restored to.

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

### setName

Name of the table being created and restored to.

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

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

### getSourceType

The type of the restore source.

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

### setSourceType

The type of the restore source.

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

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

### getBackupInfo

Generated from protobuf field `.google.bigtable.admin.v2.BackupInfo backup_info = 3;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.BackupInfo|null` |   |

### hasBackupInfo

### setBackupInfo

Generated from protobuf field `.google.bigtable.admin.v2.BackupInfo backup_info = 3;`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.BackupInfo` |

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

### getOptimizeTableOperationName

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 table. The metadata type of the long-running operation is
OptimizeRestoreTableMetadata. The response type is
[Empty](https://protobuf.dev/reference/php/api-docs/Empty). This long-running operation may be
automatically created by the system if applicable after the
RestoreTable long-running operation completes successfully. This operation
may not be created if the table is already optimized or the restore was
not successful.

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

### setOptimizeTableOperationName

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 table. The metadata type of the long-running operation is
OptimizeRestoreTableMetadata. The response type is
[Empty](https://protobuf.dev/reference/php/api-docs/Empty). This long-running operation may be
automatically created by the system if applicable after the
RestoreTable long-running operation completes successfully. This operation
may not be created if the table is already optimized or the restore was
not successful.

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

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

### getProgress

The progress of the
[RestoreTable](https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__restoreTable__)
operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.OperationProgress|null` |   |

### hasProgress

### clearProgress

### setProgress

The progress of the
[RestoreTable](https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__restoreTable__)
operation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigtable/latest/Admin.V2.OperationProgress` |

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

### getSourceInfo

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