cancelJob

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED.

A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status.

When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed.

Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

Samples

fun main() { 
   //sampleStart 
   // This example cancels a job with the specified job ID.
val resp = batchClient.cancelJob {
    reason = "Cancelling job."
    jobId = "1d828f65-7a4d-42e8-996d-3b900ed59dc4"
} 
   //sampleEnd
}