cancel method

Future<Empty> cancel(
  1. GoogleCloudDataplexV1CancelMetadataJobRequest request,
  2. String name, {
  3. String? $fields,
})

Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied.

We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

request - The metadata request object.

Request parameters:

name - Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/metadataJobs/\[^/\]+$.

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

Completes with a Empty.

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<Empty> cancel(
  GoogleCloudDataplexV1CancelMetadataJobRequest request,
  core.String name, {
  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/' + core.Uri.encodeFull('$name') + ':cancel';

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