Cancel a batch prediction job

Cancels a batch prediction job using the cancel_batch_prediction_job method.

Code sample

Java

Before trying this sample, follow the Java setup instructions in the Vertex AI quickstart using client libraries . For more information, see the Vertex AI Java API reference documentation .

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

  import 
  
 com.google.cloud.aiplatform.v1. BatchPredictionJobName 
 
 ; 
 import 
  
 com.google.cloud.aiplatform.v1. JobServiceClient 
 
 ; 
 import 
  
 com.google.cloud.aiplatform.v1. JobServiceSettings 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 CancelBatchPredictionJobSample 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 project 
  
 = 
  
 "YOUR_PROJECT_ID" 
 ; 
  
 String 
  
 batchPredictionJobId 
  
 = 
  
 "YOUR_BATCH_PREDICTION_JOB_ID" 
 ; 
  
 cancelBatchPredictionJobSample 
 ( 
 project 
 , 
  
 batchPredictionJobId 
 ); 
  
 } 
  
 static 
  
 void 
  
 cancelBatchPredictionJobSample 
 ( 
 String 
  
 project 
 , 
  
 String 
  
 batchPredictionJobId 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
  JobServiceSettings 
 
  
 jobServiceSettings 
  
 = 
  
  JobServiceSettings 
 
 . 
 newBuilder 
 () 
  
 . 
 setEndpoint 
 ( 
 "us-central1-aiplatform.googleapis.com:443" 
 ) 
  
 . 
 build 
 (); 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. After completing all of your requests, call 
  
 // the "close" method on the client to safely clean up any remaining background resources. 
  
 try 
  
 ( 
  JobServiceClient 
 
  
 jobServiceClient 
  
 = 
  
  JobServiceClient 
 
 . 
 create 
 ( 
 jobServiceSettings 
 )) 
  
 { 
  
 String 
  
 location 
  
 = 
  
 "us-central1" 
 ; 
  
  BatchPredictionJobName 
 
  
 batchPredictionJobName 
  
 = 
  
  BatchPredictionJobName 
 
 . 
 of 
 ( 
 project 
 , 
  
 location 
 , 
  
 batchPredictionJobId 
 ); 
  
 jobServiceClient 
 . 
 cancelBatchPredictionJob 
 ( 
 batchPredictionJobName 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Cancelled the Batch Prediction Job" 
 ); 
  
 } 
  
 } 
 } 
 

Python

Before trying this sample, follow the Python setup instructions in the Vertex AI quickstart using client libraries . For more information, see the Vertex AI Python API reference documentation .

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

  from 
  
 google.cloud 
  
 import 
 aiplatform 
 def 
  
 cancel_batch_prediction_job_sample 
 ( 
 project 
 : 
 str 
 , 
 batch_prediction_job_id 
 : 
 str 
 , 
 location 
 : 
 str 
 = 
 "us-central1" 
 , 
 api_endpoint 
 : 
 str 
 = 
 "us-central1-aiplatform.googleapis.com" 
 , 
 ): 
 # The AI Platform services require regional API endpoints. 
 client_options 
 = 
 { 
 "api_endpoint" 
 : 
 api_endpoint 
 } 
 # Initialize client that will be used to create and send requests. 
 # This client only needs to be created once, and can be reused for multiple requests. 
 client 
 = 
 aiplatform 
 . 
 gapic 
 . 
  JobServiceClient 
 
 ( 
 client_options 
 = 
 client_options 
 ) 
 name 
 = 
 client 
 . 
  batch_prediction_job_path 
 
 ( 
 project 
 = 
 project 
 , 
 location 
 = 
 location 
 , 
 batch_prediction_job 
 = 
 batch_prediction_job_id 
 ) 
 response 
 = 
 client 
 . 
  cancel_batch_prediction_job 
 
 ( 
 name 
 = 
 name 
 ) 
 print 
 ( 
 "response:" 
 , 
 response 
 ) 
 

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: