-
Notifications
You must be signed in to change notification settings - Fork 263
/
JobOutput.xml
319 lines (319 loc) · 18.5 KB
/
JobOutput.xml
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<Type Name="JobOutput" FullName="Microsoft.Azure.Management.Media.Models.JobOutput">
<TypeSignature Language="C#" Value="public class JobOutput" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JobOutput extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Media.Models.JobOutput" />
<TypeSignature Language="VB.NET" Value="Public Class JobOutput" />
<TypeSignature Language="F#" Value="type JobOutput = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>3.0.4.0</AssemblyVersion>
<AssemblyVersion>3.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Describes all the properties of a JobOutput.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobOutput ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.JobOutput.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the JobOutput class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobOutput (Microsoft.Azure.Management.Media.Models.JobError error = default, Microsoft.Azure.Management.Media.Models.Preset presetOverride = default, Microsoft.Azure.Management.Media.Models.JobState state = default, int progress = 0, string label = default, DateTime? startTime = default, DateTime? endTime = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.Management.Media.Models.JobError error, class Microsoft.Azure.Management.Media.Models.Preset presetOverride, valuetype Microsoft.Azure.Management.Media.Models.JobState state, int32 progress, string label, valuetype System.Nullable`1<valuetype System.DateTime> startTime, valuetype System.Nullable`1<valuetype System.DateTime> endTime) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.JobOutput.#ctor(Microsoft.Azure.Management.Media.Models.JobError,Microsoft.Azure.Management.Media.Models.Preset,Microsoft.Azure.Management.Media.Models.JobState,System.Int32,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional error As JobError = Nothing, Optional presetOverride As Preset = Nothing, Optional state As JobState = Nothing, Optional progress As Integer = 0, Optional label As String = Nothing, Optional startTime As Nullable(Of DateTime) = Nothing, Optional endTime As Nullable(Of DateTime) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Media.Models.JobOutput : Microsoft.Azure.Management.Media.Models.JobError * Microsoft.Azure.Management.Media.Models.Preset * Microsoft.Azure.Management.Media.Models.JobState * int * string * Nullable<DateTime> * Nullable<DateTime> -> Microsoft.Azure.Management.Media.Models.JobOutput" Usage="new Microsoft.Azure.Management.Media.Models.JobOutput (error, presetOverride, state, progress, label, startTime, endTime)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="error" Type="Microsoft.Azure.Management.Media.Models.JobError" />
<Parameter Name="presetOverride" Type="Microsoft.Azure.Management.Media.Models.Preset" />
<Parameter Name="state" Type="Microsoft.Azure.Management.Media.Models.JobState" />
<Parameter Name="progress" Type="System.Int32" />
<Parameter Name="label" Type="System.String" />
<Parameter Name="startTime" Type="System.Nullable<System.DateTime>" />
<Parameter Name="endTime" Type="System.Nullable<System.DateTime>" />
</Parameters>
<Docs>
<param name="error">If the JobOutput is in the Error state, it
contains the details of the error.</param>
<param name="presetOverride">A preset used to override the preset
in the corresponding transform output.</param>
<param name="state">Describes the state of the JobOutput. Possible
values include: 'Canceled', 'Canceling', 'Error', 'Finished',
'Processing', 'Queued', 'Scheduled'</param>
<param name="progress">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.</param>
<param name="label">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.</param>
<param name="startTime">The UTC date and time at which this Job
Output began processing.</param>
<param name="endTime">The UTC date and time at which this Job
Output finished processing.</param>
<summary>
Initializes a new instance of the JobOutput class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndTime">
<MemberSignature Language="C#" Value="public DateTime? EndTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> EndTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JobOutput.EndTime" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EndTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.EndTime : Nullable<DateTime>" Usage="Microsoft.Azure.Management.Media.Models.JobOutput.EndTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="endTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="endTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the UTC date and time at which this Job Output finished
processing.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Media.Models.JobError Error { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.Media.Models.JobError Error" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JobOutput.Error" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Error As JobError" />
<MemberSignature Language="F#" Value="member this.Error : Microsoft.Azure.Management.Media.Models.JobError" Usage="Microsoft.Azure.Management.Media.Models.JobOutput.Error" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="error")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="error")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.Media.Models.JobError</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets if the JobOutput is in the Error state, it contains the
details of the error.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Label" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JobOutput.Label" />
<MemberSignature Language="VB.NET" Value="Public Property Label As String" />
<MemberSignature Language="F#" Value="member this.Label : string with get, set" Usage="Microsoft.Azure.Management.Media.Models.JobOutput.Label" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="label")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="label")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
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.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PresetOverride">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Media.Models.Preset PresetOverride { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.Media.Models.Preset PresetOverride" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JobOutput.PresetOverride" />
<MemberSignature Language="VB.NET" Value="Public Property PresetOverride As Preset" />
<MemberSignature Language="F#" Value="member this.PresetOverride : Microsoft.Azure.Management.Media.Models.Preset with get, set" Usage="Microsoft.Azure.Management.Media.Models.JobOutput.PresetOverride" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="presetOverride")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="presetOverride")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.Media.Models.Preset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a preset used to override the preset in the
corresponding transform output.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Progress">
<MemberSignature Language="C#" Value="public int Progress { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Progress" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JobOutput.Progress" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Progress As Integer" />
<MemberSignature Language="F#" Value="member this.Progress : int" Usage="Microsoft.Azure.Management.Media.Models.JobOutput.Progress" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="progress")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="progress")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
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.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartTime">
<MemberSignature Language="C#" Value="public DateTime? StartTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> StartTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JobOutput.StartTime" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.StartTime : Nullable<DateTime>" Usage="Microsoft.Azure.Management.Media.Models.JobOutput.StartTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="startTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="startTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the UTC date and time at which this Job Output began
processing.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Media.Models.JobState State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Management.Media.Models.JobState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JobOutput.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As JobState" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.Azure.Management.Media.Models.JobState" Usage="Microsoft.Azure.Management.Media.Models.JobOutput.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="state")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="state")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.Media.Models.JobState</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets describes the state of the JobOutput. Possible values include:
'Canceled', 'Canceling', 'Error', 'Finished', 'Processing',
'Queued', 'Scheduled'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>