Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class RestoreBackupRequest.
Request message for restoring from a Backup.
Generated from protobuf message google.cloud.backupdr.v1.RestoreBackupRequest
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name of the Backup instance, in the format 'projects//locations//backupVaults//dataSources//backups/'. |
↳ request_id |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ compute_instance_target_environment |
Google\Cloud\BackupDR\V1\ComputeInstanceTargetEnvironment
Compute Engine target environment to be used during restore. |
↳ compute_instance_restore_properties |
Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties
Compute Engine instance properties to be overridden during restore. |
getName
Required. The resource name of the Backup instance, in the format 'projects//locations//backupVaults//dataSources//backups/'.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of the Backup instance, in the format 'projects//locations//backupVaults//dataSources//backups/'.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string |
|
setRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComputeInstanceTargetEnvironment
Compute Engine target environment to be used during restore.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\ComputeInstanceTargetEnvironment|null |
|
hasComputeInstanceTargetEnvironment
setComputeInstanceTargetEnvironment
Compute Engine target environment to be used during restore.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BackupDR\V1\ComputeInstanceTargetEnvironment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComputeInstanceRestoreProperties
Compute Engine instance properties to be overridden during restore.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties|null |
|
hasComputeInstanceRestoreProperties
setComputeInstanceRestoreProperties
Compute Engine instance properties to be overridden during restore.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BackupDR\V1\ComputeInstanceRestoreProperties
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetEnvironment
| Returns | |
|---|---|
| Type | Description |
string |
|
getInstanceProperties
| Returns | |
|---|---|
| Type | Description |
string |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The resource name of the Backup instance, in the format 'projects//locations//backupVaults//dataSources//backups/'. Please see Google\Cloud\BackupDR\V1\BackupDRClient::backupName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\RestoreBackupRequest |
|