CommandJobResponse

data class CommandJobResponse(val codeId: String? = null, val command: String, val compute: ComputeConfigurationResponse, val description: String? = null, val distribution: Any? = null, val environmentId: String? = null, val environmentVariables: Map<String, String>? = null, val experimentName: String? = null, val identity: Either<AmlTokenResponse, ManagedIdentityResponse>? = null, val inputDataBindings: Map<String, InputDataBindingResponse>? = null, val interactionEndpoints: Map<String, JobEndpointResponse>, val jobType: String, val output: JobOutputResponse, val outputDataBindings: Map<String, OutputDataBindingResponse>? = null, val parameters: Any, val priority: Int? = null, val properties: Map<String, String>? = null, val provisioningState: String, val status: String, val tags: Map<String, String>? = null, val timeout: String? = null)

Command job definition.

Constructors

Link copied to clipboard
constructor(codeId: String? = null, command: String, compute: ComputeConfigurationResponse, description: String? = null, distribution: Any? = null, environmentId: String? = null, environmentVariables: Map<String, String>? = null, experimentName: String? = null, identity: Either<AmlTokenResponse, ManagedIdentityResponse>? = null, inputDataBindings: Map<String, InputDataBindingResponse>? = null, interactionEndpoints: Map<String, JobEndpointResponse>, jobType: String, output: JobOutputResponse, outputDataBindings: Map<String, OutputDataBindingResponse>? = null, parameters: Any, priority: Int? = null, properties: Map<String, String>? = null, provisioningState: String, status: String, tags: Map<String, String>? = null, timeout: 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

Required Compute binding for the job.

Link copied to clipboard
val description: String? = null

The asset description text.

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
val environmentId: String? = null

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

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

Link copied to clipboard

Mapping of input data bindings used in 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

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

Link copied to clipboard

Location of the job output logs and artifacts.

Link copied to clipboard

Mapping of output data bindings used in the job.

Link copied to clipboard

Input parameters.

Link copied to clipboard
val priority: Int? = null

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

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

The asset property dictionary.

Link copied to clipboard

Specifies the job provisioning state.

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.

Link copied to clipboard
val timeout: String? = null

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.