patch method

Future<Step> patch(Step request, String projectId, String historyId, String executionId, String stepId, { String? requestId, String? $fields, })

Updates an existing Step with the supplied partial entity.

May return any of the following canonical error codes: - PERMISSION_DENIED

• if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist

request - The metadata request object.

Request parameters:

projectId - A Project id. Required.

historyId - A History id. Required.

executionId - A Execution id. Required.

stepId - A Step id. Required.

requestId - A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

$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> patch(
  Step request,
  core.String projectId,
  core.String historyId,
  core.String executionId,
  core.String stepId, {
  core.String? requestId,
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request.toJson());
  final _queryParams = <core.String, core.List<core.String>>{
    if (requestId != null) 'requestId': [requestId],
    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,
    'PATCH',
    body: _body,
    queryParams: _queryParams,
  );
  return Step.fromJson(_response as core.Map<core.String, core.dynamic>);
}