Google Cloud Managed Kafka V1 Client - Class ConsumerGroup (0.2.1)

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}

↳ topics array|Google\Protobuf\Internal\MapField

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}

Returns
Type Description
Google\Protobuf\Internal\MapField

setTopics

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}

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this