Cancel a long-running operation

Cancels a long-running operation (LRO)

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

Python

For more information, see the Document AI Python API reference documentation .

To authenticate to Document AI, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  from 
  
 google.api_core.client_options 
  
 import 
 ClientOptions 
 from 
  
 google.cloud 
  
 import 
 documentai 
 # type: ignore 
 from 
  
 google.longrunning.operations_pb2 
  
 import 
 CancelOperationRequest 
 # type: ignore 
 # TODO(developer): Uncomment these variables before running the sample. 
 # location = "YOUR_PROCESSOR_LOCATION"  # Format is "us" or "eu" 
 # operation_name = "YOUR_OPERATION_NAME"  # Format is "projects/{project_id}/locations/{location}/operations/{operation_id}" 
 def 
  
 cancel_operation_sample 
 ( 
 location 
 : 
 str 
 , 
 operation_name 
 : 
 str 
 ) 
 - 
> None 
 : 
 # You must set the `api_endpoint` if you use a location other than "us". 
 opts 
 = 
 ClientOptions 
 ( 
 api_endpoint 
 = 
 f 
 " 
 { 
 location 
 } 
 -documentai.googleapis.com" 
 ) 
 client 
 = 
 documentai 
 . 
  DocumentProcessorServiceClient 
 
 ( 
 client_options 
 = 
 opts 
 ) 
 request 
 = 
 CancelOperationRequest 
 ( 
 name 
 = 
 operation_name 
 ) 
 # Make CancelOperation request 
 client 
 . 
  cancel_operation 
 
 ( 
 request 
 = 
 request 
 ) 
 print 
 ( 
 f 
 "Operation 
 { 
 operation_name 
 } 
 cancelled" 
 ) 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Design a Mobile Site
View Site in Mobile | Classic
Share by: