-
Notifications
You must be signed in to change notification settings - Fork 235
/
azure.mgmt.media.models.JobOutput.yml
131 lines (101 loc) · 4.06 KB
/
azure.mgmt.media.models.JobOutput.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
### YamlMime:PythonClass
uid: azure.mgmt.media.models.JobOutput
name: JobOutput
fullName: azure.mgmt.media.models.JobOutput
module: azure.mgmt.media.models
inheritances:
- azure.mgmt.media._serialization.Model
summary: 'Describes all the properties of a JobOutput.
You probably want to use the sub-classes and not this class directly. Known sub-classes
are:
JobOutputAsset
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.'
constructor:
syntax: 'JobOutput(*, preset_override: _models.Preset | None = None, label: str
| None = None, **kwargs)'
keywordOnlyParameters:
- name: preset_override
description: 'A preset used to override the preset in the corresponding transform
output.'
types:
- <xref:azure.mgmt.media.models.Preset>
- name: label
description: '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.'
types:
- <xref:str>
variables:
- description: The discriminator for derived types. Required.
name: odata_type
types:
- <xref:str>
- description: If the JobOutput is in the Error state, it contains the details of
the error.
name: error
types:
- <xref:azure.mgmt.media.models.JobError>
- description: 'A preset used to override the preset in the corresponding transform
output.'
name: preset_override
types:
- <xref:azure.mgmt.media.models.Preset>
- description: 'Describes the state of the JobOutput. Known values are: "Canceled",
"Canceling",
"Error", "Finished", "Processing", "Queued", and "Scheduled".'
name: state
types:
- <xref:str>
- <xref:azure.mgmt.media.models.JobState>
- description: '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.'
name: progress
types:
- <xref:int>
- description: '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.'
name: label
types:
- <xref:str>
- description: The UTC date and time at which this Job Output began processing.
name: start_time
types:
- <xref:datetime.datetime>
- description: The UTC date and time at which this Job Output finished processing.
name: end_time
types:
- <xref:datetime.datetime>