Class JobBaseDetails
- java.lang.Object
-
- com.azure.resourcemanager.machinelearning.models.ResourceBase
-
- com.azure.resourcemanager.machinelearning.models.JobBaseDetails
-
- Direct Known Subclasses:
AutoMLJob
,CommandJob
,PipelineJob
,SweepJob
public class JobBaseDetails extends ResourceBase
Base definition for a job.
-
-
Constructor Summary
Constructors Constructor Description JobBaseDetails()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
computeId()
Get the computeId property: ARM resource ID of the compute resource.String
displayName()
Get the displayName property: Display name of job.String
experimentName()
Get the experimentName property: The name of the experiment the job belongs to.IdentityConfiguration
identity()
Get the identity property: Identity configuration.Boolean
isArchived()
Get the isArchived property: Is the asset archived?.ScheduleBase
schedule()
Get the schedule property: Schedule definition of job.Map<String,JobService>
services()
Get the services property: List of JobEndpoints.JobStatus
status()
Get the status property: Status of the job.void
validate()
Validates the instance.JobBaseDetails
withComputeId(String computeId)
Set the computeId property: ARM resource ID of the compute resource.JobBaseDetails
withDescription(String description)
Set the description property: The asset description text.JobBaseDetails
withDisplayName(String displayName)
Set the displayName property: Display name of job.JobBaseDetails
withExperimentName(String experimentName)
Set the experimentName property: The name of the experiment the job belongs to.JobBaseDetails
withIdentity(IdentityConfiguration identity)
Set the identity property: Identity configuration.JobBaseDetails
withIsArchived(Boolean isArchived)
Set the isArchived property: Is the asset archived?.JobBaseDetails
withProperties(Map<String,String> properties)
Set the properties property: The asset property dictionary.JobBaseDetails
withSchedule(ScheduleBase schedule)
Set the schedule property: Schedule definition of job.JobBaseDetails
withServices(Map<String,JobService> services)
Set the services property: List of JobEndpoints.JobBaseDetails
withTags(Map<String,String> tags)
Set the tags property: Tag dictionary.-
Methods inherited from class com.azure.resourcemanager.machinelearning.models.ResourceBase
description, properties, tags
-
-
-
-
Method Detail
-
computeId
public String computeId()
Get the computeId property: ARM resource ID of the compute resource.- Returns:
- the computeId value.
-
withComputeId
public JobBaseDetails withComputeId(String computeId)
Set the computeId property: ARM resource ID of the compute resource.- Parameters:
computeId
- the computeId value to set.- Returns:
- the JobBaseDetails object itself.
-
displayName
public String displayName()
Get the displayName property: Display name of job.- Returns:
- the displayName value.
-
withDisplayName
public JobBaseDetails withDisplayName(String displayName)
Set the displayName property: Display name of job.- Parameters:
displayName
- the displayName value to set.- Returns:
- the JobBaseDetails object itself.
-
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 JobBaseDetails 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 JobBaseDetails 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 JobBaseDetails 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 JobBaseDetails object itself.
-
isArchived
public Boolean isArchived()
Get the isArchived property: Is the asset archived?.- Returns:
- the isArchived value.
-
withIsArchived
public JobBaseDetails withIsArchived(Boolean isArchived)
Set the isArchived property: Is the asset archived?.- Parameters:
isArchived
- the isArchived value to set.- Returns:
- the JobBaseDetails object itself.
-
schedule
public ScheduleBase schedule()
Get the schedule property: Schedule definition of job. If no schedule is provided, the job is run once and immediately after submission.- Returns:
- the schedule value.
-
withSchedule
public JobBaseDetails 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.- Parameters:
schedule
- the schedule value to set.- Returns:
- the JobBaseDetails 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 JobBaseDetails 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 JobBaseDetails object itself.
-
status
public JobStatus status()
Get the status property: Status of the job.- Returns:
- the status value.
-
withDescription
public JobBaseDetails withDescription(String description)
Set the description property: The asset description text.- Overrides:
withDescription
in classResourceBase
- Parameters:
description
- the description value to set.- Returns:
- the ResourceBase object itself.
-
withProperties
public JobBaseDetails withProperties(Map<String,String> properties)
Set the properties property: The asset property dictionary.- Overrides:
withProperties
in classResourceBase
- Parameters:
properties
- the properties value to set.- Returns:
- the ResourceBase object itself.
-
withTags
public JobBaseDetails withTags(Map<String,String> tags)
Set the tags property: Tag dictionary. Tags can be added, removed, and updated.- Overrides:
withTags
in classResourceBase
- Parameters:
tags
- the tags value to set.- Returns:
- the ResourceBase object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classResourceBase
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-