getSeriesMetrics method

Future<SeriesMetrics> getSeriesMetrics(
  1. String series, {
  2. String? $fields,
})

GetSeriesMetrics returns metrics for a series.

Request parameters:

series - Required. The series resource path. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/datasets/\[^/\]+/dicomStores/\[^/\]+/dicomWeb/studies/\[^/\]+/series/\[^/\]+$.

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

Completes with a SeriesMetrics.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$series') + ':getSeriesMetrics';

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