Google Cloud Gke Backup V1 Client - Class UpdateBackupPlanRequest (0.2.0)

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

Request message for UpdateBackupPlan.

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

Methods

build

Parameters
NameDescription
backupPlan Google\Cloud\GkeBackup\V1\BackupPlan

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

updateMask Google\Protobuf\FieldMask

This is used to specify the fields to be overwritten in the BackupPlan 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 (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\UpdateBackupPlanRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ backup_plan Google\Cloud\GkeBackup\V1\BackupPlan

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

↳ update_mask Google\Protobuf\FieldMask

This is used to specify the fields to be overwritten in the BackupPlan 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 (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

getBackupPlan

Required. A new version of the BackupPlan resource that contains updated fields.

This may be sparsely populated if an update_mask is provided.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\BackupPlan|null

hasBackupPlan

clearBackupPlan

setBackupPlan

Required. A new version of the BackupPlan resource that contains updated fields.

This may be sparsely populated if an update_mask is provided.

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\BackupPlan
Returns
TypeDescription
$this

getUpdateMask

This is used to specify the fields to be overwritten in the BackupPlan 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 (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource.

Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

This is used to specify the fields to be overwritten in the BackupPlan 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 (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource.

Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this