Reference documentation and code samples for the Cloud Bigtable V2 Client class RestoreTableMetadata.
Metadata type for the long-running operation returned by RestoreTable.
Generated from protobuf message google.bigtable.admin.v2.RestoreTableMetadata
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 |
Google\Cloud\Bigtable\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. 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 |
Google\Cloud\Bigtable\Admin\V2\OperationProgress
The progress of the 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 | |
setSourceType
The type of the restore source.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBackupInfo
Generated from protobuf field .google.bigtable.admin.v2.BackupInfo backup_info = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\BackupInfo|null | |
hasBackupInfo
setBackupInfo
Generated from protobuf field .google.bigtable.admin.v2.BackupInfo backup_info = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\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. 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. 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 operation.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\Admin\V2\OperationProgress|null | |
hasProgress
clearProgress
setProgress
The progress of the RestoreTable operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\OperationProgress
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSourceInfo
| Returns | |
|---|---|
| Type | Description |
string | |