# Google Cloud Managed Kafka V1 Client - Class UpdateConsumerGroupRequest (0.8.0)

0.8.0 (latest) 0.7.2 0.6.1 0.5.0 0.4.1 0.3.1 0.2.3 0.1.3 Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class UpdateConsumerGroupRequest.

Request for UpdateConsumerGroup.

Generated from protobuf message `google.cloud.managedkafka.v1.UpdateConsumerGroupRequest`

## Namespace

Google \\ Cloud \\ ManagedKafka \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ update_mask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup 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. |
| `↳ consumer_group` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.ConsumerGroup` Required. The consumer group to update. Its `name` field must be populated. |

### getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the
ConsumerGroup 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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask|null` |   |

### hasUpdateMask

### clearUpdateMask

### setUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the
ConsumerGroup 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getConsumerGroup

Required. The consumer group to update. Its `name` field must be populated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.ConsumerGroup|null` |   |

### hasConsumerGroup

### clearConsumerGroup

### setConsumerGroup

Required. The consumer group to update. Its `name` field must be populated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.ConsumerGroup` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `consumerGroup` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.ConsumerGroup` Required. The consumer group to update. Its `name` field must be populated. |
| `updateMask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup 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** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.UpdateConsumerGroupRequest` |   |