list method

Future<ListChannelsResponse> list(
  1. String parent, {
  2. String? orderBy,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

List channels.

Request parameters:

parent - Required. The parent collection to list channels on. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

orderBy - The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, channel_id.

pageSize - The maximum number of channels to return on each page. Note: The service may send fewer.

pageToken - The page token; provide the value from the next_page_token field in a previous ListChannels call to retrieve the subsequent page. When paginating, all other parameters provided to ListChannels must match the call that provided the page token.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListChannelsResponse.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/channels';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListChannelsResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}