Google Cloud Vmware Engine V1 Client - Class UpdateClusterRequest (0.2.1)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class UpdateClusterRequest.

Request message for VmwareEngine.UpdateCluster

Generated from protobuf message google.cloud.vmwareengine.v1.UpdateClusterRequest

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ update_mask`	`Google\Protobuf\FieldMask` Required. Field mask is used to specify the fields to be overwritten in the `Cluster` resource by the update. The fields specified in the `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`↳ cluster`	`Google\Cloud\VmwareEngine\V1\Cluster` Required. The description of the cluster.
`↳ request_id`	`string` Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`↳ validate_only`	`bool` Optional. True if you want the request to be validated and not executed; false otherwise.

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

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

hasUpdateMask

clearUpdateMask

setUpdateMask

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

Returns
Type	Description
`$this`

getCluster

Required. The description of the cluster.

Returns
Type	Description
`Google\Cloud\VmwareEngine\V1\Cluster\|null`

hasCluster

clearCluster

setCluster

Required. The description of the cluster.

Parameter
Name	Description
`var`	`Google\Cloud\VmwareEngine\V1\Cluster`

Returns
Type	Description
`$this`

getRequestId

Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type	Description
`string`

setRequestId

Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getValidateOnly

Optional. True if you want the request to be validated and not executed; false otherwise.

Returns
Type	Description
`bool`

setValidateOnly

Optional. True if you want the request to be validated and not executed; false otherwise.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`cluster`	`Google\Cloud\VmwareEngine\V1\Cluster` Required. The description of the cluster.
`updateMask`	`Google\Protobuf\FieldMask` Required. Field mask is used to specify the fields to be overwritten in the `Cluster` resource by the update. The fields specified in the `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type	Description
`Google\Cloud\VmwareEngine\V1\UpdateClusterRequest`