cancel method

Future<Job> cancel(CancelJobRequest request, String projectId, String region, String jobId, { String? $fields, })

Starts a job cancellation request.

To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).

request - The metadata request object.

Request parameters:

projectId - Required. The ID of the Google Cloud Platform project that the job belongs to.

region - Required. The Dataproc region in which to handle the request.

jobId - Required. The job ID.

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

Completes with a Job.

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<Job> cancel(
  CancelJobRequest request,
  core.String projectId,
  core.String region,
  core.String jobId, {
  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') +
      '/regions/' +
      commons.escapeVariable('$region') +
      '/jobs/' +
      commons.escapeVariable('$jobId') +
      ':cancel';

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