-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.azure.batch.FileOperations.yml
579 lines (579 loc) · 55.4 KB
/
com.microsoft.azure.batch.FileOperations.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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.FileOperations"
fullName: "com.microsoft.azure.batch.FileOperations"
name: "FileOperations"
nameWithType: "FileOperations"
summary: "Performs file-related operations on an Azure Batch account."
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 **FileOperations**</br> implements <xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
methods:
- uid: "com.microsoft.azure.batch.FileOperations.customBehaviors()"
fullName: "com.microsoft.azure.batch.FileOperations.customBehaviors()"
name: "customBehaviors()"
nameWithType: "FileOperations.customBehaviors()"
summary: "Gets a collection of behaviors that modify or customize requests to the Batch service."
syntax: "public Collection<BatchClientBehavior> customBehaviors()"
desc: "Gets a collection of behaviors that modify or customize requests to the Batch service."
returns:
description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
name: "deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
nameWithType: "FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
summary: "Deletes the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public void deleteFileFromComputeNode(String poolId, String nodeId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
name: "deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
nameWithType: "FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
summary: "Deletes the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public void deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Deletes the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public void deleteFileFromComputeNode(String poolId, String nodeId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName)"
name: "deleteFileFromTask(String jobId, String taskId, String fileName)"
nameWithType: "FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName)"
summary: "Deletes the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public void deleteFileFromTask(String jobId, String taskId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
name: "deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
nameWithType: "FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
summary: "Deletes the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public void deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Deletes the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to delete."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If the file-path parameter represents a directory instead of a file, you can set the recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false or null, then the directory must be empty or deletion will fail."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public void deleteFileFromTask(String jobId, String taskId, String fileName, Boolean recursive, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deletes the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
name: "getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
summary: "Downloads the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromComputeNode(String poolId, String nodeId, String fileName, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
name: "getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
summary: "Downloads the specified file from the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
name: "getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
summary: "Downloads the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromTask(String jobId, String taskId, String fileName, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFileFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>,java.io.OutputStream)"
fullName: "com.microsoft.azure.batch.FileOperations.getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
name: "getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
nameWithType: "FileOperations.getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
summary: "Downloads the specified file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to download."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
- description: "A stream into which the file contents will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public void getFileFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors, OutputStream outputStream)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Downloads the specified file from the specified task's directory on its compute node."
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
name: "getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
nameWithType: "FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
summary: "Gets information about a file on a compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileProperties getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file on a compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Gets information about a file on a compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public FileProperties getFilePropertiesFromComputeNode(String poolId, String nodeId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file on a compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
name: "getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
nameWithType: "FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
summary: "Gets information about a file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileProperties getFilePropertiesFromTask(String jobId, String taskId, String fileName)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file from the specified task's directory on its compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Gets information about a file from the specified task's directory on its compute node."
parameters:
- description: "The ID of the job containing the task."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file to retrieve."
name: "fileName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public FileProperties getFilePropertiesFromTask(String jobId, String taskId, String fileName, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Gets information about a file from the specified task's directory on its compute node."
returns:
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.FileProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileProperties\"></xref> instance containing information about the file."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileProperties?alt=com.microsoft.azure.batch.protocol.models.FileProperties&text=FileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(String poolId, String nodeId)"
name: "listFilesFromComputeNode(String poolId, String nodeId)"
nameWithType: "FileOperations.listFilesFromComputeNode(String poolId, String nodeId)"
summary: "Lists files on the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PagedList<NodeFile> listFilesFromComputeNode(String poolId, String nodeId)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists files on the specified compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
name: "listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
nameWithType: "FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
summary: "Lists files on the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, recursively lists all files on the compute node. If false or null, lists only the files in the compute node root directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedList<NodeFile> listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists files on the specified compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Lists files on the specified compute node."
parameters:
- description: "The ID of the pool that contains the compute node."
name: "poolId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the compute node."
name: "nodeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, recursively lists all files on the compute node. If false or null, lists only the files in the compute node root directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PagedList<NodeFile> listFilesFromComputeNode(String poolId, String nodeId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists files on the specified compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(String jobId, String taskId)"
name: "listFilesFromTask(String jobId, String taskId)"
nameWithType: "FileOperations.listFilesFromTask(String jobId, String taskId)"
summary: "Lists the files in the specified task's directory on its compute node."
parameters:
- description: "The ID of the job."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PagedList<NodeFile> listFilesFromTask(String jobId, String taskId)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists the files in the specified task's directory on its compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
name: "listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
nameWithType: "FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
summary: "Lists the files in the specified task's directory on its compute node."
parameters:
- description: "The ID of the job."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, performs a recursive list of all files of the task. If false or null, returns only the files in the root task directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedList<NodeFile> listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists the files in the specified task's directory on its compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(java.lang.String,java.lang.String,java.lang.Boolean,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
name: "listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
nameWithType: "FileOperations.listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
summary: "Lists the files in the specified task's directory on its compute node."
parameters:
- description: "The ID of the job."
name: "jobId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ID of the task."
name: "taskId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "If true, performs a recursive list of all files of the task. If false or null, returns only the files in the root task directory."
name: "recursive"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
name: "detailLevel"
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
name: "additionalBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PagedList<NodeFile> listFilesFromTask(String jobId, String taskId, Boolean recursive, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
exceptions:
- description: "Exception thrown when an error response is received from the Batch service."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
- description: "Exception thrown when an error response is received from the Batch service."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Lists the files in the specified task's directory on its compute node."
returns:
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.NodeFile\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NodeFile\"></xref> objects."
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.NodeFile?alt=com.microsoft.azure.batch.protocol.models.NodeFile&text=NodeFile\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.FileOperations.withCustomBehaviors(java.util.Collection<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.FileOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
name: "withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
nameWithType: "FileOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
summary: "Sets a collection of behaviors that modify or customize requests to the Batch service."
parameters:
- description: "The collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
name: "behaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public IInheritedBehaviors withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
desc: "Sets a collection of behaviors that modify or customize requests to the Batch service."
returns:
description: "The current instance."
type: "<xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Performs file-related operations on an Azure Batch account."
implements:
- "<xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.azure.batch"
artifact: com.microsoft.azure:azure-batch:11.1.1