-
Notifications
You must be signed in to change notification settings - Fork 255
/
PipelineJobUpdate.xml
281 lines (281 loc) · 18.3 KB
/
PipelineJobUpdate.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
<Type Name="PipelineJobUpdate" FullName="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate">
<TypeSignature Language="C#" Value="public class PipelineJobUpdate : Microsoft.Azure.Management.VideoAnalyzer.Models.ProxyResource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PipelineJobUpdate extends Microsoft.Azure.Management.VideoAnalyzer.Models.ProxyResource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate" />
<TypeSignature Language="VB.NET" Value="Public Class PipelineJobUpdate
Inherits ProxyResource" />
<TypeSignature Language="F#" Value="type PipelineJobUpdate = class
 inherit ProxyResource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Management.VideoAnalyzer.Models.ProxyResource</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Microsoft.Rest.Serialization.JsonTransformation]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Rest.Serialization.JsonTransformation>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Pipeline job represents a unique instance of a batch topology, used for
offline processing of selected portions of archived content.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PipelineJobUpdate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the PipelineJobUpdate class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PipelineJobUpdate (string id = default, string name = default, string type = default, Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData systemData = default, string topologyName = default, string description = default, Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState state = default, DateTime expiration = default, Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError error = default, System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> parameters = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string name, string type, class Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData systemData, string topologyName, string description, valuetype Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState state, valuetype System.DateTime expiration, class Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError error, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.#ctor(System.String,System.String,System.String,Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData,System.String,System.String,Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState,System.DateTime,Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError,System.Collections.Generic.IList{Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional systemData As SystemData = Nothing, Optional topologyName As String = Nothing, Optional description As String = Nothing, Optional state As PipelineJobState = Nothing, Optional expiration As DateTime = Nothing, Optional error As PipelineJobError = Nothing, Optional parameters As IList(Of ParameterDefinition) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate : string * string * string * Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData * string * string * Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState * DateTime * Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError * System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> -> Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate" Usage="new Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate (id, name, type, systemData, topologyName, description, state, expiration, error, parameters)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="type" Type="System.String" />
<Parameter Name="systemData" Type="Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData" />
<Parameter Name="topologyName" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="state" Type="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState" />
<Parameter Name="expiration" Type="System.DateTime" />
<Parameter Name="error" Type="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError" />
<Parameter Name="parameters" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition>" />
</Parameters>
<Docs>
<param name="id">Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}</param>
<param name="name">The name of the resource</param>
<param name="type">The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts"</param>
<param name="systemData">Azure Resource Manager metadata containing
createdBy and modifiedBy information.</param>
<param name="topologyName">Reference to an existing pipeline
topology. When activated, this pipeline job will process content
according to the pipeline topology definition.</param>
<param name="description">An optional description for the
pipeline.</param>
<param name="state">Current state of the pipeline (read-only).
Possible values include: 'Processing', 'Canceled', 'Completed',
'Failed'</param>
<param name="expiration">The date-time by when this pipeline job
will be automatically deleted from your account.</param>
<param name="error">Details about the error, in case the pipeline
job fails.</param>
<param name="parameters">List of the instance level parameter
values for the user-defined topology parameters. A pipeline can
only define or override parameters values for parameters which have
been declared in the referenced topology. Topology parameters
without a default value must be defined. Topology parameters with a
default value can be optionally be overridden.</param>
<summary>
Initializes a new instance of the PipelineJobUpdate class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Description" />
<MemberSignature Language="VB.NET" Value="Public Property Description As String" />
<MemberSignature Language="F#" Value="member this.Description : string with get, set" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Description" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.description")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.description")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets an optional description for the pipeline.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError Error { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError Error" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Error" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Error As PipelineJobError" />
<MemberSignature Language="F#" Value="member this.Error : Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Error" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.error")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.error")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobError</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets details about the error, in case the pipeline job fails.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Expiration">
<MemberSignature Language="C#" Value="public DateTime Expiration { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime Expiration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Expiration" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Expiration As DateTime" />
<MemberSignature Language="F#" Value="member this.Expiration : DateTime" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Expiration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.expiration")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.expiration")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the date-time by when this pipeline job will be automatically
deleted from your account.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> Parameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> Parameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Parameters" />
<MemberSignature Language="VB.NET" Value="Public Property Parameters As IList(Of ParameterDefinition)" />
<MemberSignature Language="F#" Value="member this.Parameters : System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> with get, set" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.Parameters" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.parameters")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.parameters")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets list of the instance level parameter values for the
user-defined topology parameters. A pipeline can only define or
override parameters values for parameters which have been declared
in the referenced topology. Topology parameters without a default
value must be defined. Topology parameters with a default value can
be optionally be overridden.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As PipelineJobState" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.state")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.state")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobState</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets current state of the pipeline (read-only). Possible values
include: 'Processing', 'Canceled', 'Completed', 'Failed'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TopologyName">
<MemberSignature Language="C#" Value="public string TopologyName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TopologyName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.TopologyName" />
<MemberSignature Language="VB.NET" Value="Public Property TopologyName As String" />
<MemberSignature Language="F#" Value="member this.TopologyName : string with get, set" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.PipelineJobUpdate.TopologyName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.topologyName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.topologyName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets reference to an existing pipeline topology. When
activated, this pipeline job will process content according to the
pipeline topology definition.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>