Package com.azure.resourcemanager.machinelearning.models

Class SweepJob

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

  • Constructor Details

    • SweepJob

      public SweepJob()
      Creates an instance of SweepJob 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.

    • searchSpace

      public Object searchSpace()
      Get the searchSpace property: [Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter.
      Returns:
      the searchSpace value.

    • withSearchSpace

      public SweepJob withSearchSpace(Object searchSpace)
      Set the searchSpace property: [Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter.
      Parameters:
      searchSpace - the searchSpace value to set.
      Returns:
      the SweepJob object itself.

    • samplingAlgorithm

      public SamplingAlgorithm samplingAlgorithm()
      Get the samplingAlgorithm property: [Required] The hyperparameter sampling algorithm.
      Returns:
      the samplingAlgorithm value.

    • withSamplingAlgorithm

      public SweepJob withSamplingAlgorithm(SamplingAlgorithm samplingAlgorithm)
      Set the samplingAlgorithm property: [Required] The hyperparameter sampling algorithm.
      Parameters:
      samplingAlgorithm - the samplingAlgorithm value to set.
      Returns:
      the SweepJob object itself.

    • limits

      public SweepJobLimits limits()
      Get the limits property: Sweep Job limit.
      Returns:
      the limits value.

    • withLimits

      public SweepJob withLimits(SweepJobLimits limits)
      Set the limits property: Sweep Job limit.
      Parameters:
      limits - the limits value to set.
      Returns:
      the SweepJob object itself.

    • earlyTermination

      public EarlyTerminationPolicy earlyTermination()
      Get the earlyTermination property: Early termination policies enable canceling poor-performing runs before they complete.
      Returns:
      the earlyTermination value.

    • withEarlyTermination

      public SweepJob withEarlyTermination(EarlyTerminationPolicy earlyTermination)
      Set the earlyTermination property: Early termination policies enable canceling poor-performing runs before they complete.
      Parameters:
      earlyTermination - the earlyTermination value to set.
      Returns:
      the SweepJob object itself.

    • objective

      public Objective objective()
      Get the objective property: [Required] Optimization objective.
      Returns:
      the objective value.

    • withObjective

      public SweepJob withObjective(Objective objective)
      Set the objective property: [Required] Optimization objective.
      Parameters:
      objective - the objective value to set.
      Returns:
      the SweepJob object itself.

    • trial

      public TrialComponent trial()
      Get the trial property: [Required] Trial component definition.
      Returns:
      the trial value.

    • withTrial

      public SweepJob withTrial(TrialComponent trial)
      Set the trial property: [Required] Trial component definition.
      Parameters:
      trial - the trial value to set.
      Returns:
      the SweepJob 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 SweepJob 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 SweepJob 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 SweepJob 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 SweepJob object itself.

    • queueSettings

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

    • withQueueSettings

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