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

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ restore_plan Google\Cloud\GkeBackup\V1\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

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
TypeDescription
Google\Cloud\GkeBackup\V1\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
NameDescription
var Google\Cloud\GkeBackup\V1\RestorePlan
Returns
TypeDescription
$this

getUpdateMask

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
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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.

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

static::build

Parameters
NameDescription
restorePlan Google\Cloud\GkeBackup\V1\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

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
TypeDescription
Google\Cloud\GkeBackup\V1\UpdateRestorePlanRequest