cancel method

Future<Build> cancel(
  1. CancelBuildRequest request,
  2. String projectId,
  3. String id, {
  4. String? $fields,
})

Cancels a build in progress.

request - The metadata request object.

Request parameters:

projectId - Required. ID of the project.

id - Required. ID of the build.

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

Completes with a Build.

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<Build> cancel(
  CancelBuildRequest request,
  core.String projectId,
  core.String id, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/projects/' +
      commons.escapeVariable('$projectId') +
      '/builds/' +
      commons.escapeVariable('$id') +
      ':cancel';

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