-
Notifications
You must be signed in to change notification settings - Fork 85
/
IDownloadAllSpoolContentParms.ts
59 lines (53 loc) · 1.62 KB
/
IDownloadAllSpoolContentParms.ts
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
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
/**
* Interface for downloading all spool content with DownloadJobs API
* @export
* @interface IDownloadAllSpoolContentParms
*/
export interface IDownloadAllSpoolContentParms {
/**
* The directory to which you would like to download the output
* Default value: DownloadJobs.DEFAULT_JOBS_OUTPUT_DIR
* @type {string}
* @memberof IDownloadAllSpoolContentParms
*/
outDir?: string;
/**
* Name of the job for which you want to download all output
* e.g. MYJOBNM
* @type {string}
* @memberof IDownloadAllSpoolContentParms
*/
jobname: string;
/**
* JOB ID of the job for which you want to download all output
* e.g. JOB00001
* @type {string}
* @memberof IDownloadAllSpoolContentParms
*/
jobid: string;
/**
* If you specify false or do not specify this field, a directory with the jobid of the job as the name
* will automatically be appended to the outDir.
* If you specify true, no directory will be appended to your outDir.
* @type {boolean}
* @memberof IDownloadAllSpoolContentParms
*/
omitJobidDirectory?: boolean;
/**
* The extension to use for the files. Defaults to `.txt`
* e.g. .log
* @type {string}
* @memberof IDownloadAllSpoolContentParms
*/
extension?: string;
}