cancel method

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

Cancels a running/pending DataScan job.

request - The metadata request object.

Request parameters:

name - Required. The resource name of the DataScanJob: projects/{project_id_or_number}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id} where project_id_or_number refers to a project_id or project_number and location_id refers to a Google Cloud region. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/dataScans/\[^/\]+/jobs/\[^/\]+$.

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

Completes with a GoogleCloudDataplexV1CancelDataScanJobResponse.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':cancel';

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