Google Cloud Backup Dr V1beta Client - Class DeleteRestoreTemplateRequest (0.17.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class DeleteRestoreTemplateRequest.

Request message for deleting a RestoreTemplate instance.

Generated from protobuf message google.cloud.backupdr.v1beta.DeleteRestoreTemplateRequest

Namespace

Google \ Cloud \ BackupDR \ V1beta

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 delete. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

↳ 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).

↳ force bool

Optional. If set to true, any child RestoreTemplateExecutions will also be deleted. If false and the RestoreTemplate has any child executions, the request will fail.

getName

Required. The name of the restore template to delete.

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

Returns
Type Description
string

setName

Required. The name of the restore template to delete.

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

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

getForce

Optional. If set to true, any child RestoreTemplateExecutions will also be deleted. If false and the RestoreTemplate has any child executions, the request will fail.

Returns
Type Description
bool

setForce

Optional. If set to true, any child RestoreTemplateExecutions will also be deleted. If false and the RestoreTemplate has any child executions, the request will fail.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

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

Returns
Type Description
DeleteRestoreTemplateRequest