Google Cloud Backup Dr V1 Client - Class RestoreBackupRequest (0.12.1)
Stay organized with collections
Save and categorize content based on your preferences.
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 \ V1
Methods
__construct
Constructor.
Parameter
Name
Description
data
mixed
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.
Optional. A field mask used to clear server-side default values
for fields within the instance_properties oneof.
When a field in this mask is cleared, the server will not apply its
default logic (like inheriting a value from the source) for that field.
The most common current use case is clearing default encryption keys.
Examples of field mask paths:
Optional. A field mask used to clear server-side default values
for fields within the instance_properties oneof.
When a field in this mask is cleared, the server will not apply its
default logic (like inheriting a value from the source) for that field.
The most common current use case is clearing default encryption keys.
Examples of field mask paths:
Required. The resource name of the Backup instance, in the format
'projects//locations//backupVaults//dataSources//backups/'. Please see
BackupDRClient::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 2026-03-19 UTC."],[],[]]
