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

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

Request message for updating an AutoProtectionPolicy.

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

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ auto_protection_policy AutoProtectionPolicy

Required. The policy to update.

↳ update_mask Google\Protobuf\FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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. If the user does not provide a mask then all fields will be overwritten.

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

getAutoProtectionPolicy

Required. The policy to update.

Returns
Type Description
AutoProtectionPolicy|null

hasAutoProtectionPolicy

clearAutoProtectionPolicy

setAutoProtectionPolicy

Required. The policy to update.

Parameter
Name Description
var AutoProtectionPolicy
Returns
Type Description
$this

getUpdateMask

Optional. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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. If the user does not provide a mask then all fields will be overwritten.

Parameter
Name Description
var Google\Protobuf\FieldMask
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 since the first request.

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 since the first request.

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

Parameters
Name Description
autoProtectionPolicy AutoProtectionPolicy

Required. The policy to update.

updateMask Google\Protobuf\FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
UpdateAutoProtectionPolicyRequest