-
Notifications
You must be signed in to change notification settings - Fork 260
/
JobUpdateParameter.xml
331 lines (331 loc) · 20.4 KB
/
JobUpdateParameter.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
320
321
322
323
324
325
326
327
328
329
330
331
<Type Name="JobUpdateParameter" FullName="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter">
<TypeSignature Language="C#" Value="public class JobUpdateParameter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JobUpdateParameter extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter" />
<TypeSignature Language="VB.NET" Value="Public Class JobUpdateParameter" />
<TypeSignature Language="F#" Value="type JobUpdateParameter = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
<AssemblyVersion>15.3.0.0</AssemblyVersion>
<AssemblyVersion>15.4.0.0</AssemblyVersion>
<AssemblyVersion>16.0.0.0</AssemblyVersion>
<AssemblyVersion>16.1.0.0</AssemblyVersion>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The set of changes to be made to a Job.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobUpdateParameter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the JobUpdateParameter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobUpdateParameter (Microsoft.Azure.Batch.Protocol.Models.PoolInformation poolInfo, int? priority = default, int? maxParallelTasks = default, bool? allowTaskPreemption = default, Microsoft.Azure.Batch.Protocol.Models.JobConstraints constraints = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> metadata = default, Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete? onAllTasksComplete = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.Batch.Protocol.Models.PoolInformation poolInfo, valuetype System.Nullable`1<int32> priority, valuetype System.Nullable`1<int32> maxParallelTasks, valuetype System.Nullable`1<bool> allowTaskPreemption, class Microsoft.Azure.Batch.Protocol.Models.JobConstraints constraints, class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.MetadataItem> metadata, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete> onAllTasksComplete) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.#ctor(Microsoft.Azure.Batch.Protocol.Models.PoolInformation,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},Microsoft.Azure.Batch.Protocol.Models.JobConstraints,System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.MetadataItem},System.Nullable{Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (poolInfo As PoolInformation, Optional priority As Nullable(Of Integer) = Nothing, Optional maxParallelTasks As Nullable(Of Integer) = Nothing, Optional allowTaskPreemption As Nullable(Of Boolean) = Nothing, Optional constraints As JobConstraints = Nothing, Optional metadata As IList(Of MetadataItem) = Nothing, Optional onAllTasksComplete As Nullable(Of OnAllTasksComplete) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter : Microsoft.Azure.Batch.Protocol.Models.PoolInformation * Nullable<int> * Nullable<int> * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.JobConstraints * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> * Nullable<Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete> -> Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter" Usage="new Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter (poolInfo, priority, maxParallelTasks, allowTaskPreemption, constraints, metadata, onAllTasksComplete)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="poolInfo" Type="Microsoft.Azure.Batch.Protocol.Models.PoolInformation" />
<Parameter Name="priority" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxParallelTasks" Type="System.Nullable<System.Int32>" />
<Parameter Name="allowTaskPreemption" Type="System.Nullable<System.Boolean>" />
<Parameter Name="constraints" Type="Microsoft.Azure.Batch.Protocol.Models.JobConstraints" />
<Parameter Name="metadata" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem>" />
<Parameter Name="onAllTasksComplete" Type="System.Nullable<Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete>" />
</Parameters>
<Docs>
<param name="poolInfo">The Pool on which the Batch service runs the
Job's Tasks.</param>
<param name="priority">The priority of the Job.</param>
<param name="maxParallelTasks">The maximum number of tasks that can
be executed in parallel for the job.</param>
<param name="allowTaskPreemption">Whether Tasks in this job can be
preempted by other high priority jobs</param>
<param name="constraints">The execution constraints for the
Job.</param>
<param name="metadata">A list of name-value pairs associated with
the Job as metadata.</param>
<param name="onAllTasksComplete">The action the Batch service
should take when all Tasks in the Job are in the completed
state.</param>
<summary>
Initializes a new instance of the JobUpdateParameter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AllowTaskPreemption">
<MemberSignature Language="C#" Value="public bool? AllowTaskPreemption { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> AllowTaskPreemption" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.AllowTaskPreemption" />
<MemberSignature Language="VB.NET" Value="Public Property AllowTaskPreemption As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.AllowTaskPreemption : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.AllowTaskPreemption" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="allowTaskPreemption")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="allowTaskPreemption")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets whether Tasks in this job can be preempted by other
high priority jobs
</summary>
<value>To be added.</value>
<remarks>
If the value is set to True, other high priority jobs submitted to
the system will take precedence and will be able requeue tasks from
this job. You can update a job's allowTaskPreemption after it has
been created using the update job API.
</remarks>
</Docs>
</Member>
<Member MemberName="Constraints">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.JobConstraints Constraints { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.JobConstraints Constraints" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.Constraints" />
<MemberSignature Language="VB.NET" Value="Public Property Constraints As JobConstraints" />
<MemberSignature Language="F#" Value="member this.Constraints : Microsoft.Azure.Batch.Protocol.Models.JobConstraints with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.Constraints" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="constraints")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="constraints")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.JobConstraints</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the execution constraints for the Job.
</summary>
<value>To be added.</value>
<remarks>
If omitted, the constraints are cleared.
</remarks>
</Docs>
</Member>
<Member MemberName="MaxParallelTasks">
<MemberSignature Language="C#" Value="public int? MaxParallelTasks { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxParallelTasks" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.MaxParallelTasks" />
<MemberSignature Language="VB.NET" Value="Public Property MaxParallelTasks As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxParallelTasks : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.MaxParallelTasks" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxParallelTasks")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxParallelTasks")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum number of tasks that can be executed in
parallel for the job.
</summary>
<value>To be added.</value>
<remarks>
The value of maxParallelTasks must be -1 or greater than 0 if
specified. If not specified, the default value is -1, which means
there's no limit to the number of tasks that can be run at once.
You can update a job's maxParallelTasks after it has been created
using the update job API.
</remarks>
</Docs>
</Member>
<Member MemberName="Metadata">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> Metadata { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.MetadataItem> Metadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.Metadata" />
<MemberSignature Language="VB.NET" Value="Public Property Metadata As IList(Of MetadataItem)" />
<MemberSignature Language="F#" Value="member this.Metadata : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.Metadata" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="metadata")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="metadata")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of name-value pairs associated with the Job as
metadata.
</summary>
<value>To be added.</value>
<remarks>
If omitted, it takes the default value of an empty list; in effect,
any existing metadata is deleted.
</remarks>
</Docs>
</Member>
<Member MemberName="OnAllTasksComplete">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete? OnAllTasksComplete { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete> OnAllTasksComplete" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.OnAllTasksComplete" />
<MemberSignature Language="VB.NET" Value="Public Property OnAllTasksComplete As Nullable(Of OnAllTasksComplete)" />
<MemberSignature Language="F#" Value="member this.OnAllTasksComplete : Nullable<Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.OnAllTasksComplete" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="onAllTasksComplete")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="onAllTasksComplete")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Batch.Protocol.Models.OnAllTasksComplete></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the action the Batch service should take when all
Tasks in the Job are in the completed state.
</summary>
<value>To be added.</value>
<remarks>
If omitted, the completion behavior is set to noaction. If the
current value is terminatejob, this is an error because a Job's
completion behavior may not be changed from terminatejob to
noaction. You may not change the value from terminatejob to
noaction - that is, once you have engaged automatic Job
termination, you cannot turn it off again. If you try to do this,
the request fails and Batch returns status code 400 (Bad Request)
and an 'invalid property value' error response. If you do not
specify this element in a PUT request, it is equivalent to passing
noaction. This is an error if the current value is terminatejob.
Possible values include: 'noAction', 'terminateJob'
</remarks>
</Docs>
</Member>
<Member MemberName="PoolInfo">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.PoolInformation PoolInfo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.PoolInformation PoolInfo" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.PoolInfo" />
<MemberSignature Language="VB.NET" Value="Public Property PoolInfo As PoolInformation" />
<MemberSignature Language="F#" Value="member this.PoolInfo : Microsoft.Azure.Batch.Protocol.Models.PoolInformation with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.PoolInfo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="poolInfo")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="poolInfo")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.PoolInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Pool on which the Batch service runs the Job's
Tasks.
</summary>
<value>To be added.</value>
<remarks>
You may change the Pool for a Job only when the Job is disabled.
The Update Job call will fail if you include the poolInfo element
and the Job is not disabled. If you specify an
autoPoolSpecification in the poolInfo, only the keepAlive property
of the autoPoolSpecification can be updated, and then only if the
autoPoolSpecification has a poolLifetimeOption of Job (other job
properties can be updated as normal).
</remarks>
</Docs>
</Member>
<Member MemberName="Priority">
<MemberSignature Language="C#" Value="public int? Priority { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Priority" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.Priority" />
<MemberSignature Language="VB.NET" Value="Public Property Priority As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Priority : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter.Priority" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="priority")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="priority")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the priority of the Job.
</summary>
<value>To be added.</value>
<remarks>
Priority values can range from -1000 to 1000, with -1000 being the
lowest priority and 1000 being the highest priority. If omitted, it
is set to the default value 0.
</remarks>
</Docs>
</Member>
</Members>
</Type>