### YamlMime:JavaType
uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob"
name: "PipelineJob"
nameWithType: "PipelineJob"
summary: "Pipeline Job definition: defines generic to MFE attributes."
inheritances:
- ""
- ""
- ""
inheritedClassMethods:
- classRef: ""
methodsRef:
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ")?alt=com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withProperties&text=withProperties\" data-throw-if-not-resolved=\"False\" />"
- ")?alt=com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withServices&text=withServices\" data-throw-if-not-resolved=\"False\" />"
- ")?alt=com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withTags&text=withTags\" data-throw-if-not-resolved=\"False\" />"
- classRef: ""
methodsRef:
- ""
- ""
- ""
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public final class **PipelineJob** extends "
constructors:
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.PipelineJob()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.PipelineJob()"
name: "PipelineJob()"
nameWithType: "PipelineJob.PipelineJob()"
summary: "Creates an instance of PipelineJob class."
syntax: "public PipelineJob()"
desc: "Creates an instance of PipelineJob class."
methods:
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "PipelineJob.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of PipelineJob from the JsonReader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: ""
syntax: "public static PipelineJob fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the PipelineJob."
type: "IOException"
desc: "Reads an instance of PipelineJob from the JsonReader."
returns:
description: "An instance of PipelineJob if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.inputs()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.inputs()"
name: "inputs()"
nameWithType: "PipelineJob.inputs()"
summary: "Get the inputs property: Inputs for the pipeline job."
syntax: "public Map inputs()"
desc: "Get the inputs property: Inputs for the pipeline job."
returns:
description: "the inputs value."
type: "Map<String,>"
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.jobType()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.jobType()"
name: "jobType()"
nameWithType: "PipelineJob.jobType()"
summary: "Get the jobType property: \\[Required\\] Specifies the type of job."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.jobType()"
syntax: "public JobType jobType()"
desc: "Get the jobType property: \\[Required\\] Specifies the type of job."
returns:
description: "the jobType value."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.jobs()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.jobs()"
name: "jobs()"
nameWithType: "PipelineJob.jobs()"
summary: "Get the jobs property: Jobs construct the Pipeline Job."
syntax: "public Map jobs()"
desc: "Get the jobs property: Jobs construct the Pipeline Job."
returns:
description: "the jobs value."
type: "Map<String,Object>"
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.outputs()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.outputs()"
name: "outputs()"
nameWithType: "PipelineJob.outputs()"
summary: "Get the outputs property: Outputs for the pipeline job."
syntax: "public Map outputs()"
desc: "Get the outputs property: Outputs for the pipeline job."
returns:
description: "the outputs value."
type: "Map<String,>"
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.settings()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.settings()"
name: "settings()"
nameWithType: "PipelineJob.settings()"
summary: "Get the settings property: Pipeline settings, for things like ContinueRunOnStepFailure etc."
syntax: "public Object settings()"
desc: "Get the settings property: Pipeline settings, for things like ContinueRunOnStepFailure etc."
returns:
description: "the settings value."
type: "Object"
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.sourceJobId()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.sourceJobId()"
name: "sourceJobId()"
nameWithType: "PipelineJob.sourceJobId()"
summary: "Get the sourceJobId property: ARM resource ID of source job."
syntax: "public String sourceJobId()"
desc: "Get the sourceJobId property: ARM resource ID of source job."
returns:
description: "the sourceJobId value."
type: "String"
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.status()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.status()"
name: "status()"
nameWithType: "PipelineJob.status()"
summary: "Get the status property: Status of the job."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.status()"
syntax: "public JobStatus status()"
desc: "Get the status property: Status of the job."
returns:
description: "the status value."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "PipelineJob.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.toJson(com.azure.json.JsonWriter)"
parameters:
- name: "jsonWriter"
type: ""
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "IOException"
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.validate()"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.validate()"
name: "validate()"
nameWithType: "PipelineJob.validate()"
summary: "Validates the instance."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.validate()"
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withComponentId(java.lang.String)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withComponentId(String componentId)"
name: "withComponentId(String componentId)"
nameWithType: "PipelineJob.withComponentId(String componentId)"
summary: "Set the componentId property: ARM resource ID of the component resource."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withComponentId(java.lang.String)"
parameters:
- name: "componentId"
type: "String"
syntax: "public PipelineJob withComponentId(String componentId)"
desc: "Set the componentId property: ARM resource ID of the component resource."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withComputeId(java.lang.String)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withComputeId(String computeId)"
name: "withComputeId(String computeId)"
nameWithType: "PipelineJob.withComputeId(String computeId)"
summary: "Set the computeId property: ARM resource ID of the compute resource."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withComputeId(java.lang.String)"
parameters:
- name: "computeId"
type: "String"
syntax: "public PipelineJob withComputeId(String computeId)"
desc: "Set the computeId property: ARM resource ID of the compute resource."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withDescription(java.lang.String)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withDescription(String description)"
name: "withDescription(String description)"
nameWithType: "PipelineJob.withDescription(String description)"
summary: "Set the description property: The asset description text."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withDescription(java.lang.String)"
parameters:
- name: "description"
type: "String"
syntax: "public PipelineJob withDescription(String description)"
desc: "Set the description property: The asset description text."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withDisplayName(java.lang.String)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withDisplayName(String displayName)"
name: "withDisplayName(String displayName)"
nameWithType: "PipelineJob.withDisplayName(String displayName)"
summary: "Set the displayName property: Display name of job."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withDisplayName(java.lang.String)"
parameters:
- name: "displayName"
type: "String"
syntax: "public PipelineJob withDisplayName(String displayName)"
desc: "Set the displayName property: Display name of job."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withExperimentName(java.lang.String)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withExperimentName(String experimentName)"
name: "withExperimentName(String experimentName)"
nameWithType: "PipelineJob.withExperimentName(String experimentName)"
summary: "Set the experimentName property: The name of the experiment the job belongs to."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withExperimentName(java.lang.String)"
parameters:
- name: "experimentName"
type: "String"
syntax: "public PipelineJob withExperimentName(String experimentName)"
desc: "Set the experimentName property: The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withIdentity(com.azure.resourcemanager.machinelearning.models.IdentityConfiguration)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withIdentity(IdentityConfiguration identity)"
name: "withIdentity(IdentityConfiguration identity)"
nameWithType: "PipelineJob.withIdentity(IdentityConfiguration identity)"
summary: "Set the identity property: Identity configuration."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withIdentity(com.azure.resourcemanager.machinelearning.models.IdentityConfiguration)"
parameters:
- name: "identity"
type: ""
syntax: "public PipelineJob withIdentity(IdentityConfiguration identity)"
desc: "Set the identity property: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withInputs(java.util.Map)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withInputs(Map inputs)"
name: "withInputs(Map inputs)"
nameWithType: "PipelineJob.withInputs(Map inputs)"
summary: "Set the inputs property: Inputs for the pipeline job."
parameters:
- description: "the inputs value to set."
name: "inputs"
type: "Map<String,>"
syntax: "public PipelineJob withInputs(Map inputs)"
desc: "Set the inputs property: Inputs for the pipeline job."
returns:
description: "the PipelineJob object itself."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withIsArchived(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withIsArchived(Boolean isArchived)"
name: "withIsArchived(Boolean isArchived)"
nameWithType: "PipelineJob.withIsArchived(Boolean isArchived)"
summary: "Set the isArchived property: Is the asset archived?."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withIsArchived(java.lang.Boolean)"
parameters:
- name: "isArchived"
type: "Boolean"
syntax: "public PipelineJob withIsArchived(Boolean isArchived)"
desc: "Set the isArchived property: Is the asset archived?."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withJobs(java.util.Map)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withJobs(Map jobs)"
name: "withJobs(Map jobs)"
nameWithType: "PipelineJob.withJobs(Map jobs)"
summary: "Set the jobs property: Jobs construct the Pipeline Job."
parameters:
- description: "the jobs value to set."
name: "jobs"
type: "Map<String,Object>"
syntax: "public PipelineJob withJobs(Map jobs)"
desc: "Set the jobs property: Jobs construct the Pipeline Job."
returns:
description: "the PipelineJob object itself."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withNotificationSetting(com.azure.resourcemanager.machinelearning.models.NotificationSetting)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withNotificationSetting(NotificationSetting notificationSetting)"
name: "withNotificationSetting(NotificationSetting notificationSetting)"
nameWithType: "PipelineJob.withNotificationSetting(NotificationSetting notificationSetting)"
summary: "Set the notificationSetting property: Notification setting for the job."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withNotificationSetting(com.azure.resourcemanager.machinelearning.models.NotificationSetting)"
parameters:
- name: "notificationSetting"
type: ""
syntax: "public PipelineJob withNotificationSetting(NotificationSetting notificationSetting)"
desc: "Set the notificationSetting property: Notification setting for the job."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withOutputs(java.util.Map)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withOutputs(Map outputs)"
name: "withOutputs(Map outputs)"
nameWithType: "PipelineJob.withOutputs(Map outputs)"
summary: "Set the outputs property: Outputs for the pipeline job."
parameters:
- description: "the outputs value to set."
name: "outputs"
type: "Map<String,>"
syntax: "public PipelineJob withOutputs(Map outputs)"
desc: "Set the outputs property: Outputs for the pipeline job."
returns:
description: "the PipelineJob object itself."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withProperties(java.util.Map)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withProperties(Map properties)"
name: "withProperties(Map properties)"
nameWithType: "PipelineJob.withProperties(Map properties)"
summary: "Set the properties property: The asset property dictionary."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withProperties(java.util.Map)"
parameters:
- name: "properties"
type: "Map<String,String>"
syntax: "public PipelineJob withProperties(Map properties)"
desc: "Set the properties property: The asset property dictionary."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withServices(java.util.Map)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withServices(Map services)"
name: "withServices(Map services)"
nameWithType: "PipelineJob.withServices(Map services)"
summary: "Set the services property: List of JobEndpoints."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withServices(java.util.Map)"
parameters:
- name: "services"
type: "Map<String,>"
syntax: "public PipelineJob withServices(Map services)"
desc: "Set the services property: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject."
returns:
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withSettings(java.lang.Object)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withSettings(Object settings)"
name: "withSettings(Object settings)"
nameWithType: "PipelineJob.withSettings(Object settings)"
summary: "Set the settings property: Pipeline settings, for things like ContinueRunOnStepFailure etc."
parameters:
- description: "the settings value to set."
name: "settings"
type: "Object"
syntax: "public PipelineJob withSettings(Object settings)"
desc: "Set the settings property: Pipeline settings, for things like ContinueRunOnStepFailure etc."
returns:
description: "the PipelineJob object itself."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withSourceJobId(java.lang.String)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withSourceJobId(String sourceJobId)"
name: "withSourceJobId(String sourceJobId)"
nameWithType: "PipelineJob.withSourceJobId(String sourceJobId)"
summary: "Set the sourceJobId property: ARM resource ID of source job."
parameters:
- description: "the sourceJobId value to set."
name: "sourceJobId"
type: "String"
syntax: "public PipelineJob withSourceJobId(String sourceJobId)"
desc: "Set the sourceJobId property: ARM resource ID of source job."
returns:
description: "the PipelineJob object itself."
type: ""
- uid: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withTags(java.util.Map)"
fullName: "com.azure.resourcemanager.machinelearning.models.PipelineJob.withTags(Map tags)"
name: "withTags(Map tags)"
nameWithType: "PipelineJob.withTags(Map tags)"
summary: "Set the tags property: Tag dictionary."
overridden: "com.azure.resourcemanager.machinelearning.models.JobBaseProperties.withTags(java.util.Map)"
parameters:
- name: "tags"
type: "Map<String,String>"
syntax: "public PipelineJob withTags(Map tags)"
desc: "Set the tags property: Tag dictionary. Tags can be added, removed, and updated."
returns:
type: ""
type: "class"
desc: "Pipeline Job definition: defines generic to MFE attributes."
metadata: {}
package: "com.azure.resourcemanager.machinelearning.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0