Class ExitConditions
- java.lang.Object
-
- com.microsoft.azure.batch.protocol.models.ExitConditions
-
public class ExitConditions extends Object
Specifies how the Batch service should respond when the Task completes.
-
-
Constructor Summary
Constructors Constructor Description ExitConditions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.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.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 Detail
-
exitCodes
public List<ExitCodeMapping> exitCodes()
Get the exitCodes value.- Returns:
- the exitCodes value
-
withExitCodes
public ExitConditions withExitCodes(List<ExitCodeMapping> exitCodes)
Set the exitCodes value.- Parameters:
exitCodes
- the exitCodes value to set- Returns:
- the ExitConditions object itself.
-
exitCodeRanges
public List<ExitCodeRangeMapping> exitCodeRanges()
Get the exitCodeRanges value.- Returns:
- the exitCodeRanges value
-
withExitCodeRanges
public ExitConditions withExitCodeRanges(List<ExitCodeRangeMapping> exitCodeRanges)
Set the exitCodeRanges value.- Parameters:
exitCodeRanges
- the exitCodeRanges value to set- Returns:
- the ExitConditions object itself.
-
preProcessingError
public ExitOptions preProcessingError()
Get the preProcessingError value.- Returns:
- the preProcessingError value
-
withPreProcessingError
public ExitConditions withPreProcessingError(ExitOptions preProcessingError)
Set the preProcessingError value.- Parameters:
preProcessingError
- the preProcessingError value to set- Returns:
- the ExitConditions object itself.
-
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
-
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.
-
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
-
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.
-
-