SetupTask Class
- java.
lang. Object - com.
microsoft. azure. management. batchai. SetupTask
- com.
public class SetupTask
Specifies a setup task which can be used to customize the compute nodes of the cluster.
Method Summary
Modifier and Type | Method and Description |
---|---|
String |
commandLine()
Get the command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root. |
List<Environment |
environmentVariables()
Get a collection of user defined environment variables to be set for setup task. |
List<Environment |
secrets()
Get a collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back. |
String |
stdOutErrPathPrefix()
Get the prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task. |
String |
stdOutErrPathSuffix()
Get a path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout, stderr and execution log of the setup task will be uploaded. Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. The full path can be obtained by concatenation of stdOutErrPathPrefix and stdOutErrPathSuffix. |
Setup |
withCommandLine(String commandLine)
Set the command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root. |
Setup |
withEnvironmentVariables(List<EnvironmentVariable> environmentVariables)
Set a collection of user defined environment variables to be set for setup task. |
Setup |
withSecrets(List<EnvironmentVariableWithSecretValue> secrets)
Set a collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back. |
Setup |
withStdOutErrPathPrefix(String stdOutErrPathPrefix)
Set the prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task. |
Method Details
commandLine
public String commandLine()
Get the command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root.
Returns:
environmentVariables
public List
Get a collection of user defined environment variables to be set for setup task.
Returns:
secrets
public List
Get a collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back.
Returns:
stdOutErrPathPrefix
public String stdOutErrPathPrefix()
Get the prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task.
Returns:
stdOutErrPathSuffix
public String stdOutErrPathSuffix()
Get a path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout, stderr and execution log of the setup task will be uploaded. Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. The full path can be obtained by concatenation of stdOutErrPathPrefix and stdOutErrPathSuffix.
Returns:
withCommandLine
public SetupTask withCommandLine(String commandLine)
Set the command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root.
Parameters:
Returns:
withEnvironmentVariables
public SetupTask withEnvironmentVariables(List
Set a collection of user defined environment variables to be set for setup task.
Parameters:
Returns:
withSecrets
public SetupTask withSecrets(List
Set a collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back.
Parameters:
Returns:
withStdOutErrPathPrefix
public SetupTask withStdOutErrPathPrefix(String stdOutErrPathPrefix)
Set the prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task.
Parameters:
Returns:
Applies to
Azure SDK for Java