ArmMediaModelFactory.MediaJobOutput Method

Definition

Namespace:

Azure.ResourceManager.Media.Models

Assembly:

Azure.ResourceManager.Media.dll

Package:

Azure.ResourceManager.Media v1.3.0

Source:

ArmMediaModelFactory.cs

Initializes a new instance of MediaJobOutput.

public static Azure.ResourceManager.Media.Models.MediaJobOutput MediaJobOutput (string odataType = default, Azure.ResourceManager.Media.Models.MediaJobError error = default, Azure.ResourceManager.Media.Models.MediaTransformPreset presetOverride = default, Azure.ResourceManager.Media.Models.MediaJobState? state = default, int? progress = default, string label = default, DateTimeOffset? startOn = default, DateTimeOffset? endOn = default);

static member MediaJobOutput : string * Azure.ResourceManager.Media.Models.MediaJobError * Azure.ResourceManager.Media.Models.MediaTransformPreset * Nullable<Azure.ResourceManager.Media.Models.MediaJobState> * Nullable<int> * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> -> Azure.ResourceManager.Media.Models.MediaJobOutput

Public Shared Function MediaJobOutput (Optional odataType As String = Nothing, Optional error As MediaJobError = Nothing, Optional presetOverride As MediaTransformPreset = Nothing, Optional state As Nullable(Of MediaJobState) = Nothing, Optional progress As Nullable(Of Integer) = Nothing, Optional label As String = Nothing, Optional startOn As Nullable(Of DateTimeOffset) = Nothing, Optional endOn As Nullable(Of DateTimeOffset) = Nothing) As MediaJobOutput

Parameters

odataType

String

The discriminator for derived types.

error

MediaJobError

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

presetOverride

MediaTransformPreset

A preset used to override the preset in the corresponding transform output. Please note MediaTransformPreset is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AudioAnalyzerPreset, BuiltInStandardEncoderPreset, StandardEncoderPreset and VideoAnalyzerPreset.

state

Nullable<MediaJobState>

Describes the state of the JobOutput.

progress

Nullable<Int32>

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

String

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.

startOn

Nullable<DateTimeOffset>

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

endOn

Nullable<DateTimeOffset>

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

Returns

MediaJobOutput

A new MediaJobOutput instance for mocking.