Instance methods
TriggerClient: cancelRunsForJob() Instance Method
Instance methods
TriggerClient: cancelRunsForJob() Instance Method
The cancelRunsForJob() instance method will cancel all job runs (yet to be executed) with the given jobId.
Parameters
jobId
string
requiredThe job ID to cancel the job runs for. This is the id you set when using client.defineJob() or
new Job().
Returns
cancelledRunIds
array
requiredList of Job Run IDs that are cancelled.
failedToCancelRunIds
array
requiredList of Job Run IDs that have failed to be cancelled.
Was this page helpful?