list method

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

Lists Environments for a given Execution.

The Environments are sorted by display name. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Execution does not exist

Request parameters:

projectId - Required. A Project id.

historyId - Required. A History id.

executionId - Required. An Execution id.

pageSize - The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0.

pageToken - A continuation token to resume the query at the next item.

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

Completes with a ListEnvironmentsResponse.

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<ListEnvironmentsResponse> list(
  core.String projectId,
  core.String historyId,
  core.String executionId, {
  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') +
      '/environments';

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