Google Cloud Gke Backup V1 Client - Class UpdateRestorePlanRequest (1.0.2)

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

Request message for UpdateRestorePlan.

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

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ restore_plan`	`RestorePlan` Required. A new version of the RestorePlan 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 RestorePlan targeted for update. The values for each of these updated fields will be taken from the `restore_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore_plan` will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are not used to update the target RestorePlan.

getRestorePlan

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

Returns
Type	Description
`RestorePlan\|null`

hasRestorePlan

clearRestorePlan

setRestorePlan

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

Parameter
Name	Description
`var`	`RestorePlan`

Returns
Type	Description
`$this`

getUpdateMask

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

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

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
`restorePlan`	`RestorePlan` Required. A new version of the RestorePlan 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 RestorePlan targeted for update. The values for each of these updated fields will be taken from the `restore_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore_plan` will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are not used to update the target RestorePlan.

Returns
Type	Description
`UpdateRestorePlanRequest`