JobOutput interface

Package:

@azure/arm-mediaservices

Describes all the properties of a JobOutput.

Properties

endTime	The UTC date and time at which this Job Output finished processing. NOTE: This property will not be serialized. It can only be populated by the server.
error	If the JobOutput is in the Error state, it contains the details of the error. NOTE: This property will not be serialized. It can only be populated by the server.
label	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.
odataType	Polymorphic discriminator, which specifies the different types this object can be
presetOverride	A preset used to override the preset in the corresponding transform output.
progress	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. NOTE: This property will not be serialized. It can only be populated by the server.
startTime	The UTC date and time at which this Job Output began processing. NOTE: This property will not be serialized. It can only be populated by the server.
state	Describes the state of the JobOutput. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

endTime

The UTC date and time at which this Job Output finished processing. NOTE: This property will not be serialized. It can only be populated by the server.

endTime?: Date

Property Value

Date

error

If the JobOutput is in the Error state, it contains the details of the error. NOTE: This property will not be serialized. It can only be populated by the server.

error?: JobError

Property Value

JobError

label

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.

label?: string

Property Value

string

odataType

Polymorphic discriminator, which specifies the different types this object can be

odataType: "#Microsoft.Media.JobOutputAsset"

Property Value

"#Microsoft.Media.JobOutputAsset"

presetOverride

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

presetOverride?: PresetUnion

Property Value

PresetUnion

progress

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. NOTE: This property will not be serialized. It can only be populated by the server.

progress?: number

Property Value

number

startTime

The UTC date and time at which this Job Output began processing. NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: Date

Property Value

Date

state

Describes the state of the JobOutput. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string