Package com.microsoft.azure.management.batchai

Class JobCreateParameters

java.lang.Object
com.microsoft.azure.management.batchai.JobCreateParameters
public class JobCreateParameters extends Object
Job creation parameters.

  • Constructor Details

    • JobCreateParameters

      public JobCreateParameters()

  • Method Details

    • schedulingPriority

      public JobPriority schedulingPriority()
      Get scheduling priority associated with the job. Possible values: low, normal, high. Possible values include: 'low', 'normal', 'high'.
      Returns:
      the schedulingPriority value

    • withSchedulingPriority

      public JobCreateParameters withSchedulingPriority(JobPriority schedulingPriority)
      Set scheduling priority associated with the job. Possible values: low, normal, high. Possible values include: 'low', 'normal', 'high'.
      Parameters:
      schedulingPriority - the schedulingPriority value to set
      Returns:
      the JobCreateParameters object itself.

    • cluster

      public ResourceId cluster()
      Get resource ID of the cluster on which this job will run.
      Returns:
      the cluster value

    • withCluster

      public JobCreateParameters withCluster(ResourceId cluster)
      Set resource ID of the cluster on which this job will run.
      Parameters:
      cluster - the cluster value to set
      Returns:
      the JobCreateParameters object itself.

    • mountVolumes

      public MountVolumes mountVolumes()
      Get information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.
      Returns:
      the mountVolumes value

    • withMountVolumes

      public JobCreateParameters withMountVolumes(MountVolumes mountVolumes)
      Set information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.
      Parameters:
      mountVolumes - the mountVolumes value to set
      Returns:
      the JobCreateParameters object itself.

    • nodeCount

      public int nodeCount()
      Get number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes.
      Returns:
      the nodeCount value

    • withNodeCount

      public JobCreateParameters withNodeCount(int nodeCount)
      Set number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes.
      Parameters:
      nodeCount - the nodeCount value to set
      Returns:
      the JobCreateParameters object itself.

    • containerSettings

      public ContainerSettings containerSettings()
      Get docker container settings for the job. If not provided, the job will run directly on the node.
      Returns:
      the containerSettings value

    • withContainerSettings

      public JobCreateParameters withContainerSettings(ContainerSettings containerSettings)
      Set docker container settings for the job. If not provided, the job will run directly on the node.
      Parameters:
      containerSettings - the containerSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • cntkSettings

      public CNTKsettings cntkSettings()
      Get settings for CNTK (aka Microsoft Cognitive Toolkit) job.
      Returns:
      the cntkSettings value

    • withCntkSettings

      public JobCreateParameters withCntkSettings(CNTKsettings cntkSettings)
      Set settings for CNTK (aka Microsoft Cognitive Toolkit) job.
      Parameters:
      cntkSettings - the cntkSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • pyTorchSettings

      public PyTorchSettings pyTorchSettings()
      Get settings for pyTorch job.
      Returns:
      the pyTorchSettings value

    • withPyTorchSettings

      public JobCreateParameters withPyTorchSettings(PyTorchSettings pyTorchSettings)
      Set settings for pyTorch job.
      Parameters:
      pyTorchSettings - the pyTorchSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • tensorFlowSettings

      public TensorFlowSettings tensorFlowSettings()
      Get settings for Tensor Flow job.
      Returns:
      the tensorFlowSettings value

    • withTensorFlowSettings

      public JobCreateParameters withTensorFlowSettings(TensorFlowSettings tensorFlowSettings)
      Set settings for Tensor Flow job.
      Parameters:
      tensorFlowSettings - the tensorFlowSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • caffeSettings

      public CaffeSettings caffeSettings()
      Get settings for Caffe job.
      Returns:
      the caffeSettings value

    • withCaffeSettings

      public JobCreateParameters withCaffeSettings(CaffeSettings caffeSettings)
      Set settings for Caffe job.
      Parameters:
      caffeSettings - the caffeSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • caffe2Settings

      public Caffe2Settings caffe2Settings()
      Get settings for Caffe2 job.
      Returns:
      the caffe2Settings value

    • withCaffe2Settings

      public JobCreateParameters withCaffe2Settings(Caffe2Settings caffe2Settings)
      Set settings for Caffe2 job.
      Parameters:
      caffe2Settings - the caffe2Settings value to set
      Returns:
      the JobCreateParameters object itself.

    • chainerSettings

      public ChainerSettings chainerSettings()
      Get settings for Chainer job.
      Returns:
      the chainerSettings value

    • withChainerSettings

      public JobCreateParameters withChainerSettings(ChainerSettings chainerSettings)
      Set settings for Chainer job.
      Parameters:
      chainerSettings - the chainerSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • customToolkitSettings

      public CustomToolkitSettings customToolkitSettings()
      Get settings for custom tool kit job.
      Returns:
      the customToolkitSettings value

    • withCustomToolkitSettings

      public JobCreateParameters withCustomToolkitSettings(CustomToolkitSettings customToolkitSettings)
      Set settings for custom tool kit job.
      Parameters:
      customToolkitSettings - the customToolkitSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • customMpiSettings

      public CustomMpiSettings customMpiSettings()
      Get settings for custom MPI job.
      Returns:
      the customMpiSettings value

    • withCustomMpiSettings

      public JobCreateParameters withCustomMpiSettings(CustomMpiSettings customMpiSettings)
      Set settings for custom MPI job.
      Parameters:
      customMpiSettings - the customMpiSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • horovodSettings

      public HorovodSettings horovodSettings()
      Get settings for Horovod job.
      Returns:
      the horovodSettings value

    • withHorovodSettings

      public JobCreateParameters withHorovodSettings(HorovodSettings horovodSettings)
      Set settings for Horovod job.
      Parameters:
      horovodSettings - the horovodSettings value to set
      Returns:
      the JobCreateParameters object itself.

    • jobPreparation

      public JobPreparation jobPreparation()
      Get a command line to be executed on each node allocated for the job before tool kit is launched.
      Returns:
      the jobPreparation value

    • withJobPreparation

      public JobCreateParameters withJobPreparation(JobPreparation jobPreparation)
      Set a command line to be executed on each node allocated for the job before tool kit is launched.
      Parameters:
      jobPreparation - the jobPreparation value to set
      Returns:
      the JobCreateParameters object itself.

    • stdOutErrPathPrefix

      public String stdOutErrPathPrefix()
      Get the path where the Batch AI service will store stdout, stderror and execution log of the job.
      Returns:
      the stdOutErrPathPrefix value

    • withStdOutErrPathPrefix

      public JobCreateParameters withStdOutErrPathPrefix(String stdOutErrPathPrefix)
      Set the path where the Batch AI service will store stdout, stderror and execution log of the job.
      Parameters:
      stdOutErrPathPrefix - the stdOutErrPathPrefix value to set
      Returns:
      the JobCreateParameters object itself.

    • inputDirectories

      public List<InputDirectory> inputDirectories()
      Get a list of input directories for the job.
      Returns:
      the inputDirectories value

    • withInputDirectories

      public JobCreateParameters withInputDirectories(List<InputDirectory> inputDirectories)
      Set a list of input directories for the job.
      Parameters:
      inputDirectories - the inputDirectories value to set
      Returns:
      the JobCreateParameters object itself.

    • outputDirectories

      public List<OutputDirectory> outputDirectories()
      Get a list of output directories for the job.
      Returns:
      the outputDirectories value

    • withOutputDirectories

      public JobCreateParameters withOutputDirectories(List<OutputDirectory> outputDirectories)
      Set a list of output directories for the job.
      Parameters:
      outputDirectories - the outputDirectories value to set
      Returns:
      the JobCreateParameters object itself.

    • environmentVariables

      public List<EnvironmentVariable> environmentVariables()
      Get a list of user defined environment variables which will be setup for the job.
      Returns:
      the environmentVariables value

    • withEnvironmentVariables

      public JobCreateParameters withEnvironmentVariables(List<EnvironmentVariable> environmentVariables)
      Set a list of user defined environment variables which will be setup for the job.
      Parameters:
      environmentVariables - the environmentVariables value to set
      Returns:
      the JobCreateParameters object itself.

    • secrets

      public List<EnvironmentVariableWithSecretValue> secrets()
      Get a list of user defined environment variables with secret values which will be setup for the job. Server will never report values of these variables back.
      Returns:
      the secrets value

    • withSecrets

      public JobCreateParameters withSecrets(List<EnvironmentVariableWithSecretValue> secrets)
      Set a list of user defined environment variables with secret values which will be setup for the job. Server will never report values of these variables back.
      Parameters:
      secrets - the secrets value to set
      Returns:
      the JobCreateParameters object itself.

    • constraints

      public JobBasePropertiesConstraints constraints()
      Get constraints associated with the Job.
      Returns:
      the constraints value

    • withConstraints

      public JobCreateParameters withConstraints(JobBasePropertiesConstraints constraints)
      Set constraints associated with the Job.
      Parameters:
      constraints - the constraints value to set
      Returns:
      the JobCreateParameters object itself.