cancelPipelineJob method

Future<void> cancelPipelineJob(
  1. CancelPipelineJobRequest request
)

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and PipelineJob.state is set to CANCELLED.

Throws a http.ClientException if there were problems communicating with the API service. Throws a StatusException if the API failed with a Status message. Throws a ServiceException for any other failure.

Implementation

Future<void> cancelPipelineJob(CancelPipelineJobRequest request) async {
  final url = Uri.https(_host, '/v1beta1/${request.name}:cancel');
  await _client.post(url, body: request);
}