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
.
HTTP request
POST https://{service-endpoint}/v1/{name}:cancel
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the TrainingPipeline to cancel. Format: |
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
aiplatform.trainingPipelines.cancel
For more information, see the IAM documentation.