Share via

JobOutput Class

  • Reference

Describes all the properties of a JobOutput.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: JobOutputAsset

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.media._serialization.Model
JobOutput

Constructor

JobOutput(*, preset_override: _models.Preset | None = None, label: str | None = None, **kwargs)

Keyword-Only Parameters

Name Description
preset_override
Preset

A preset used to override the preset in the corresponding transform output.
label
str

A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform.

Variables

Name Description
odata_type
str

The discriminator for derived types. Required.
error
JobError

If the JobOutput is in the Error state, it contains the details of the error.
preset_override
Preset

A preset used to override the preset in the corresponding transform output.
state
str or JobState

Describes the state of the JobOutput. Known values are: "Canceled", "Canceling", "Error", "Finished", "Processing", "Queued", and "Scheduled".
progress
int

If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property.
label
str

A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform.
start_time
datetime

The UTC date and time at which this Job Output began processing.
end_time
datetime

The UTC date and time at which this Job Output finished processing.