Package com.azure.resourcemanager.machinelearning.models

Class CommandJob

java.lang.Object
com.azure.resourcemanager.machinelearning.models.ResourceBase
com.azure.resourcemanager.machinelearning.models.JobBaseProperties
com.azure.resourcemanager.machinelearning.models.CommandJob
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResourceBase>
public final class CommandJob extends JobBaseProperties
Command job definition.

  • Constructor Details

    • CommandJob

      public CommandJob()
      Creates an instance of CommandJob class.

  • Method Details

    • jobType

      public JobType jobType()
      Get the jobType property: [Required] Specifies the type of job.
      Overrides:
      jobType in class JobBaseProperties
      Returns:
      the jobType value.

    • resources

      public JobResourceConfiguration resources()
      Get the resources property: Compute Resource configuration for the job.
      Returns:
      the resources value.

    • withResources

      public CommandJob withResources(JobResourceConfiguration resources)
      Set the resources property: Compute Resource configuration for the job.
      Parameters:
      resources - the resources value to set.
      Returns:
      the CommandJob object itself.

    • codeId

      public String codeId()
      Get the codeId property: ARM resource ID of the code asset.
      Returns:
      the codeId value.

    • withCodeId

      public CommandJob withCodeId(String codeId)
      Set the codeId property: ARM resource ID of the code asset.
      Parameters:
      codeId - the codeId value to set.
      Returns:
      the CommandJob object itself.

    • command

      public String command()
      Get the command property: [Required] The command to execute on startup of the job. eg. "python train.py".
      Returns:
      the command value.

    • withCommand

      public CommandJob withCommand(String command)
      Set the command property: [Required] The command to execute on startup of the job. eg. "python train.py".
      Parameters:
      command - the command value to set.
      Returns:
      the CommandJob object itself.

    • environmentId

      public String environmentId()
      Get the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.
      Returns:
      the environmentId value.

    • withEnvironmentId

      public CommandJob withEnvironmentId(String environmentId)
      Set the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.
      Parameters:
      environmentId - the environmentId value to set.
      Returns:
      the CommandJob object itself.

    • inputs

      public Map<String,JobInput> inputs()
      Get the inputs property: Mapping of input data bindings used in the job.
      Returns:
      the inputs value.

    • withInputs

      public CommandJob withInputs(Map<String,JobInput> inputs)
      Set the inputs property: Mapping of input data bindings used in the job.
      Parameters:
      inputs - the inputs value to set.
      Returns:
      the CommandJob object itself.

    • outputs

      public Map<String,JobOutput> outputs()
      Get the outputs property: Mapping of output data bindings used in the job.
      Returns:
      the outputs value.

    • withOutputs

      public CommandJob withOutputs(Map<String,JobOutput> outputs)
      Set the outputs property: Mapping of output data bindings used in the job.
      Parameters:
      outputs - the outputs value to set.
      Returns:
      the CommandJob object itself.

    • distribution

      public DistributionConfiguration distribution()
      Get the distribution property: Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.
      Returns:
      the distribution value.

    • withDistribution

      public CommandJob withDistribution(DistributionConfiguration distribution)
      Set the distribution property: Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.
      Parameters:
      distribution - the distribution value to set.
      Returns:
      the CommandJob object itself.

    • limits

      public CommandJobLimits limits()
      Get the limits property: Command Job limit.
      Returns:
      the limits value.

    • withLimits

      public CommandJob withLimits(CommandJobLimits limits)
      Set the limits property: Command Job limit.
      Parameters:
      limits - the limits value to set.
      Returns:
      the CommandJob object itself.

    • environmentVariables

      public Map<String,String> environmentVariables()
      Get the environmentVariables property: Environment variables included in the job.
      Returns:
      the environmentVariables value.

    • withEnvironmentVariables

      public CommandJob withEnvironmentVariables(Map<String,String> environmentVariables)
      Set the environmentVariables property: Environment variables included in the job.
      Parameters:
      environmentVariables - the environmentVariables value to set.
      Returns:
      the CommandJob object itself.

    • parameters

      public Object parameters()
      Get the parameters property: Input parameters.
      Returns:
      the parameters value.

    • queueSettings

      public QueueSettings queueSettings()
      Get the queueSettings property: Queue settings for the job.
      Returns:
      the queueSettings value.

    • withQueueSettings

      public CommandJob withQueueSettings(QueueSettings queueSettings)
      Set the queueSettings property: Queue settings for the job.
      Parameters:
      queueSettings - the queueSettings value to set.
      Returns:
      the CommandJob object itself.

    • status

      public JobStatus status()
      Get the status property: Status of the job.
      Overrides:
      status in class JobBaseProperties
      Returns:
      the status value.

    • withDisplayName

      public CommandJob withDisplayName(String displayName)
      Set the displayName property: Display name of job.
      Overrides:
      withDisplayName in class JobBaseProperties
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the JobBaseProperties object itself.

    • withExperimentName

      public CommandJob withExperimentName(String experimentName)
      Set the experimentName property: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
      Overrides:
      withExperimentName in class JobBaseProperties
      Parameters:
      experimentName - the experimentName value to set.
      Returns:
      the JobBaseProperties object itself.

    • withServices

      public CommandJob withServices(Map<String,JobService> services)
      Set the services property: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
      Overrides:
      withServices in class JobBaseProperties
      Parameters:
      services - the services value to set.
      Returns:
      the JobBaseProperties object itself.

    • withComputeId

      public CommandJob withComputeId(String computeId)
      Set the computeId property: ARM resource ID of the compute resource.
      Overrides:
      withComputeId in class JobBaseProperties
      Parameters:
      computeId - the computeId value to set.
      Returns:
      the JobBaseProperties object itself.

    • withIsArchived

      public CommandJob withIsArchived(Boolean isArchived)
      Set the isArchived property: Is the asset archived?.
      Overrides:
      withIsArchived in class JobBaseProperties
      Parameters:
      isArchived - the isArchived value to set.
      Returns:
      the JobBaseProperties object itself.

    • withIdentity

      public CommandJob withIdentity(IdentityConfiguration identity)
      Set the identity property: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.
      Overrides:
      withIdentity in class JobBaseProperties
      Parameters:
      identity - the identity value to set.
      Returns:
      the JobBaseProperties object itself.

    • withComponentId

      public CommandJob withComponentId(String componentId)
      Set the componentId property: ARM resource ID of the component resource.
      Overrides:
      withComponentId in class JobBaseProperties
      Parameters:
      componentId - the componentId value to set.
      Returns:
      the JobBaseProperties object itself.

    • withNotificationSetting

      public CommandJob withNotificationSetting(NotificationSetting notificationSetting)
      Set the notificationSetting property: Notification setting for the job.
      Overrides:
      withNotificationSetting in class JobBaseProperties
      Parameters:
      notificationSetting - the notificationSetting value to set.
      Returns:
      the JobBaseProperties object itself.

    • withDescription

      public CommandJob withDescription(String description)
      Set the description property: The asset description text.
      Overrides:
      withDescription in class JobBaseProperties
      Parameters:
      description - the description value to set.
      Returns:
      the ResourceBase object itself.

    • withTags

      public CommandJob withTags(Map<String,String> tags)
      Set the tags property: Tag dictionary. Tags can be added, removed, and updated.
      Overrides:
      withTags in class JobBaseProperties
      Parameters:
      tags - the tags value to set.
      Returns:
      the ResourceBase object itself.

    • withProperties

      public CommandJob withProperties(Map<String,String> properties)
      Set the properties property: The asset property dictionary.
      Overrides:
      withProperties in class JobBaseProperties
      Parameters:
      properties - the properties value to set.
      Returns:
      the ResourceBase object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class JobBaseProperties
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ResourceBase>
      Overrides:
      toJson in class JobBaseProperties
      Throws:
      IOException

    • fromJson

      public static CommandJob fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of CommandJob from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of CommandJob if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the CommandJob.