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

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

Request message for updating a RestoreTemplate instance.

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

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ update_mask Google\Protobuf\FieldMask

Optional. The list of fields to update. Field mask is used to specify the fields to be overwritten in the RestoreTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

↳ restore_template RestoreTemplate

Required. The restore template to update.

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

↳ validate_only bool

Optional. Only validate the request, but do not perform mutations. The default is 'false'.

getUpdateMask

Optional. The list of fields to update.

Field mask is used to specify the fields to be overwritten in the RestoreTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. The list of fields to update.

Field mask is used to specify the fields to be overwritten in the RestoreTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getRestoreTemplate

Required. The restore template to update.

Returns
Type Description
RestoreTemplate|null

hasRestoreTemplate

clearRestoreTemplate

setRestoreTemplate

Required. The restore template to update.

Parameter
Name Description
var RestoreTemplate
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

getValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is 'false'.

Returns
Type Description
bool

setValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is 'false'.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
restoreTemplate RestoreTemplate

Required. The restore template to update.

updateMask Google\Protobuf\FieldMask

Optional. The list of fields to update. Field mask is used to specify the fields to be overwritten in the RestoreTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

Returns
Type Description
UpdateRestoreTemplateRequest