v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13356598.3 KB
projects

Lists the consumer groups in a given cluster.

get/v1/{+parent}/consumerGroups

Path parameters

parentstring required

Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

Query parameters

filterstring

Optional. Filter expression for the result. Only supports filtering by topic name as a key in the topics map.

pageSizeinteger

Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.

pageTokenstring

Optional. A page token, received from a previous ListConsumerGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConsumerGroups must match the call that provided the page token.

view'CONSUMER_GROUP_VIEW_UNSPECIFIED' | 'CONSUMER_GROUP_VIEW_BASIC' | 'CONSUMER_GROUP_VIEW_FULL'

Optional. Specifies the view (BASIC or FULL) of the ConsumerGroup resource to be returned in the response. Defaults to FULL view.

Response

Successful response