Google Cloud Backup Dr V1 Client - Class UpdateBackupVaultRequest (0.7.0)

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

Request message for updating a BackupVault.

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

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

Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail.

↳ backup_vault
BackupVault

Required. The resource being updated

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

↳ validate_only
bool

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

↳ force
bool

Optional. If set to true, will not check plan duration against backup vault enforcement duration.

↳ force_update_access_restriction
bool

Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail.

Returns
Type
Description

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail.

Parameter
Name
Description
Returns
Type
Description
$this

getBackupVault

Required. The resource being updated

Returns
Type
Description
BackupVault |null

hasBackupVault

clearBackupVault

setBackupVault

Required. The resource being updated

Parameter
Name
Description
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.

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

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

getForce

Optional. If set to true, will not check plan duration against backup vault enforcement duration.

Returns
Type
Description
bool

setForce

Optional. If set to true, will not check plan duration against backup vault enforcement duration.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getForceUpdateAccessRestriction

Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.

Returns
Type
Description
bool

setForceUpdateAccessRestriction

Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

static::build

Parameters
Name
Description
backupVault
BackupVault

Required. The resource being updated

updateMask
Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: