CommandJob Class

Package:
com.azure.resourcemanager.machinelearning.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0

public final class CommandJob
extends JobBaseProperties

Command job definition.

Constructor Summary

Constructor Description
CommandJob()

Creates an instance of CommandJob class.

Method Summary

Modifier and Type Method and Description
String codeId()

Get the codeId property: ARM resource ID of the code asset.
String command()

Get the command property: [Required] The command to execute on startup of the job.
DistributionConfiguration distribution()

Get the distribution property: Distribution configuration of the job.
String environmentId()

Get the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.
Map<String,String> environmentVariables()

Get the environmentVariables property: Environment variables included in the job.
static CommandJob fromJson(JsonReader jsonReader)

Reads an instance of CommandJob from the JsonReader.
Map<String,JobInput> inputs()

Get the inputs property: Mapping of input data bindings used in the job.
JobType jobType()

Get the jobType property: [Required] Specifies the type of job.
CommandJobLimits limits()

Get the limits property: Command Job limit.
Map<String,JobOutput> outputs()

Get the outputs property: Mapping of output data bindings used in the job.
Object parameters()

Get the parameters property: Input parameters.
QueueSettings queueSettings()

Get the queueSettings property: Queue settings for the job.
JobResourceConfiguration resources()

Get the resources property: Compute Resource configuration for the job.
JobStatus status()

Get the status property: Status of the job.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
CommandJob withCodeId(String codeId)

Set the codeId property: ARM resource ID of the code asset.
CommandJob withCommand(String command)

Set the command property: [Required] The command to execute on startup of the job.
CommandJob withComponentId(String componentId)

Set the componentId property: ARM resource ID of the component resource.
CommandJob withComputeId(String computeId)

Set the computeId property: ARM resource ID of the compute resource.
CommandJob withDescription(String description)

Set the description property: The asset description text.
CommandJob withDisplayName(String displayName)

Set the displayName property: Display name of job.
CommandJob withDistribution(DistributionConfiguration distribution)

Set the distribution property: Distribution configuration of the job.
CommandJob withEnvironmentId(String environmentId)

Set the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.
CommandJob withEnvironmentVariables(Map<String,String> environmentVariables)

Set the environmentVariables property: Environment variables included in the job.
CommandJob withExperimentName(String experimentName)

Set the experimentName property: The name of the experiment the job belongs to.
CommandJob withIdentity(IdentityConfiguration identity)

Set the identity property: Identity configuration.
CommandJob withInputs(Map<String,JobInput> inputs)

Set the inputs property: Mapping of input data bindings used in the job.
CommandJob withIsArchived(Boolean isArchived)

Set the isArchived property: Is the asset archived?.
CommandJob withLimits(CommandJobLimits limits)

Set the limits property: Command Job limit.
CommandJob withNotificationSetting(NotificationSetting notificationSetting)

Set the notificationSetting property: Notification setting for the job.
CommandJob withOutputs(Map<String,JobOutput> outputs)

Set the outputs property: Mapping of output data bindings used in the job.
CommandJob withProperties(Map<String,String> properties)

Set the properties property: The asset property dictionary.
CommandJob withQueueSettings(QueueSettings queueSettings)

Set the queueSettings property: Queue settings for the job.
CommandJob withResources(JobResourceConfiguration resources)

Set the resources property: Compute Resource configuration for the job.
CommandJob withServices(Map<String,JobService> services)

Set the services property: List of JobEndpoints.
CommandJob withTags(Map<String,String> tags)

Set the tags property: Tag dictionary.

Methods inherited from JobBaseProperties

componentId computeId displayName experimentName fromJson identity isArchived jobType notificationSetting services status toJson validate withComponentId withComputeId withDescription withDisplayName withExperimentName withIdentity withIsArchived withNotificationSetting withProperties withServices withTags

Methods inherited from ResourceBase

description properties tags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CommandJob

public CommandJob()

Creates an instance of CommandJob class.

Method Details

codeId

public String codeId()

Get the codeId property: ARM resource ID of the code asset.

Returns:

the codeId value.

command

public String command()

Get the command property: [Required] The command to execute on startup of the job. eg. "python train.py".

Returns:

the command value.

distribution

public DistributionConfiguration distribution()

Get the distribution property: Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

Returns:

the distribution value.

environmentId

public String environmentId()

Get the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.

Returns:

the environmentId value.

environmentVariables

public Map<String,String> environmentVariables()

Get the environmentVariables property: Environment variables included in the job.

Returns:

the environmentVariables value.

fromJson

public static CommandJob fromJson(JsonReader jsonReader)

Reads an instance of CommandJob from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CommandJob if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

inputs

public Map<String,JobInput> inputs()

Get the inputs property: Mapping of input data bindings used in the job.

Returns:

the inputs value.

jobType

public JobType jobType()

Get the jobType property: [Required] Specifies the type of job.

Overrides:

CommandJob.jobType()

Returns:

the jobType value.

limits

public CommandJobLimits limits()

Get the limits property: Command Job limit.

Returns:

the limits value.

outputs

public Map<String,JobOutput> outputs()

Get the outputs property: Mapping of output data bindings used in the job.

Returns:

the outputs value.

parameters

public Object parameters()

Get the parameters property: Input parameters.

Returns:

the parameters value.

queueSettings

public QueueSettings queueSettings()

Get the queueSettings property: Queue settings for the job.

Returns:

the queueSettings value.

resources

public JobResourceConfiguration resources()

Get the resources property: Compute Resource configuration for the job.

Returns:

the resources value.

status

public JobStatus status()

Get the status property: Status of the job.

Overrides:

CommandJob.status()

Returns:

the status value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

CommandJob.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

CommandJob.validate()

withCodeId

public CommandJob withCodeId(String codeId)

Set the codeId property: ARM resource ID of the code asset.

Parameters:

codeId - the codeId value to set.

Returns:

the CommandJob object itself.

withCommand

public CommandJob withCommand(String command)

Set the command property: [Required] The command to execute on startup of the job. eg. "python train.py".

Parameters:

command - the command value to set.

Returns:

the CommandJob object itself.

withComponentId

public CommandJob withComponentId(String componentId)

Set the componentId property: ARM resource ID of the component resource.

Overrides:

CommandJob.withComponentId(String componentId)

Parameters:

componentId

withComputeId

public CommandJob withComputeId(String computeId)

Set the computeId property: ARM resource ID of the compute resource.

Overrides:

CommandJob.withComputeId(String computeId)

Parameters:

computeId

withDescription

public CommandJob withDescription(String description)

Set the description property: The asset description text.

Overrides:

CommandJob.withDescription(String description)

Parameters:

description

withDisplayName

public CommandJob withDisplayName(String displayName)

Set the displayName property: Display name of job.

Overrides:

CommandJob.withDisplayName(String displayName)

Parameters:

displayName

withDistribution

public CommandJob withDistribution(DistributionConfiguration distribution)

Set the distribution property: Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

Parameters:

distribution - the distribution value to set.

Returns:

the CommandJob object itself.

withEnvironmentId

public CommandJob withEnvironmentId(String environmentId)

Set the environmentId property: [Required] The ARM resource ID of the Environment specification for the job.

Parameters:

environmentId - the environmentId value to set.

Returns:

the CommandJob object itself.

withEnvironmentVariables

public CommandJob withEnvironmentVariables(Map<String,String> environmentVariables)

Set the environmentVariables property: Environment variables included in the job.

Parameters:

environmentVariables - the environmentVariables value to set.

Returns:

the CommandJob object itself.

withExperimentName

public CommandJob 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:

CommandJob.withExperimentName(String experimentName)

Parameters:

experimentName

withIdentity

public CommandJob 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:

CommandJob.withIdentity(IdentityConfiguration identity)

Parameters:

identity

withInputs

public CommandJob withInputs(Map<String,JobInput> inputs)

Set the inputs property: Mapping of input data bindings used in the job.

Parameters:

inputs - the inputs value to set.

Returns:

the CommandJob object itself.

withIsArchived

public CommandJob withIsArchived(Boolean isArchived)

Set the isArchived property: Is the asset archived?.

Overrides:

CommandJob.withIsArchived(Boolean isArchived)

Parameters:

isArchived

withLimits

public CommandJob withLimits(CommandJobLimits limits)

Set the limits property: Command Job limit.

Parameters:

limits - the limits value to set.

Returns:

the CommandJob object itself.

withNotificationSetting

public CommandJob withNotificationSetting(NotificationSetting notificationSetting)

Set the notificationSetting property: Notification setting for the job.

Overrides:

CommandJob.withNotificationSetting(NotificationSetting notificationSetting)

Parameters:

notificationSetting

withOutputs

public CommandJob withOutputs(Map<String,JobOutput> outputs)

Set the outputs property: Mapping of output data bindings used in the job.

Parameters:

outputs - the outputs value to set.

Returns:

the CommandJob object itself.

withProperties

public CommandJob withProperties(Map<String,String> properties)

Set the properties property: The asset property dictionary.

Overrides:

CommandJob.withProperties(Map<String,String> properties)

Parameters:

properties

withQueueSettings

public CommandJob withQueueSettings(QueueSettings queueSettings)

Set the queueSettings property: Queue settings for the job.

Parameters:

queueSettings - the queueSettings value to set.

Returns:

the CommandJob object itself.

withResources

public CommandJob withResources(JobResourceConfiguration resources)

Set the resources property: Compute Resource configuration for the job.

Parameters:

resources - the resources value to set.

Returns:

the CommandJob object itself.

withServices

public CommandJob 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:

CommandJob.withServices(Map<String,JobService> services)

Parameters:

services

withTags

public CommandJob withTags(Map<String,String> tags)

Set the tags property: Tag dictionary. Tags can be added, removed, and updated.

Overrides:

CommandJob.withTags(Map<String,String> tags)

Parameters:

tags

Applies to