list method

Future<ListConsumerGroupsResponse> list(
  1. String parent, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? view,
  6. String? $fields,
})

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/\[^/\]+$.

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

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.

view - Optional. Specifies the view (BASIC or FULL) of the ConsumerGroup resource to be returned in the response. Defaults to FULL view. Possible string values are:

  • "CONSUMER_GROUP_VIEW_UNSPECIFIED" : The default / unset value. The API will default to the FULL view.
  • "CONSUMER_GROUP_VIEW_BASIC" : Include the name of the ConsumerGroup. This hides partition and topic metadata.
  • "CONSUMER_GROUP_VIEW_FULL" : Include everything, including partition and topic metadata. This is the default value.

$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.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'view': ?view == null ? null : [view],
    'fields': ?$fields == null ? null : [$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>,
  );
}