Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ListConsumerGroupsRequest.
Request for ListConsumerGroups.
Generated from protobuf message google.cloud.managedkafka.v1.ListConsumerGroupsRequest
Namespace
Google \ Cloud \ ManagedKafka \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
↳ page_size
int
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.
↳ page_token
string
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.
getParent
Required. The parent cluster whose consumer groups are to be listed.
Structured like
projects/{project}/locations/{location}/clusters/{cluster}.
Returns
Type
Description
string
setParent
Required. The parent cluster whose consumer groups are to be listed.
Structured like
projects/{project}/locations/{location}/clusters/{cluster}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
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.
Returns
Type
Description
int
setPageSize
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
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.
Returns
Type
Description
string
setPageToken
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent cluster whose consumer groups are to be listed.
Structured like
projects/{project}/locations/{location}/clusters/{cluster}. Please see
ManagedKafkaClient::clusterName() for help formatting this field.
[[["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 ListConsumerGroupsRequest (0.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.1 (latest)](/php/docs/reference/cloud-managedkafka/latest/V1.ListConsumerGroupsRequest)\n- [0.6.0](/php/docs/reference/cloud-managedkafka/0.6.0/V1.ListConsumerGroupsRequest)\n- [0.5.0](/php/docs/reference/cloud-managedkafka/0.5.0/V1.ListConsumerGroupsRequest)\n- [0.4.1](/php/docs/reference/cloud-managedkafka/0.4.1/V1.ListConsumerGroupsRequest)\n- [0.3.1](/php/docs/reference/cloud-managedkafka/0.3.1/V1.ListConsumerGroupsRequest)\n- [0.2.3](/php/docs/reference/cloud-managedkafka/0.2.3/V1.ListConsumerGroupsRequest)\n- [0.1.3](/php/docs/reference/cloud-managedkafka/0.1.3/V1.ListConsumerGroupsRequest) \nReference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ListConsumerGroupsRequest.\n\nRequest for ListConsumerGroups.\n\nGenerated from protobuf message `google.cloud.managedkafka.v1.ListConsumerGroupsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ManagedKafka \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent cluster whose consumer groups are to be listed.\n\nStructured like\n`projects/{project}/locations/{location}/clusters/{cluster}`.\n\n### setParent\n\nRequired. The parent cluster whose consumer groups are to be listed.\n\nStructured like\n`projects/{project}/locations/{location}/clusters/{cluster}`.\n\n### getPageSize\n\nOptional. The maximum number of consumer groups to return. The service may\nreturn fewer than this value. If unset or zero, all consumer groups for the\nparent is returned.\n\n### setPageSize\n\nOptional. The maximum number of consumer groups to return. The service may\nreturn fewer than this value. If unset or zero, all consumer groups for the\nparent is returned.\n\n### getPageToken\n\nOptional. A page token, received from a previous `ListConsumerGroups` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListConsumerGroups` must\nmatch the call that provided the page token.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListConsumerGroups` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListConsumerGroups` must\nmatch the call that provided the page token.\n\n### static::build"]]
