list method

Future<ListPerfSampleSeriesResponse> list(
  1. String projectId,
  2. String historyId,
  3. String executionId,
  4. String stepId, {
  5. List<String>? filter,
  6. String? $fields,
})

Lists PerfSampleSeries for a given Step.

The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist

Request parameters:

projectId - The cloud project

historyId - A tool results history ID.

executionId - A tool results execution ID.

stepId - A tool results step ID.

filter - Specify one or more PerfMetricType values such as CPU to filter the result

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

Completes with a ListPerfSampleSeriesResponse.

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<ListPerfSampleSeriesResponse> list(
  core.String projectId,
  core.String historyId,
  core.String executionId,
  core.String stepId, {
  core.List<core.String>? filter,
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': filter,
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'toolresults/v1beta3/projects/' +
      commons.escapeVariable('$projectId') +
      '/histories/' +
      commons.escapeVariable('$historyId') +
      '/executions/' +
      commons.escapeVariable('$executionId') +
      '/steps/' +
      commons.escapeVariable('$stepId') +
      '/perfSampleSeries';

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