Class AutoMLJob


  • public final class AutoMLJob
    extends JobBaseDetails
    AutoMLJob class. Use this class for executing AutoML tasks like Classification/Regression etc. See TaskType enum for all the tasks supported.
    • Constructor Detail

      • AutoMLJob

        public AutoMLJob()
    • Method Detail

      • 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.
      • 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.
      • resources

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

        public AutoMLJob withResources​(ResourceConfiguration resources)
        Set the resources property: Compute Resource configuration for the job.
        Parameters:
        resources - the resources 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.
      • withComputeId

        public AutoMLJob withComputeId​(String computeId)
        Set the computeId property: ARM resource ID of the compute resource.
        Overrides:
        withComputeId in class JobBaseDetails
        Parameters:
        computeId - the computeId value to set.
        Returns:
        the JobBaseDetails object itself.
      • withDisplayName

        public AutoMLJob withDisplayName​(String displayName)
        Set the displayName property: Display name of job.
        Overrides:
        withDisplayName in class JobBaseDetails
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the JobBaseDetails 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 JobBaseDetails
        Parameters:
        experimentName - the experimentName value to set.
        Returns:
        the JobBaseDetails 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 JobBaseDetails
        Parameters:
        identity - the identity value to set.
        Returns:
        the JobBaseDetails object itself.
      • withIsArchived

        public AutoMLJob withIsArchived​(Boolean isArchived)
        Set the isArchived property: Is the asset archived?.
        Overrides:
        withIsArchived in class JobBaseDetails
        Parameters:
        isArchived - the isArchived value to set.
        Returns:
        the JobBaseDetails object itself.
      • withSchedule

        public AutoMLJob withSchedule​(ScheduleBase schedule)
        Set the schedule property: Schedule definition of job. If no schedule is provided, the job is run once and immediately after submission.
        Overrides:
        withSchedule in class JobBaseDetails
        Parameters:
        schedule - the schedule value to set.
        Returns:
        the JobBaseDetails 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 JobBaseDetails
        Parameters:
        services - the services value to set.
        Returns:
        the JobBaseDetails object itself.
      • withDescription

        public AutoMLJob withDescription​(String description)
        Set the description property: The asset description text.
        Overrides:
        withDescription in class JobBaseDetails
        Parameters:
        description - the description 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 JobBaseDetails
        Parameters:
        properties - the properties 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 JobBaseDetails
        Parameters:
        tags - the tags value to set.
        Returns:
        the ResourceBase object itself.