MonitorJobs "waitFor..." APIs parameters interface

export
interface

  IMonitorJobParms

### Hierarchy

- IMonitorJobWaitForParms

### Indexable

[key: string]: any

MonitorJobs "waitFor..." APIs parameters interface

export
interface

  IMonitorJobParms

## Index

### Properties

- attempts
- jobid
- jobname
- status
- watchDelay

## Properties

### Optional attempts

attempts: number

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IMonitorJobWaitForParms.ts:61

Maximum number of poll attempts. Use in conjunction with "watchDelay" to specify your maximum wait for the expected status. Default: MonitorJobs.DEFAULT_ATTEMPTS.

memberof

  IMonitorJobParms

### jobid

jobid: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IMonitorJobWaitForParms.ts:27

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.

memberof

  IJob

### jobname

jobname: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IMonitorJobWaitForParms.ts:35

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.

memberof

  IJob

### Optional status

status: JOB_STATUS

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IMonitorJobWaitForParms.ts:53

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.

memberof

  IMonitorJobParms

### Optional watchDelay

watchDelay: number

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IMonitorJobWaitForParms.ts:44

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

memberof

  IMonitorJobParms

Generated using TypeDoc