StartTask Class
- java.
lang. Object - com.
microsoft. azure. management. batch. StartTask
- com.
public class StartTask
A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| String |
commandLine()
Get the command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. |
|
Task |
containerSettings()
Get when this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. |
|
List<Environment |
environmentSettings()
Get the environmentSettings value. |
| Integer |
maxTaskRetryCount()
Get the Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. |
|
List<Resource |
resourceFiles()
Get the resourceFiles value. |
|
User |
userIdentity()
Get if omitted, the task runs as a non-administrative user unique to the task. |
| Boolean |
waitForSuccess()
Get if true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. |
|
Start |
withCommandLine(String commandLine)
Set the command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. |
|
Start |
withContainerSettings(TaskContainerSettings containerSettings)
Set when this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. |
|
Start |
withEnvironmentSettings(List<EnvironmentSetting> environmentSettings)
Set the environmentSettings value. |
|
Start |
withMaxTaskRetryCount(Integer maxTaskRetryCount)
Set the Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. |
|
Start |
withResourceFiles(List<ResourceFile> resourceFiles)
Set the resourceFiles value. |
|
Start |
withUserIdentity(UserIdentity userIdentity)
Set if omitted, the task runs as a non-administrative user unique to the task. |
|
Start |
withWaitForSuccess(Boolean waitForSuccess)
Set if true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. |
Method Details
commandLine
public String commandLine()
Get the command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.
Returns:
containerSettings
public TaskContainerSettings containerSettings()
Get when this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
Returns:
environmentSettings
public List
Get the environmentSettings value.
Returns:
maxTaskRetryCount
public Integer maxTaskRetryCount()
Get the Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.
Returns:
resourceFiles
public List
Get the resourceFiles value.
Returns:
userIdentity
public UserIdentity userIdentity()
Get if omitted, the task runs as a non-administrative user unique to the task.
Returns:
waitForSuccess
public Boolean waitForSuccess()
Get if true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.
Returns:
withCommandLine
public StartTask withCommandLine(String commandLine)
Set the command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.
Parameters:
Returns:
withContainerSettings
public StartTask withContainerSettings(TaskContainerSettings containerSettings)
Set when this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
Parameters:
Returns:
withEnvironmentSettings
public StartTask withEnvironmentSettings(List
Set the environmentSettings value.
Parameters:
Returns:
withMaxTaskRetryCount
public StartTask withMaxTaskRetryCount(Integer maxTaskRetryCount)
Set the Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.
Parameters:
Returns:
withResourceFiles
public StartTask withResourceFiles(List
Set the resourceFiles value.
Parameters:
Returns:
withUserIdentity
public StartTask withUserIdentity(UserIdentity userIdentity)
Set if omitted, the task runs as a non-administrative user unique to the task.
Parameters:
Returns:
withWaitForSuccess
public StartTask withWaitForSuccess(Boolean waitForSuccess)
Set if true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.
Parameters:
Returns:
