Share via

ExitConditions Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.ExitConditions

public class ExitConditions

Specifies how the Batch service should respond when the task completes.

Method Summary

Modifier and Type Method and Description
ExitOptions defaultProperty()

Get this value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.
List<ExitCodeRangeMapping> exitCodeRanges()

Get the exitCodeRanges value.
List<ExitCodeMapping> exitCodes()

Get the exitCodes value.
ExitOptions fileUploadError()

Get if the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.
ExitOptions preProcessingError()

Get the preProcessingError value.
ExitConditions withDefaultProperty(ExitOptions defaultProperty)

Set this value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.
ExitConditions withExitCodeRanges(List<ExitCodeRangeMapping> exitCodeRanges)

Set the exitCodeRanges value.
ExitConditions withExitCodes(List<ExitCodeMapping> exitCodes)

Set the exitCodes value.
ExitConditions withFileUploadError(ExitOptions fileUploadError)

Set if the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.
ExitConditions withPreProcessingError(ExitOptions preProcessingError)

Set the preProcessingError value.

Method Details

defaultProperty

public ExitOptions defaultProperty()

Get this value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.

Returns:

the defaultProperty value

exitCodeRanges

public List exitCodeRanges()

Get the exitCodeRanges value.

Returns:

the exitCodeRanges value

exitCodes

public List exitCodes()

Get the exitCodes value.

Returns:

the exitCodes value

fileUploadError

public ExitOptions fileUploadError()

Get if the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.

Returns:

the fileUploadError value

preProcessingError

public ExitOptions preProcessingError()

Get the preProcessingError value.

Returns:

the preProcessingError value

withDefaultProperty

public ExitConditions withDefaultProperty(ExitOptions defaultProperty)

Set this value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.

Parameters:

defaultProperty - the defaultProperty value to set

Returns:

the ExitConditions object itself.

withExitCodeRanges

public ExitConditions withExitCodeRanges(List exitCodeRanges)

Set the exitCodeRanges value.

Parameters:

exitCodeRanges - the exitCodeRanges value to set

Returns:

the ExitConditions object itself.

withExitCodes

public ExitConditions withExitCodes(List exitCodes)

Set the exitCodes value.

Parameters:

exitCodes - the exitCodes value to set

Returns:

the ExitConditions object itself.

withFileUploadError

public ExitConditions withFileUploadError(ExitOptions fileUploadError)

Set if the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.

Parameters:

fileUploadError - the fileUploadError value to set

Returns:

the ExitConditions object itself.

withPreProcessingError

public ExitConditions withPreProcessingError(ExitOptions preProcessingError)

Set the preProcessingError value.

Parameters:

preProcessingError - the preProcessingError value to set

Returns:

the ExitConditions object itself.

Applies to