CommandJobResponse

data class CommandJobResponse(val codeId: String? = null, val command: String, val componentId: String? = null, val computeId: String? = null, val description: String? = null, val displayName: String? = null, val distribution: Any? = null, val environmentId: String, val environmentVariables: Map<String, String>? = null, val experimentName: String? = null, val identity: Any? = null, val inputs: Map<String, Any>? = null, val isArchived: Boolean? = null, val jobType: String, val limits: CommandJobLimitsResponse? = null, val notificationSetting: NotificationSettingResponse? = null, val outputs: Map<String, Any>? = null, val parameters: Any, val properties: Map<String, String>? = null, val queueSettings: QueueSettingsResponse? = null, val resources: JobResourceConfigurationResponse? = null, val services: Map<String, JobServiceResponse>? = null, val status: String, val tags: Map<String, String>? = null)

Command job definition.

Constructors

Link copied to clipboard
constructor(codeId: String? = null, command: String, componentId: String? = null, computeId: String? = null, description: String? = null, displayName: String? = null, distribution: Any? = null, environmentId: String, environmentVariables: Map<String, String>? = null, experimentName: String? = null, identity: Any? = null, inputs: Map<String, Any>? = null, isArchived: Boolean? = null, jobType: String, limits: CommandJobLimitsResponse? = null, notificationSetting: NotificationSettingResponse? = null, outputs: Map<String, Any>? = null, parameters: Any, properties: Map<String, String>? = null, queueSettings: QueueSettingsResponse? = null, resources: JobResourceConfigurationResponse? = null, services: Map<String, JobServiceResponse>? = null, status: String, tags: Map<String, String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val codeId: String? = null

ARM resource ID of the code asset.

Link copied to clipboard

Required The command to execute on startup of the job. eg. "python train.py"

Link copied to clipboard
val componentId: String? = null

ARM resource ID of the component resource.

Link copied to clipboard
val computeId: String? = null

ARM resource ID of the compute resource.

Link copied to clipboard
val description: String? = null

The asset description text.

Link copied to clipboard
val displayName: String? = null

Display name of job.

Link copied to clipboard
val distribution: Any? = null

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

Link copied to clipboard

Required The ARM resource ID of the Environment specification for the job.

Link copied to clipboard

Environment variables included in the job.

Link copied to clipboard
val experimentName: String? = null

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

Link copied to clipboard
val identity: Any? = null

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.

Link copied to clipboard
val inputs: Map<String, Any>? = null

Mapping of input data bindings used in the job.

Link copied to clipboard
val isArchived: Boolean? = null

Is the asset archived?

Link copied to clipboard

Enum to determine the type of job. Expected value is 'Command'.

Link copied to clipboard

Command Job limit.

Link copied to clipboard

Notification setting for the job

Link copied to clipboard
val outputs: Map<String, Any>? = null

Mapping of output data bindings used in the job.

Link copied to clipboard

Input parameters.

Link copied to clipboard
val properties: Map<String, String>? = null

The asset property dictionary.

Link copied to clipboard

Queue settings for the job

Link copied to clipboard

Compute Resource configuration for the job.

Link copied to clipboard

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

Link copied to clipboard

Status of the job.

Link copied to clipboard
val tags: Map<String, String>? = null

Tag dictionary. Tags can be added, removed, and updated.