Package com.azure.resourcemanager.machinelearning.models

Class JobBaseProperties

java.lang.Object
com.azure.resourcemanager.machinelearning.models.ResourceBase
com.azure.resourcemanager.machinelearning.models.JobBaseProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResourceBase>
Direct Known Subclasses:
AutoMLJob, CommandJob, PipelineJob, SparkJob, SweepJob
public class JobBaseProperties extends ResourceBase
Base definition for a job.

  • Constructor Details

    • JobBaseProperties

      public JobBaseProperties()
      Creates an instance of JobBaseProperties class.

  • Method Details

    • jobType

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

    • displayName

      public String displayName()
      Get the displayName property: Display name of job.
      Returns:
      the displayName value.

    • withDisplayName

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

    • status

      public JobStatus status()
      Get the status property: Status of the job.
      Returns:
      the status value.

    • experimentName

      public String experimentName()
      Get the experimentName property: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
      Returns:
      the experimentName value.

    • withExperimentName

      public JobBaseProperties 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.
      Parameters:
      experimentName - the experimentName value to set.
      Returns:
      the JobBaseProperties object itself.

    • services

      public Map<String,JobService> services()
      Get the services property: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
      Returns:
      the services value.

    • withServices

      public JobBaseProperties 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.
      Parameters:
      services - the services value to set.
      Returns:
      the JobBaseProperties object itself.

    • computeId

      public String computeId()
      Get the computeId property: ARM resource ID of the compute resource.
      Returns:
      the computeId value.

    • withComputeId

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

    • isArchived

      public Boolean isArchived()
      Get the isArchived property: Is the asset archived?.
      Returns:
      the isArchived value.

    • withIsArchived

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

    • identity

      public IdentityConfiguration identity()
      Get the identity property: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.
      Returns:
      the identity value.

    • withIdentity

      public JobBaseProperties 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.
      Parameters:
      identity - the identity value to set.
      Returns:
      the JobBaseProperties object itself.

    • componentId

      public String componentId()
      Get the componentId property: ARM resource ID of the component resource.
      Returns:
      the componentId value.

    • withComponentId

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

    • notificationSetting

      public NotificationSetting notificationSetting()
      Get the notificationSetting property: Notification setting for the job.
      Returns:
      the notificationSetting value.

    • withNotificationSetting

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

    • withDescription

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

    • withTags

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

    • withProperties

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

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ResourceBase
      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 ResourceBase
      Throws:
      IOException

    • fromJson

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