get method

Future<Step> get(
  1. String projectId,
  2. String historyId,
  3. String executionId,
  4. String stepId, {
  5. String? $fields,
})

Gets a Step.

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 Step does not exist

Request parameters:

projectId - A Project id. Required.

historyId - A History id. Required.

executionId - A Execution id. Required.

stepId - A Step id. Required.

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

Completes with a Step.

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<Step> get(
  core.String projectId,
  core.String historyId,
  core.String executionId,
  core.String stepId, {
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    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');

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