Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ConsumerGroup.
A Kafka consumer group in a given cluster.
Generated from protobuf message google.cloud.managedkafka.v1.ConsumerGroup
Namespace
Google \ Cloud \ ManagedKafka \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The name of the consumer group. The consumer_group segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
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}
getName
Identifier. The name of the consumer group. The consumer_group segment is
used when connecting directly to the cluster. Structured like:
projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
Returns
Type
Description
string
setName
Identifier. The name of the consumer group. The consumer_group segment is
used when connecting directly to the cluster. Structured like:
projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTopics
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}
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}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Managed Kafka V1 Client - Class ConsumerGroup (0.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.1 (latest)](/php/docs/reference/cloud-managedkafka/latest/V1.ConsumerGroup)\n- [0.6.0](/php/docs/reference/cloud-managedkafka/0.6.0/V1.ConsumerGroup)\n- [0.5.0](/php/docs/reference/cloud-managedkafka/0.5.0/V1.ConsumerGroup)\n- [0.4.1](/php/docs/reference/cloud-managedkafka/0.4.1/V1.ConsumerGroup)\n- [0.3.1](/php/docs/reference/cloud-managedkafka/0.3.1/V1.ConsumerGroup)\n- [0.2.3](/php/docs/reference/cloud-managedkafka/0.2.3/V1.ConsumerGroup)\n- [0.1.3](/php/docs/reference/cloud-managedkafka/0.1.3/V1.ConsumerGroup) \nReference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ConsumerGroup.\n\nA Kafka consumer group in a given cluster.\n\nGenerated from protobuf message `google.cloud.managedkafka.v1.ConsumerGroup`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ManagedKafka \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nIdentifier. The name of the consumer group. The `consumer_group` segment is\nused when connecting directly to the cluster. Structured like:\nprojects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}\n\n### setName\n\nIdentifier. The name of the consumer group. The `consumer_group` segment is\nused when connecting directly to the cluster. Structured like:\nprojects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}\n\n### getTopics\n\nOptional. Metadata for this consumer group for all topics it has metadata\nfor. The key of the map is a topic name, structured like:\nprojects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}\n\n### setTopics\n\nOptional. Metadata for this consumer group for all topics it has metadata\nfor. The key of the map is a topic name, structured like:\nprojects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}"]]
