/
IMonitorJobWaitForParms.ts
65 lines (62 loc) · 2.43 KB
/
IMonitorJobWaitForParms.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
60
61
62
63
64
65
/*
* 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.
*
*/
import { JOB_STATUS } from "../../types/JobStatus";
/**
* MonitorJobs "waitFor..." APIs parameters interface
* @export
* @interface IMonitorJobParms
*/
export interface IMonitorJobWaitForParms {
/**
* The z/OS JOBID for the job to monitor. No pre-validation of the JOBID (other than its presence) is performed.
* Any errors that you receive regarding invalid JOBID/JOBNAME will be surfaced by z/OSMF. Ensure that your
* JOBID specification adheres to the z/OS standards.
* @type {string}
* @memberof IJob
*/
jobid: string;
/**
* The z/OS JOBNAME for the job to monitor. No pre-validation of the JOBNAME (other than its presence) is performed.
* Any errors that you receive regarding invalid JOBID/JOBNAME will be surfaced by z/OSMF. Ensure that your
* JOBNAME specification adheres to the z/OS standards.
* @type {string}
* @memberof IJob
*/
jobname: string;
/**
* Watch delay is the polling delay in milliseconds. MonitorJobs will poll every "watchDelay" milliseconds for the
* status of the job that is being monitored. Use in conjunction with "attempts" to specify your maximum wait
* for the expected status.
* Default: MonitorJobs.DEFAULT_WATCHER_DELAY
* @type {number}
* @memberof IMonitorJobParms
*/
watchDelay?: number;
/**
* The job status (see z/OSMF Jobs REST APIs documentation - and the JOB_STATUS type for possible options) to
* wait for. Note that if the job's status is "further" along in the logical progression (see the JOB_STATUS
* documentation for full details) the "waitFor..." API methods will return immediately with the current status.
* Default: MonitorJobs.DEFAULT_STATUS.
* @type {JOB_STATUS}
* @memberof IMonitorJobParms
*/
status?: JOB_STATUS;
/**
* Maximum number of poll attempts. Use in conjunction with "watchDelay" to specify your maximum wait
* for the expected status.
* Default: MonitorJobs.DEFAULT_ATTEMPTS.
* @type {number}
* @memberof IMonitorJobParms
*/
attempts?: number;
// Index signature
[key: string]: any;
}