-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.azure.batch.protocol.models.JobSpecification.yml
395 lines (395 loc) · 34.4 KB
/
com.microsoft.azure.batch.protocol.models.JobSpecification.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
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.JobSpecification"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification"
name: "JobSpecification"
nameWithType: "JobSpecification"
summary: "Specifies details of the Jobs to be created on a schedule."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **JobSpecification**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.JobSpecification()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.JobSpecification()"
name: "JobSpecification()"
nameWithType: "JobSpecification.JobSpecification()"
syntax: "public JobSpecification()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.allowTaskPreemption()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.allowTaskPreemption()"
name: "allowTaskPreemption()"
nameWithType: "JobSpecification.allowTaskPreemption()"
summary: "Get 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."
syntax: "public Boolean allowTaskPreemption()"
desc: "Get 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."
returns:
description: "the allowTaskPreemption value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.commonEnvironmentSettings()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.commonEnvironmentSettings()"
name: "commonEnvironmentSettings()"
nameWithType: "JobSpecification.commonEnvironmentSettings()"
summary: "Get individual Tasks can override an environment setting specified here by specifying the same setting name with a different value."
syntax: "public List<EnvironmentSetting> commonEnvironmentSettings()"
desc: "Get individual Tasks can override an environment setting specified here by specifying the same setting name with a different value."
returns:
description: "the commonEnvironmentSettings value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.EnvironmentSetting?alt=com.microsoft.azure.batch.protocol.models.EnvironmentSetting&text=EnvironmentSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.constraints()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.constraints()"
name: "constraints()"
nameWithType: "JobSpecification.constraints()"
summary: "Get the constraints value."
syntax: "public JobConstraints constraints()"
desc: "Get the constraints value."
returns:
description: "the constraints value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobConstraints?alt=com.microsoft.azure.batch.protocol.models.JobConstraints&text=JobConstraints\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.displayName()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.displayName()"
name: "displayName()"
nameWithType: "JobSpecification.displayName()"
summary: "Get the name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
syntax: "public String displayName()"
desc: "Get the name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
returns:
description: "the displayName value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.jobManagerTask()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.jobManagerTask()"
name: "jobManagerTask()"
nameWithType: "JobSpecification.jobManagerTask()"
summary: "Get if the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API."
syntax: "public JobManagerTask jobManagerTask()"
desc: "Get if the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job."
returns:
description: "the jobManagerTask value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobManagerTask?alt=com.microsoft.azure.batch.protocol.models.JobManagerTask&text=JobManagerTask\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.jobPreparationTask()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.jobPreparationTask()"
name: "jobPreparationTask()"
nameWithType: "JobSpecification.jobPreparationTask()"
summary: "Get if a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node."
syntax: "public JobPreparationTask jobPreparationTask()"
desc: "Get if a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node."
returns:
description: "the jobPreparationTask value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPreparationTask?alt=com.microsoft.azure.batch.protocol.models.JobPreparationTask&text=JobPreparationTask\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.jobReleaseTask()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.jobReleaseTask()"
name: "jobReleaseTask()"
nameWithType: "JobSpecification.jobReleaseTask()"
summary: "Get the primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task."
syntax: "public JobReleaseTask jobReleaseTask()"
desc: "Get the primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task."
returns:
description: "the jobReleaseTask value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobReleaseTask?alt=com.microsoft.azure.batch.protocol.models.JobReleaseTask&text=JobReleaseTask\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.maxParallelTasks()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.maxParallelTasks()"
name: "maxParallelTasks()"
nameWithType: "JobSpecification.maxParallelTasks()"
summary: "Get the value of max<wbr>Parallel<wbr>Tasks must be -1 or greater than 0 if specified."
syntax: "public Integer maxParallelTasks()"
desc: "Get 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."
returns:
description: "the maxParallelTasks value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.metadata()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.metadata()"
name: "metadata()"
nameWithType: "JobSpecification.metadata()"
summary: "Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
syntax: "public List<MetadataItem> metadata()"
desc: "Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
returns:
description: "the metadata value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.networkConfiguration()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.networkConfiguration()"
name: "networkConfiguration()"
nameWithType: "JobSpecification.networkConfiguration()"
summary: "Get the network<wbr>Configuration value."
syntax: "public JobNetworkConfiguration networkConfiguration()"
desc: "Get the networkConfiguration value."
returns:
description: "the networkConfiguration value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration?alt=com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration&text=JobNetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.onAllTasksComplete()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.onAllTasksComplete()"
name: "onAllTasksComplete()"
nameWithType: "JobSpecification.onAllTasksComplete()"
summary: "Get note that if a Job contains no Tasks, then all Tasks are considered complete."
syntax: "public OnAllTasksComplete onAllTasksComplete()"
desc: "Get note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'."
returns:
description: "the onAllTasksComplete value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OnAllTasksComplete?alt=com.microsoft.azure.batch.protocol.models.OnAllTasksComplete&text=OnAllTasksComplete\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.onTaskFailure()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.onTaskFailure()"
name: "onTaskFailure()"
nameWithType: "JobSpecification.onTaskFailure()"
summary: "Get the default is noaction."
syntax: "public OnTaskFailure onTaskFailure()"
desc: "Get the default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'."
returns:
description: "the onTaskFailure value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OnTaskFailure?alt=com.microsoft.azure.batch.protocol.models.OnTaskFailure&text=OnTaskFailure\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.poolInfo()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.poolInfo()"
name: "poolInfo()"
nameWithType: "JobSpecification.poolInfo()"
summary: "Get the pool<wbr>Info value."
syntax: "public PoolInformation poolInfo()"
desc: "Get the poolInfo value."
returns:
description: "the poolInfo value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolInformation?alt=com.microsoft.azure.batch.protocol.models.PoolInformation&text=PoolInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.priority()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.priority()"
name: "priority()"
nameWithType: "JobSpecification.priority()"
summary: "Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority."
syntax: "public Integer priority()"
desc: "Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API."
returns:
description: "the priority value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.usesTaskDependencies()"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.usesTaskDependencies()"
name: "usesTaskDependencies()"
nameWithType: "JobSpecification.usesTaskDependencies()"
summary: "Get the uses<wbr>Task<wbr>Dependencies value."
syntax: "public Boolean usesTaskDependencies()"
desc: "Get the usesTaskDependencies value."
returns:
description: "the usesTaskDependencies value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withAllowTaskPreemption(java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withAllowTaskPreemption(Boolean allowTaskPreemption)"
name: "withAllowTaskPreemption(Boolean allowTaskPreemption)"
nameWithType: "JobSpecification.withAllowTaskPreemption(Boolean allowTaskPreemption)"
summary: "Set 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."
parameters:
- description: "the allowTaskPreemption value to set"
name: "allowTaskPreemption"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public JobSpecification withAllowTaskPreemption(Boolean allowTaskPreemption)"
desc: "Set 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."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withCommonEnvironmentSettings(java.util.List<com.microsoft.azure.batch.protocol.models.EnvironmentSetting>)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withCommonEnvironmentSettings(List<EnvironmentSetting> commonEnvironmentSettings)"
name: "withCommonEnvironmentSettings(List<EnvironmentSetting> commonEnvironmentSettings)"
nameWithType: "JobSpecification.withCommonEnvironmentSettings(List<EnvironmentSetting> commonEnvironmentSettings)"
summary: "Set individual Tasks can override an environment setting specified here by specifying the same setting name with a different value."
parameters:
- description: "the commonEnvironmentSettings value to set"
name: "commonEnvironmentSettings"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.EnvironmentSetting?alt=com.microsoft.azure.batch.protocol.models.EnvironmentSetting&text=EnvironmentSetting\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public JobSpecification withCommonEnvironmentSettings(List<EnvironmentSetting> commonEnvironmentSettings)"
desc: "Set individual Tasks can override an environment setting specified here by specifying the same setting name with a different value."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withConstraints(com.microsoft.azure.batch.protocol.models.JobConstraints)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withConstraints(JobConstraints constraints)"
name: "withConstraints(JobConstraints constraints)"
nameWithType: "JobSpecification.withConstraints(JobConstraints constraints)"
summary: "Set the constraints value."
parameters:
- description: "the constraints value to set"
name: "constraints"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobConstraints?alt=com.microsoft.azure.batch.protocol.models.JobConstraints&text=JobConstraints\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withConstraints(JobConstraints constraints)"
desc: "Set the constraints value."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withDisplayName(java.lang.String)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withDisplayName(String displayName)"
name: "withDisplayName(String displayName)"
nameWithType: "JobSpecification.withDisplayName(String displayName)"
summary: "Set the name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
parameters:
- description: "the displayName value to set"
name: "displayName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public JobSpecification withDisplayName(String displayName)"
desc: "Set the name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withJobManagerTask(com.microsoft.azure.batch.protocol.models.JobManagerTask)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withJobManagerTask(JobManagerTask jobManagerTask)"
name: "withJobManagerTask(JobManagerTask jobManagerTask)"
nameWithType: "JobSpecification.withJobManagerTask(JobManagerTask jobManagerTask)"
summary: "Set if the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API."
parameters:
- description: "the jobManagerTask value to set"
name: "jobManagerTask"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobManagerTask?alt=com.microsoft.azure.batch.protocol.models.JobManagerTask&text=JobManagerTask\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withJobManagerTask(JobManagerTask jobManagerTask)"
desc: "Set if the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withJobPreparationTask(com.microsoft.azure.batch.protocol.models.JobPreparationTask)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withJobPreparationTask(JobPreparationTask jobPreparationTask)"
name: "withJobPreparationTask(JobPreparationTask jobPreparationTask)"
nameWithType: "JobSpecification.withJobPreparationTask(JobPreparationTask jobPreparationTask)"
summary: "Set if a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node."
parameters:
- description: "the jobPreparationTask value to set"
name: "jobPreparationTask"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPreparationTask?alt=com.microsoft.azure.batch.protocol.models.JobPreparationTask&text=JobPreparationTask\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withJobPreparationTask(JobPreparationTask jobPreparationTask)"
desc: "Set if a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withJobReleaseTask(com.microsoft.azure.batch.protocol.models.JobReleaseTask)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withJobReleaseTask(JobReleaseTask jobReleaseTask)"
name: "withJobReleaseTask(JobReleaseTask jobReleaseTask)"
nameWithType: "JobSpecification.withJobReleaseTask(JobReleaseTask jobReleaseTask)"
summary: "Set the primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task."
parameters:
- description: "the jobReleaseTask value to set"
name: "jobReleaseTask"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobReleaseTask?alt=com.microsoft.azure.batch.protocol.models.JobReleaseTask&text=JobReleaseTask\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withJobReleaseTask(JobReleaseTask jobReleaseTask)"
desc: "Set the primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withMaxParallelTasks(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withMaxParallelTasks(Integer maxParallelTasks)"
name: "withMaxParallelTasks(Integer maxParallelTasks)"
nameWithType: "JobSpecification.withMaxParallelTasks(Integer maxParallelTasks)"
summary: "Set the value of max<wbr>Parallel<wbr>Tasks must be -1 or greater than 0 if specified."
parameters:
- description: "the maxParallelTasks value to set"
name: "maxParallelTasks"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public JobSpecification withMaxParallelTasks(Integer maxParallelTasks)"
desc: "Set 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."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withMetadata(java.util.List<com.microsoft.azure.batch.protocol.models.MetadataItem>)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withMetadata(List<MetadataItem> metadata)"
name: "withMetadata(List<MetadataItem> metadata)"
nameWithType: "JobSpecification.withMetadata(List<MetadataItem> metadata)"
summary: "Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
parameters:
- description: "the metadata value to set"
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public JobSpecification withMetadata(List<MetadataItem> metadata)"
desc: "Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withNetworkConfiguration(com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
name: "withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
nameWithType: "JobSpecification.withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
summary: "Set the network<wbr>Configuration value."
parameters:
- description: "the networkConfiguration value to set"
name: "networkConfiguration"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration?alt=com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration&text=JobNetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
desc: "Set the networkConfiguration value."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withOnAllTasksComplete(com.microsoft.azure.batch.protocol.models.OnAllTasksComplete)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
name: "withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
nameWithType: "JobSpecification.withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
summary: "Set note that if a Job contains no Tasks, then all Tasks are considered complete."
parameters:
- description: "the onAllTasksComplete value to set"
name: "onAllTasksComplete"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OnAllTasksComplete?alt=com.microsoft.azure.batch.protocol.models.OnAllTasksComplete&text=OnAllTasksComplete\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
desc: "Set note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withOnTaskFailure(com.microsoft.azure.batch.protocol.models.OnTaskFailure)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withOnTaskFailure(OnTaskFailure onTaskFailure)"
name: "withOnTaskFailure(OnTaskFailure onTaskFailure)"
nameWithType: "JobSpecification.withOnTaskFailure(OnTaskFailure onTaskFailure)"
summary: "Set the default is noaction."
parameters:
- description: "the onTaskFailure value to set"
name: "onTaskFailure"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OnTaskFailure?alt=com.microsoft.azure.batch.protocol.models.OnTaskFailure&text=OnTaskFailure\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withOnTaskFailure(OnTaskFailure onTaskFailure)"
desc: "Set the default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withPoolInfo(com.microsoft.azure.batch.protocol.models.PoolInformation)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withPoolInfo(PoolInformation poolInfo)"
name: "withPoolInfo(PoolInformation poolInfo)"
nameWithType: "JobSpecification.withPoolInfo(PoolInformation poolInfo)"
summary: "Set the pool<wbr>Info value."
parameters:
- description: "the poolInfo value to set"
name: "poolInfo"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolInformation?alt=com.microsoft.azure.batch.protocol.models.PoolInformation&text=PoolInformation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JobSpecification withPoolInfo(PoolInformation poolInfo)"
desc: "Set the poolInfo value."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withPriority(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withPriority(Integer priority)"
name: "withPriority(Integer priority)"
nameWithType: "JobSpecification.withPriority(Integer priority)"
summary: "Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority."
parameters:
- description: "the priority value to set"
name: "priority"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public JobSpecification withPriority(Integer priority)"
desc: "Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.JobSpecification.withUsesTaskDependencies(java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.protocol.models.JobSpecification.withUsesTaskDependencies(Boolean usesTaskDependencies)"
name: "withUsesTaskDependencies(Boolean usesTaskDependencies)"
nameWithType: "JobSpecification.withUsesTaskDependencies(Boolean usesTaskDependencies)"
summary: "Set the uses<wbr>Task<wbr>Dependencies value."
parameters:
- description: "the usesTaskDependencies value to set"
name: "usesTaskDependencies"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public JobSpecification withUsesTaskDependencies(Boolean usesTaskDependencies)"
desc: "Set the usesTaskDependencies value."
returns:
description: "the JobSpecification object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Specifies details of the Jobs to be created on a schedule."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.1.1