Google Cloud Backup Dr V1 Client - Class RunRestoreTemplateRequest (0.17.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class RunRestoreTemplateRequest.

Request message for running a RestoreTemplate.

Generated from protobuf message google.cloud.backupdr.v1.RunRestoreTemplateRequest

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

↳ backup string

Optional. The resource name of the Backup to restore from. If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

↳ 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 request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getName

Required. The name of the restore template to run.

Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

Returns
Type Description
string

setName

Required. The name of the restore template to run.

Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

Parameter
Name Description
var string
Returns
Type Description
$this

getBackup

Optional. The resource name of the Backup to restore from.

If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

Returns
Type Description
string

setBackup

Optional. The resource name of the Backup to restore from.

If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

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 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 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

static::build

Parameter
Name Description
name string

Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}' Please see BackupDRClient::restoreTemplateName() for help formatting this field.

Returns
Type Description
RunRestoreTemplateRequest