Package com.azure.resourcemanager.machinelearning.models

Class AutoMLJob

java.lang.Object
com.azure.resourcemanager.machinelearning.models.ResourceBase
com.azure.resourcemanager.machinelearning.models.JobBaseProperties
com.azure.resourcemanager.machinelearning.models.AutoMLJob
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResourceBase>
public final class AutoMLJob extends JobBaseProperties
AutoMLJob class. Use this class for executing AutoML tasks like Classification/Regression etc. See TaskType enum for all the tasks supported.

  • Constructor Details

    • AutoMLJob

      public AutoMLJob()
      Creates an instance of AutoMLJob 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 AutoMLJob withResources(JobResourceConfiguration resources)
      Set the resources property: Compute Resource configuration for the job.
      Parameters:
      resources - the resources value to set.
      Returns:
      the AutoMLJob object itself.

    • environmentId

      public String environmentId()
      Get the environmentId property: The ARM resource ID of the Environment specification for the job. This is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.
      Returns:
      the environmentId value.

    • withEnvironmentId

      public AutoMLJob withEnvironmentId(String environmentId)
      Set the environmentId property: The ARM resource ID of the Environment specification for the job. This is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.
      Parameters:
      environmentId - the environmentId value to set.
      Returns:
      the AutoMLJob object itself.

    • environmentVariables

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

    • withEnvironmentVariables

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

    • taskDetails

      public AutoMLVertical taskDetails()
      Get the taskDetails property: [Required] This represents scenario which can be one of Tables/NLP/Image.
      Returns:
      the taskDetails value.

    • withTaskDetails

      public AutoMLJob withTaskDetails(AutoMLVertical taskDetails)
      Set the taskDetails property: [Required] This represents scenario which can be one of Tables/NLP/Image.
      Parameters:
      taskDetails - the taskDetails value to set.
      Returns:
      the AutoMLJob 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 AutoMLJob 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 AutoMLJob object itself.

    • queueSettings

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

    • withQueueSettings

      public AutoMLJob withQueueSettings(QueueSettings queueSettings)
      Set the queueSettings property: Queue settings for the job.
      Parameters:
      queueSettings - the queueSettings value to set.
      Returns:
      the AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob 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 AutoMLJob fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AutoMLJob from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AutoMLJob 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 AutoMLJob.