Package com.azure.resourcemanager.mediaservices.models

Class JobOutput

java.lang.Object
com.azure.resourcemanager.mediaservices.models.JobOutput
Direct Known Subclasses:
JobOutputAsset
public class JobOutput extends Object
Describes all the properties of a JobOutput.

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobOutput()
    Creates an instance of JobOutput class.

  • Method Summary

    Modifier and Type
    Method
    Description
    OffsetDateTime
    endTime()
    Get the endTime property: The UTC date and time at which this Job Output finished processing.
    JobError
    error()
    Get the error property: If the JobOutput is in the Error state, it contains the details of the error.
    String
    label()
    Get the label property: A label that is assigned to a JobOutput in order to help uniquely identify it.
    Preset
    presetOverride()
    Get the presetOverride property: A preset used to override the preset in the corresponding transform output.
    Integer
    progress()
    Get the progress property: If the JobOutput is in a Processing state, this contains the Job completion percentage.
    OffsetDateTime
    startTime()
    Get the startTime property: The UTC date and time at which this Job Output began processing.
    JobState
    state()
    Get the state property: Describes the state of the JobOutput.
    void
    validate()
    Validates the instance.
    JobOutput
    withLabel(String label)
    Set the label property: A label that is assigned to a JobOutput in order to help uniquely identify it.
    JobOutput
    withPresetOverride(Preset presetOverride)
    Set the presetOverride property: A preset used to override the preset in the corresponding transform output.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • JobOutput

      public JobOutput()
      Creates an instance of JobOutput class.

  • Method Details

    • error

      public JobError error()
      Get the error property: If the JobOutput is in the Error state, it contains the details of the error.
      Returns:
      the error value.

    • presetOverride

      public Preset presetOverride()
      Get the presetOverride property: A preset used to override the preset in the corresponding transform output.
      Returns:
      the presetOverride value.

    • withPresetOverride

      public JobOutput withPresetOverride(Preset presetOverride)
      Set the presetOverride property: A preset used to override the preset in the corresponding transform output.
      Parameters:
      presetOverride - the presetOverride value to set.
      Returns:
      the JobOutput object itself.

    • state

      public JobState state()
      Get the state property: Describes the state of the JobOutput.
      Returns:
      the state value.

    • progress

      public Integer progress()
      Get the progress property: 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.
      Returns:
      the progress value.

    • label

      public String label()
      Get the label property: 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.
      Returns:
      the label value.

    • withLabel

      public JobOutput withLabel(String label)
      Set the label property: 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.
      Parameters:
      label - the label value to set.
      Returns:
      the JobOutput object itself.

    • startTime

      public OffsetDateTime startTime()
      Get the startTime property: The UTC date and time at which this Job Output began processing.
      Returns:
      the startTime value.

    • endTime

      public OffsetDateTime endTime()
      Get the endTime property: The UTC date and time at which this Job Output finished processing.
      Returns:
      the endTime value.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.