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 messagegoogle.cloud.backupdr.v1.RestoreBackupRequest
Namespace
Google \ Cloud \ BackupDR \ V1
Methods
__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).
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.
Required. The resource name of the Backup instance, in the format
'projects//locations//backupVaults//dataSources//backups/'. Please seeBackupDRClient::backupName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Backup Dr V1 Client - Class RestoreBackupRequest (0.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.7.0 (latest)](/php/docs/reference/cloud-backupdr/latest/V1.RestoreBackupRequest)\n- [0.6.2](/php/docs/reference/cloud-backupdr/0.6.2/V1.RestoreBackupRequest)\n- [0.5.1](/php/docs/reference/cloud-backupdr/0.5.1/V1.RestoreBackupRequest)\n- [0.4.2](/php/docs/reference/cloud-backupdr/0.4.2/V1.RestoreBackupRequest)\n- [0.3.0](/php/docs/reference/cloud-backupdr/0.3.0/V1.RestoreBackupRequest)\n- [0.2.0](/php/docs/reference/cloud-backupdr/0.2.0/V1.RestoreBackupRequest)\n- [0.1.0](/php/docs/reference/cloud-backupdr/0.1.0/V1.RestoreBackupRequest) \nReference documentation and code samples for the Google Cloud Backup Dr V1 Client class RestoreBackupRequest.\n\nRequest message for restoring from a Backup.\n\nGenerated from protobuf message `google.cloud.backupdr.v1.RestoreBackupRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BackupDR \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The resource name of the Backup instance, in the format\n'projects/*/locations/* /backupVaults/*/dataSources/*/backups/'.\n\n### setName\n\nRequired. The resource name of the Backup instance, in the format\n'projects/*/locations/* /backupVaults/*/dataSources/*/backups/'.\n\n### getRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server will know to\nignore the request if it has already been completed. The server will\nguarantee that for at least 60 minutes after the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if original operation with the same request ID\nwas received, and if so, will ignore the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server will know to\nignore the request if it has already been completed. The server will\nguarantee that for at least 60 minutes after the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if original operation with the same request ID\nwas received, and if so, will ignore the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### getComputeInstanceTargetEnvironment\n\nCompute Engine target environment to be used during restore.\n\n### hasComputeInstanceTargetEnvironment\n\n### setComputeInstanceTargetEnvironment\n\nCompute Engine target environment to be used during restore.\n\n### getDiskTargetEnvironment\n\nDisk target environment to be used during restore.\n\n### hasDiskTargetEnvironment\n\n### setDiskTargetEnvironment\n\nDisk target environment to be used during restore.\n\n### getRegionDiskTargetEnvironment\n\nRegion disk target environment to be used during restore.\n\n### hasRegionDiskTargetEnvironment\n\n### setRegionDiskTargetEnvironment\n\nRegion disk target environment to be used during restore.\n\n### getComputeInstanceRestoreProperties\n\nCompute Engine instance properties to be overridden during restore.\n\n### hasComputeInstanceRestoreProperties\n\n### setComputeInstanceRestoreProperties\n\nCompute Engine instance properties to be overridden during restore.\n\n### getDiskRestoreProperties\n\nDisk properties to be overridden during restore.\n\n### hasDiskRestoreProperties\n\n### setDiskRestoreProperties\n\nDisk properties to be overridden during restore.\n\n### getTargetEnvironment\n\n### getInstanceProperties\n\n### static::build"]]
