list method
Lists the consumer groups in a given cluster.
Request parameters:
parent
- Required. The parent cluster whose consumer groups are to be
listed. Structured like
projects/{project}/locations/{location}/clusters/{cluster}
.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/clusters/\[^/\]+$
.
pageSize
- 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.
pageToken
- 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.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListConsumerGroupsResponse.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<ListConsumerGroupsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/consumerGroups';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListConsumerGroupsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}