Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExitOptions

Package version

An interface representing ExitOptions.

summary

Specifies how the Batch service responds to a particular exit condition.

Hierarchy

  • ExitOptions

Index

Properties

Optional dependencyAction

dependencyAction: DependencyAction

An action that the Batch service performs on tasks that depend on this task. The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'satisfy', 'block'

Optional jobAction

jobAction: JobAction

An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'. The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'none', 'disable', 'terminate'

Generated using TypeDoc