Vertex AI is transitioning to become part of Gemini Enterprise Agent Platform. See the most up-to-date information in the Agent Platform documentation .

Method: operations.cancel

Full name: projects.locations.operations.cancel

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 .

Endpoint

post

https:  
/  
/{service-endpoint}  
/v1  
/{name}:cancel

Where {service-endpoint} is one of the supported service endpoints .

Path 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 is an empty JSON object.

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 2025-06-27 UTC.

Create a Mobile Website

View Site in Mobile | Classic

Share by:

Method: operations.cancel Stay organized with collections Save and categorize content based on your preferences.

Endpoint

Path parameters

Request body

Response body

Method: operations.cancel