Default number of poll attempts to check for the specified job status.
Default expected job status ("OUTPUT")
The default amount of time (in milliseconds) to wait until the next job status poll.
Obtain an instance of the app logger (Brightside).
Checks the status of the job for the expected status (OR that the job has progressed passed the expected status).
the session to initiate the z/OSMF getJobStatus request
the monitor jobs parameters containing the jobname, jobid, status, etc.
Constructs the default error message (to be thrown via ImperativeError) for the monitor jobs APIs
The parameters passed to the API
Additional error details string
"Polls" (sets timeouts and continuously checks) for the status of the job to match the desired status.
a Rest client session for z/OSMF
The monitor jobs parms (see interface for details)
Given an IJob (has jobname/jobid), waits for the status of the job to be "OUTPUT". This API will poll for the OUTPUT status once every 3 seconds indefinitely. If the polling interval/duration is NOT sufficient, use "waitForStatusCommon" to adjust.
See JSDoc for "waitForStatusCommon" for full details on polling and other logic.
a Rest client session for z/OSMF
the z/OS job to wait for (see z/OSMF Jobs APIs for details)
Given the jobname/jobid, waits for the status of the job to be "OUTPUT". This API will poll for the OUTPUT status once every 3 seconds indefinitely. If the polling interval/duration is NOT sufficient, use "waitForStatusCommon" to adjust.
See JSDoc for "waitForStatusCommon" for full details on polling and other logic.
a Rest client session for z/OSMF
the z/OS jobname of the job to wait for output status (see z/OSMF Jobs APIs for details)
the z/OS jobid of the job to wait for output status (see z/OSMF Jobs APIS for details)
Given jobname/jobid, checks for the desired "status" (default is "OUTPUT") continuously (based on the interval and attempts specified).
The "order" of natural job status is INPUT > ACTIVE > OUTPUT. If the requested status is earlier in the sequence than the current status of the job, then the method returns immediately (since the job will never enter the requested status) with the current status of the job.
a Rest client session for z/OSMF
monitor jobs parameters (see interface for details)
Generated using TypeDoc
APIs for monitoring the status of a job. Use these APIs to wait for a job to enter the specified status. All APIs in monitor jobs invoke z/OSMF jobs REST endpoints to obtain job status information.