Google Cloud Gke Backup V1 Client - Class UpdateBackupRequest (0.7.2)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class UpdateBackupRequest.

Request message for UpdateBackup.

Generated from protobuf message google.cloud.gkebackup.v1.UpdateBackupRequest

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ backup`	`Google\Cloud\GkeBackup\V1\Backup` Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`↳ update_mask`	`Google\Protobuf\FieldMask` Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.

getBackup

Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\Backup\|null`

hasBackup

clearBackup

setBackup

Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

Parameter
Name	Description
`var`	`Google\Cloud\GkeBackup\V1\Backup`

Returns
Type	Description
`$this`

getUpdateMask

Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource.

If no update_mask is provided, all fields in backup will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup are ignored and are not used to update the target Backup.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`backup`	`Google\Cloud\GkeBackup\V1\Backup` Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`updateMask`	`Google\Protobuf\FieldMask` Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\UpdateBackupRequest`