latestOpenAPI 3.0.02026-08-0484453.8 KB

7d66607e1ab6

Batch Processing

Cancel a batch job

Cancels a batch job. This will stop the batch job from being processed further.

post/v1/batch-jobs/{batchJobId}/cancel

Path parameters

batchJobIdstring required

The ID of the batch job to cancel

Request body

GatewayServiceCancelBatchJobBody required

Response

A successful response.

batchJobIdstring

state'BATCH_JOB_STATE_UNSPECIFIED' | 'BATCH_JOB_STATE_ERROR' | 'BATCH_JOB_STATE_INITIALIZED' | 'BATCH_JOB_STATE_QUEUED' | 'BATCH_JOB_STATE_PREPROCESSING' | 'BATCH_JOB_STATE_PREPROCESSED' | 'BATCH_JOB_STATE_SUBMITTED' | 'BATCH_JOB_STATE_POSTPROCESSING' | 'BATCH_JOB_STATE_POSTPROCESSED' | 'BATCH_JOB_STATE_COMPLETED' | 'BATCH_JOB_STATE_CANCELLED'