# REST Resource: projects.locations.clusters.consumerGroups

- [Resource: ConsumerGroup](https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerGroup)
  - [JSON representation](https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerGroup.SCHEMA_REPRESENTATION)
- [ConsumerTopicMetadata](https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerTopicMetadata)
  - [JSON representation](https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerTopicMetadata.SCHEMA_REPRESENTATION)
- [ConsumerPartitionMetadata](https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerPartitionMetadata)
  - [JSON representation](https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerPartitionMetadata.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#METHODS_SUMMARY)

## Resource: ConsumerGroup

A Kafka consumer group in a given cluster.

| JSON representation |
|---|
| ``` { "name": string, "topics": { string: { object (`https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerTopicMetadata`) }, ... } } ``` |

| Fields ||
|---|---|
| `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} |
| `topics` | ``map (key: string, value: object (`https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerTopicMetadata`))`` Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic} An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |

## ConsumerTopicMetadata

Metadata for a consumer group corresponding to a specific topic.

| JSON representation |
|---|
| ``` { "partitions": { integer: { object (`https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerPartitionMetadata`) }, ... } } ``` |

| Fields ||
|---|---|
| `partitions` | ``map (key: integer, value: object (`https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups#ConsumerPartitionMetadata`))`` Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |

## ConsumerPartitionMetadata

Metadata for a consumer group corresponding to a specific partition.

| JSON representation |
|---|
| ``` { "offset": string, "metadata": string } ``` |

| Fields ||
|---|---|
| `offset` | `string (https://developers.google.com/discovery/v1/type-format format)` Required. The current offset for this partition, or 0 if no offset has been committed. |
| `metadata` | `string` Optional. The associated metadata for this partition, or empty if it does not exist. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups/delete` | Deletes a single consumer group. |
| ### `https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups/get` | Returns the properties of a single consumer group. |
| ### `https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups/list` | Lists the consumer groups in a given cluster. |
| ### `https://docs.cloud.google.com/managed-service-for-apache-kafka/docs/reference/rest/v1/projects.locations.clusters.consumerGroups/patch` | Updates the properties of a single consumer group. |