list method

Future<ListOccurrencesResponse> list(String parent, { String? filter, int? pageSize, String? pageToken, bool? returnPartialSuccess, String? $fields, })

Lists occurrences for the specified project.

Request parameters:

parent - Required. The name of the project to list occurrences for in the form of projects/[PROJECT_ID]. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - The filter expression.

pageSize - Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

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

returnPartialSuccess - If set, the request will return all reachable Occurrences and report all unreachable regions in the unreachable field in the response. Only applicable for requests in the global region.

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

Completes with a ListOccurrencesResponse.

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<ListOccurrencesResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.bool? returnPartialSuccess,
  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 (returnPartialSuccess != null)
      'returnPartialSuccess': ['${returnPartialSuccess}'],
    if ($fields != null) 'fields': [$fields],
  };

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

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