list method

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

Use this method to list streams in a project and location.

Request parameters:

parent - Required. The parent that owns the collection of streams. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Filter request.

orderBy - Order by fields for the result.

pageSize - Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - Page token received from a previous ListStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListStreams must match the call that provided the page token.

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

Completes with a ListStreamsResponse.

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

  final _url = 'v1alpha1/' + core.Uri.encodeFull('$parent') + '/streams';

  final _response = await _requester.request(
    _url,
    'GET',
    queryParams: _queryParams,
  );
  return ListStreamsResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}