abortJobStep

Summary

Abort a running job step.

jobStepId

Stringrequired

The primary key for a job step.

force

Booleanoptional

Instructs certain API calls to continue, even though doing to might have consequences. For example, if true, for abortJob, alwaysRun steps will be aborted as well; for import, existing objects will be replaced. If true, setDatabaseConfiguration will store the configuration even if it can't be validated.

reason

Stringoptional

User-supplied string.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.abortJobStep(
  jobStepId: "test-jobStepId"
  /* optional arguments */
)▼