Package com.microsoft.azure.management.batchai

Class SetupTask

java.lang.Object
com.microsoft.azure.management.batchai.SetupTask
public class SetupTask extends Object
Specifies a setup task which can be used to customize the compute nodes of the cluster.

  • Constructor Details

    • SetupTask

      public SetupTask()

  • 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:
      the commandLine value

    • 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:
      commandLine - the commandLine value to set
      Returns:
      the SetupTask object itself.

    • environmentVariables

      public List<EnvironmentVariable> environmentVariables()
      Get a collection of user defined environment variables to be set for setup task.
      Returns:
      the environmentVariables value

    • withEnvironmentVariables

      public SetupTask withEnvironmentVariables(List<EnvironmentVariable> environmentVariables)
      Set a collection of user defined environment variables to be set for setup task.
      Parameters:
      environmentVariables - the environmentVariables value to set
      Returns:
      the SetupTask object itself.

    • secrets

      public List<EnvironmentVariableWithSecretValue> 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.
      Returns:
      the secrets value

    • withSecrets

      public SetupTask 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.
      Parameters:
      secrets - the secrets value to set
      Returns:
      the SetupTask object itself.

    • 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:
      the stdOutErrPathPrefix value

    • 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:
      stdOutErrPathPrefix - the stdOutErrPathPrefix value to set
      Returns:
      the SetupTask object itself.

    • 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:
      the stdOutErrPathSuffix value