List long-running operations

List the long-running operations (LROs) in a Google Cloud project and location.

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 
 ListOperationsRequest 
 # type: ignore 
 # TODO(developer): Uncomment these variables before running the sample. 
 # project_id = "YOUR_PROJECT_ID" 
 # location = "YOUR_PROCESSOR_LOCATION"  # Format is "us" or "eu" 
 # Create filter in https://google.aip.dev/160 syntax 
 # For full options, refer to: 
 # https://cloud.google.com/document-ai/docs/long-running-operations#listing_long-running_operations 
 # operations_filter = 'YOUR_FILTER' 
 # Example: 
 # operations_filter = "TYPE=BATCH_PROCESS_DOCUMENTS AND STATE=RUNNING" 
 def 
  
 list_operations_sample 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 operations_filter 
 : 
 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 
 ) 
 # Format: `projects/{project_id}/locations/{location}` 
 name 
 = 
 client 
 . 
  common_location_path 
 
 ( 
 project 
 = 
 project_id 
 , 
 location 
 = 
 location 
 ) 
 request 
 = 
 ListOperationsRequest 
 ( 
 name 
 = 
 f 
 " 
 { 
 name 
 } 
 /operations" 
 , 
 filter 
 = 
 operations_filter 
 , 
 ) 
 # Make ListOperations request 
 operations 
 = 
 client 
 . 
  list_operations 
 
 ( 
 request 
 = 
 request 
 ) 
 # Print the Operation Information 
 print 
 ( 
 operations 
 ) 
 

What's next

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

Create a Mobile Website
View Site in Mobile | Classic
Share by: