cancelTrainingPipeline method

Future<void> cancelTrainingPipeline(
  1. CancelTrainingPipelineRequest request
)

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

Throws a http.ClientException if there were problems communicating with the API service. Throws a ServiceException if the API method failed for any reason.

Implementation

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