getNotes method

Future<Note> getNotes(
  1. String name, {
  2. String? $fields,
})

Gets the note attached to the specified occurrence.

Consumer projects can use this method to get a note that belongs to a provider project.

Request parameters:

name - Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]. Value must have pattern ^projects/\[^/\]+/occurrences/\[^/\]+$.

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

Completes with a Note.

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

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

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