Package com.azure.resourcemanager.machinelearning.models

Class PipelineJob

java.lang.Object
com.azure.resourcemanager.machinelearning.models.ResourceBase
com.azure.resourcemanager.machinelearning.models.JobBaseProperties
com.azure.resourcemanager.machinelearning.models.PipelineJob
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResourceBase>
public final class PipelineJob extends JobBaseProperties
Pipeline Job definition: defines generic to MFE attributes.

  • Constructor Details

    • PipelineJob

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

    • settings

      public Object settings()
      Get the settings property: Pipeline settings, for things like ContinueRunOnStepFailure etc.
      Returns:
      the settings value.

    • withSettings

      public PipelineJob withSettings(Object settings)
      Set the settings property: Pipeline settings, for things like ContinueRunOnStepFailure etc.
      Parameters:
      settings - the settings value to set.
      Returns:
      the PipelineJob object itself.

    • jobs

      public Map<String,Object> jobs()
      Get the jobs property: Jobs construct the Pipeline Job.
      Returns:
      the jobs value.

    • withJobs

      public PipelineJob withJobs(Map<String,Object> jobs)
      Set the jobs property: Jobs construct the Pipeline Job.
      Parameters:
      jobs - the jobs value to set.
      Returns:
      the PipelineJob object itself.

    • inputs

      public Map<String,JobInput> inputs()
      Get the inputs property: Inputs for the pipeline job.
      Returns:
      the inputs value.

    • withInputs

      public PipelineJob withInputs(Map<String,JobInput> inputs)
      Set the inputs property: Inputs for the pipeline job.
      Parameters:
      inputs - the inputs value to set.
      Returns:
      the PipelineJob object itself.

    • outputs

      public Map<String,JobOutput> outputs()
      Get the outputs property: Outputs for the pipeline job.
      Returns:
      the outputs value.

    • withOutputs

      public PipelineJob withOutputs(Map<String,JobOutput> outputs)
      Set the outputs property: Outputs for the pipeline job.
      Parameters:
      outputs - the outputs value to set.
      Returns:
      the PipelineJob object itself.

    • sourceJobId

      public String sourceJobId()
      Get the sourceJobId property: ARM resource ID of source job.
      Returns:
      the sourceJobId value.

    • withSourceJobId

      public PipelineJob withSourceJobId(String sourceJobId)
      Set the sourceJobId property: ARM resource ID of source job.
      Parameters:
      sourceJobId - the sourceJobId value to set.
      Returns:
      the PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob 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 PipelineJob fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PipelineJob from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PipelineJob 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 PipelineJob.