list method

Future<ListPerfSamplesResponse> list(String projectId, String historyId, String executionId, String stepId, String sampleSeriesId, { int? pageSize, String? pageToken, String? $fields, })

Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries 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.

sampleSeriesId - A sample series id

pageSize - The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000

pageToken - Optional, the next_page_token returned in the previous response

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

Completes with a ListPerfSamplesResponse.

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<ListPerfSamplesResponse> list(
  core.String projectId,
  core.String historyId,
  core.String executionId,
  core.String stepId,
  core.String sampleSeriesId, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    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/' +
      commons.escapeVariable('$sampleSeriesId') +
      '/samples';

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