Method: projects.locations.clusters.consumerGroups.patch

Updates the properties of a single consumer group.

HTTP request

PATCH https://managedkafka.googleapis.com/v1/{consumerGroup.name=projects/*/locations/*/clusters/*/consumerGroups/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
consumerGroup.name

string

Identifier. The name of the consumer group. The consumerGroup segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup 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. The mask is required and a value of * will update all fields.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of ConsumerGroup.

Response body

If successful, the response body contains an instance of ConsumerGroup.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedkafka.consumerGroups.update

For more information, see the IAM documentation.