Google Cloud Managed Kafka V1 Client - Class UpdateClusterRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class UpdateClusterRequest.

Request for UpdateCluster.

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

Namespace

Google \ Cloud \ ManagedKafka \ 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 update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
`↳ cluster`	`Google\Cloud\ManagedKafka\V1\Cluster` Required. The cluster to update. Its `name` field must be populated.
`↳ request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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 update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

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

hasUpdateMask

clearUpdateMask

setUpdateMask

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

Returns
Type	Description
`$this`

getCluster

Required. The cluster to update. Its name field must be populated.

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

hasCluster

clearCluster

setCluster

Required. The cluster to update. Its name field must be populated.

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

Returns
Type	Description
`$this`

getRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type	Description
`string`

setRequestId

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`cluster`	`Google\Cloud\ManagedKafka\V1\Cluster` Required. The cluster to update. Its `name` field must be populated.
`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 update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

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