Method: projects.locations.operations.cancel
Stay organized with collections
Save and categorize content based on your preferences.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error
value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED
.
HTTP request
POST https://automl.googleapis.com/v1beta1/{name}:cancel
Path parameters
Parameters |
name |
string
The name of the operation resource to be cancelled.
|
Request body
The request body must be empty.
Response body
If successful, the response body will be empty.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2019-12-17 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2019-12-17 UTC."],[[["This document describes how to cancel a long-running operation via an HTTP POST request."],["The operation to be canceled is specified using its resource name as a path parameter in the URL."],["The HTTP request to cancel an operation does not require a request body and if successful, returns an empty response body."],["Canceling an operation requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."],["Upon successfull cancelation, the operation will be updated with a status code of `Code.CANCELLED`, indicated by a `google.rpc.Status.code` of `1` in the response."]]],[]]