consumer_groups

Creates, updates, deletes, gets or lists a consumer_groups resource.

Overview

Name	consumer_groups
Type	Resource
Id	google.managedkafka.consumer_groups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
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	object	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}

list

Successful response

Name	Datatype	Description
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	object	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}

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, clustersId, consumerGroupsId		Returns the properties of a single consumer group.
list	select	projectsId, locationsId, clustersId	pageSize, pageToken	Lists the consumer groups in a given cluster.
patch	update	projectsId, locationsId, clustersId, consumerGroupsId	updateMask	Updates the properties of a single consumer group.
delete	delete	projectsId, locationsId, clustersId, consumerGroupsId		Deletes a single consumer group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clustersId	string
consumerGroupsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns the properties of a single consumer group.

SELECT
name,
topics
FROM google.managedkafka.consumer_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND consumerGroupsId = '{{ consumerGroupsId }}' -- required;

list

Lists the consumer groups in a given cluster.

SELECT
name,
topics
FROM google.managedkafka.consumer_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

UPDATE examples

patch

Updates the properties of a single consumer group.

UPDATE google.managedkafka.consumer_groups
SET 
data__name = '{{ name }}',
data__topics = '{{ topics }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND consumerGroupsId = '{{ consumerGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
topics;

DELETE examples

delete

Deletes a single consumer group.

DELETE FROM google.managedkafka.consumer_groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND consumerGroupsId = '{{ consumerGroupsId }}' --required;