Undeploy a processor version

After creating a new processor version and deploying it, you can undeploy it if you do not want the processor version to be able to handle processing requests.

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.api_core.exceptions 
  
 import 
 FailedPrecondition 
 from 
  
 google.api_core.exceptions 
  
 import 
 InvalidArgument 
 from 
  
 google.cloud 
  
 import 
 documentai 
 # 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' 
 # processor_id = 'YOUR_PROCESSOR_ID' # Create processor before running sample 
 # processor_version_id = 'YOUR_PROCESSOR_VERSION_ID' 
 def 
  
 undeploy_processor_version_sample 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 processor_id 
 : 
 str 
 , 
 processor_version_id 
 : 
 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 
 ) 
 # The full resource name of the processor version 
 # e.g.: projects/project_id/locations/location/processors/processor_id/processorVersions/processor_version_id 
 name 
 = 
 client 
 . 
  processor_version_path 
 
 ( 
 project_id 
 , 
 location 
 , 
 processor_id 
 , 
 processor_version_id 
 ) 
 # Make UndeployProcessorVersion request 
 try 
 : 
 operation 
 = 
 client 
 . 
  undeploy_processor_version 
 
 ( 
 name 
 = 
 name 
 ) 
 # Print operation details 
 print 
 ( 
 operation 
 . 
 operation 
 . 
 name 
 ) 
 # Wait for operation to complete 
 operation 
 . 
 result 
 () 
 # Undeploy request will fail if the 
 # processor version is already undeployed 
 # or if a request is made on a pretrained processor version 
 except 
 ( 
 FailedPrecondition 
 , 
 InvalidArgument 
 ) 
 as 
 e 
 : 
 print 
 ( 
 e 
 . 
 message 
 ) 
 

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: