-
Notifications
You must be signed in to change notification settings - Fork 85
/
IGetJobsParms.ts
56 lines (50 loc) · 1.14 KB
/
IGetJobsParms.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
/*
* 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 various GetJobs APIs
* @export
* @interface IGetJobsParms
*/
export interface IGetJobsParms {
/**
* Owner for which to obtain jobs for.
* Default: current user
* @type {string}
* @memberof IGetJobsParms
*/
owner?: string;
/**
* Prefix to filter when obtaining jobs.
* Default: *
* @type {string}
* @memberof IGetJobsParms
*/
prefix?: string;
/**
* Max jobs to return in a list
* Default: JobsConstants.DEFAULT_MAX_JOBS
* @type {number}
* @memberof IGetJobsParms
*/
maxJobs?: number;
/**
* job id for a job
* @type {string}
* @memberof IJob
*/
jobid?: string;
/**
* Return execution data about jobs
* @type {boolean}
* @memberof IGetJobsParms
*/
execData?: boolean;
}