Class: Azure::MediaServices::Mgmt::V2020_05_01::Models::JobOutput

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb

Overview

Describes all the properties of a JobOutput.

Direct Known Subclasses

JobOutputAsset

Constant Summary collapse

@@discriminatorMap = 
Hash.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ JobOutput

Returns a new instance of JobOutput.



18
19
20
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 18

def initialize
  @odatatype = "JobOutput"
end

Instance Attribute Details

#end_time ⇒ DateTime

finished processing.

Returns:

  • (DateTime) —

    The UTC date and time at which this Job Output



60
61
62
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 60

def end_time
  @end_time
end

#error ⇒ JobError

the details of the error.

Returns:

  • (JobError) —

    If the JobOutput is in the Error state, it contains



26
27
28
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 26

def error
  @error
end

#label ⇒ String

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:

  • (String) —

    A label that is assigned to a JobOutput in order to



52
53
54
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 52

def label
  @label
end

#odatatype ⇒ Object

Returns the value of attribute odatatype.



22
23
24
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 22

def odatatype
  @odatatype
end

#progress ⇒ Integer

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:

  • (Integer) —

    If the JobOutput is in a Processing state, this



37
38
39
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 37

def progress
  @progress
end

#start_time ⇒ DateTime

processing.

Returns:

  • (DateTime) —

    The UTC date and time at which this Job Output began



56
57
58
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 56

def start_time
  @start_time
end

#state ⇒ JobState

values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’

Returns:

  • (JobState) —

    Describes the state of the JobOutput. Possible



31
32
33
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 31

def state
  @state
end

Class Method Details

.mapper ⇒ Object

Mapper for JobOutput class as Ruby Hash. This will be used for serialization/deserialization.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/job_output.rb', line 67

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'JobOutput',
    type: {
      name: 'Composite',
      polymorphic_discriminator: '@odata.type',
      uber_parent: 'JobOutput',
      class_name: 'JobOutput',
      model_properties: {
        error: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'error',
          type: {
            name: 'Composite',
            class_name: 'JobError'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'state',
          type: {
            name: 'String'
          }
        },
        progress: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'progress',
          type: {
            name: 'Number'
          }
        },
        label: {
          client_side_validation: true,
          required: false,
          serialized_name: 'label',
          type: {
            name: 'String'
          }
        },
        start_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'startTime',
          type: {
            name: 'DateTime'
          }
        },
        end_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'endTime',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end