JobOutput Class

Definition

Describes all the properties of a JobOutput.

public class JobOutput
type JobOutput = class
Public Class JobOutput
Inheritance
JobOutput
Derived

Constructors

JobOutput()

Initializes a new instance of the JobOutput class.

JobOutput(JobError, Preset, JobState, Int32, String, Nullable<DateTime>, Nullable<DateTime>)

Initializes a new instance of the JobOutput class.

Properties

EndTime

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

Error

Gets if the JobOutput is in the Error state, it contains the details of the error.

Label

Gets or sets 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.

PresetOverride

Gets or sets a preset used to override the preset in the corresponding transform output.

Progress

Gets 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.

StartTime

Gets the UTC date and time at which this Job Output began processing.

State

Gets describes the state of the JobOutput. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'

Applies to