Package com.azure.resourcemanager.machinelearning.models

Class PipelineJob

  • public final class PipelineJob
extends JobBaseDetails
    Pipeline Job definition: defines generic to MFE attributes.

    • Constructor Detail

      • PipelineJob

        public PipelineJob()

    • Method Detail

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

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

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

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

      • withComputeId

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

      • withIsArchived

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

      • withDescription

        public PipelineJob 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 PipelineJob 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 PipelineJob 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.