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 | |
|---|---|
| Name | Description |
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 |
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 |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\UpdateBackupPlanRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
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 |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\BackupPlan
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |