ExitOptions Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.ExitOptions

public class ExitOptions

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

Constructor Summary

Constructor Description
ExitOptions()

Method Summary

Modifier and Type Method and Description
DependencyAction dependencyAction()

Get possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait).
JobAction jobAction()

Get the default is none for exit code 0 and terminate for all other exit conditions.
ExitOptions withDependencyAction(DependencyAction dependencyAction)

Set possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait).
ExitOptions withJobAction(JobAction jobAction)

Set the default is none for exit code 0 and terminate for all other exit conditions.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ExitOptions

public ExitOptions()

Method Details

dependencyAction

public DependencyAction dependencyAction()

Get possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks. Possible values include: 'satisfy', 'block'.

Returns:

the dependencyAction value

jobAction

public JobAction jobAction()

Get 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'.

Returns:

the jobAction value

withDependencyAction

public ExitOptions withDependencyAction(DependencyAction dependencyAction)

Set possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks. Possible values include: 'satisfy', 'block'.

Parameters:

dependencyAction - the dependencyAction value to set

Returns:

the ExitOptions object itself.

withJobAction

public ExitOptions withJobAction(JobAction jobAction)

Set 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'.

Parameters:

jobAction - the jobAction value to set

Returns:

the ExitOptions object itself.

Applies to