-
Notifications
You must be signed in to change notification settings - Fork 188
/
JobOutputAsset.yml
181 lines (176 loc) · 6.17 KB
/
JobOutputAsset.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
### YamlMime:TSType
name: JobOutputAsset
uid: '@azure/arm-mediaservices.JobOutputAsset'
package: '@azure/arm-mediaservices'
summary: Represents an Asset used as a JobOutput.
fullName: JobOutputAsset
remarks: ''
isDeprecated: false
type: interface
properties:
- name: assetName
uid: '@azure/arm-mediaservices.JobOutputAsset.assetName'
package: '@azure/arm-mediaservices'
summary: The name of the output Asset.
fullName: assetName
remarks: ''
isDeprecated: false
syntax:
content: 'assetName: string'
return:
description: ''
type: string
- name: odataType
uid: '@azure/arm-mediaservices.JobOutputAsset.odataType'
package: '@azure/arm-mediaservices'
summary: >-
Polymorphic discriminator, which specifies the different types this object
can be
fullName: odataType
remarks: ''
isDeprecated: false
syntax:
content: 'odataType: "#Microsoft.Media.JobOutputAsset"'
return:
description: ''
type: '"#<xref uid="Microsoft.Media.JobOutputAsset" />"'
inheritedProperties:
- name: endTime
uid: '@azure/arm-mediaservices.JobOutputAsset.endTime'
package: '@azure/arm-mediaservices'
summary: >-
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.
fullName: endTime
remarks: ''
isDeprecated: false
syntax:
content: 'endTime?: Date'
return:
description: ''
type: Date
inheritanceDescription: >-
<b>Inherited From</b>
[JobOutput.endTime](xref:@azure/arm-mediaservices.JobOutput.endTime)
- name: error
uid: '@azure/arm-mediaservices.JobOutputAsset.error'
package: '@azure/arm-mediaservices'
summary: >-
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.
fullName: error
remarks: ''
isDeprecated: false
syntax:
content: 'error?: JobError'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.JobError" />
inheritanceDescription: >-
<b>Inherited From</b>
[JobOutput.error](xref:@azure/arm-mediaservices.JobOutput.error)
- name: label
uid: '@azure/arm-mediaservices.JobOutputAsset.label'
package: '@azure/arm-mediaservices'
summary: >-
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.
fullName: label
remarks: ''
isDeprecated: false
syntax:
content: 'label?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[JobOutput.label](xref:@azure/arm-mediaservices.JobOutput.label)
- name: presetOverride
uid: '@azure/arm-mediaservices.JobOutputAsset.presetOverride'
package: '@azure/arm-mediaservices'
summary: >-
A preset used to override the preset in the corresponding transform
output.
fullName: presetOverride
remarks: ''
isDeprecated: false
syntax:
content: 'presetOverride?: PresetUnion'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.PresetUnion" />
inheritanceDescription: >-
<b>Inherited From</b>
[JobOutput.presetOverride](xref:@azure/arm-mediaservices.JobOutput.presetOverride)
- name: progress
uid: '@azure/arm-mediaservices.JobOutputAsset.progress'
package: '@azure/arm-mediaservices'
summary: >-
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.
fullName: progress
remarks: ''
isDeprecated: false
syntax:
content: 'progress?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[JobOutput.progress](xref:@azure/arm-mediaservices.JobOutput.progress)
- name: startTime
uid: '@azure/arm-mediaservices.JobOutputAsset.startTime'
package: '@azure/arm-mediaservices'
summary: >-
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.
fullName: startTime
remarks: ''
isDeprecated: false
syntax:
content: 'startTime?: Date'
return:
description: ''
type: Date
inheritanceDescription: >-
<b>Inherited From</b>
[JobOutput.startTime](xref:@azure/arm-mediaservices.JobOutput.startTime)
- name: state
uid: '@azure/arm-mediaservices.JobOutputAsset.state'
package: '@azure/arm-mediaservices'
summary: >-
Describes the state of the JobOutput.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: state
remarks: ''
isDeprecated: false
syntax:
content: 'state?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[JobOutput.state](xref:@azure/arm-mediaservices.JobOutput.state)
extends: <xref uid="@azure/arm-mediaservices.JobOutput" />