Reference documentation and code samples for the Cloud Spanner V1 Client class RestoreDatabaseMetadata.
Metadata type for the long-running operation returned by RestoreDatabase.
Generated from protobuf message google.spanner.admin.database.v1.RestoreDatabaseMetadata
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Name of the database being created and restored to. |
↳ source_type |
int
The type of the restore source. |
↳ backup_info |
Google\Cloud\Spanner\Admin\Database\V1\BackupInfo
Information about the backup used to restore the database. |
↳ progress |
Google\Cloud\Spanner\Admin\Database\V1\OperationProgress
The progress of the RestoreDatabase operation. |
↳ cancel_time |
Google\Protobuf\Timestamp
The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to |
↳ optimize_database_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 database, and remove the dependency on the restore source. The name is of the form
|
getName
Name of the database being created and restored to.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Name of the database 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
Information about the backup used to restore the database.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Database\V1\BackupInfo|null | |
hasBackupInfo
setBackupInfo
Information about the backup used to restore the database.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\Admin\Database\V1\BackupInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgress
The progress of the RestoreDatabase operation.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Database\V1\OperationProgress|null | |
hasProgress
clearProgress
setProgress
The progress of the RestoreDatabase operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\Admin\Database\V1\OperationProgress
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCancelTime
The time at which cancellation of this operation was received.
Operations.CancelOperation
starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not guaranteed.
Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a
google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCancelTime
clearCancelTime
setCancelTime
The time at which cancellation of this operation was received.
Operations.CancelOperation
starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not guaranteed.
Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a
google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOptimizeDatabaseOperationName
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 database, and remove the dependency on the restore source.
The name is of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>
where the
| Returns | |
|---|---|
| Type | Description |
string | |
setOptimizeDatabaseOperationName
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 database, and remove the dependency on the restore source.
The name is of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>
where the
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSourceInfo
| Returns | |
|---|---|
| Type | Description |
string | |