list method

Future<ListNoteOccurrencesResponse> list(
  1. String name, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Lists occurrences referencing the specified note.

Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.

Request parameters:

name - Required. The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID]. Value must have pattern ^projects/\[^/\]+/notes/\[^/\]+$.

filter - The filter expression.

pageSize - Number of occurrences to return in the list.

pageToken - Token to provide to skip to a particular spot in the list.

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

Completes with a ListNoteOccurrencesResponse.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + '/occurrences';

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