zosmf-retrofit2/eu.ibagroup.r2z.zowe.client.sdk.zosjobs/MonitorJobs

MonitorJobs

class MonitorJobs(val connection: ZOSConnection, var httpClient: OkHttpClient = UnsafeOkHttpClient.unsafeOkHttpClient)

Constructors

MonitorJobs

fun MonitorJobs(connection: ZOSConnection, httpClient: OkHttpClient = UnsafeOkHttpClient.unsafeOkHttpClient)

Types

Companion

object Companion

Functions

isJobRunning

fun isJobRunning(params: MonitorJobWaitForParams): Boolean

Determines if a given job is in a running state or not.

waitForJobMessage

fun waitForJobMessage(job: Job, message: String): Boolean

Given a Job document (has jobname/jobid), waits for the given message from the job. This API will poll for the given message once every 3 seconds for at least 1000 times. If the polling interval/duration is NOT sufficient, use waitForMessageCommon method to adjust.

waitForJobOutputStatus

fun waitForJobOutputStatus(job: Job): Job

Given a Job document (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.

fun waitForJobOutputStatus(jobName: String, jobId: String): Job

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.

waitForJobStatus

fun waitForJobStatus(job: Job, statusType: Job.Status): Job

Given a Job document (has jobname/jobid), waits for the given status of the job. This API will poll for the given status once every 3 seconds for at least 1000 times. If the polling interval/duration is NOT sufficient, use waitForStatusCommon method to adjust.

fun waitForJobStatus(jobName: String, jobId: String, statusType: Job.Status): Job

Given the jobname/jobid, waits for the given status of the job. This API will poll for the given status once every 3 seconds for at least 1000 times. If the polling interval/duration is NOT sufficient, use waitForStatusCommon method to adjust.

waitForMessageCommon

fun waitForMessageCommon(params: MonitorJobWaitForParams, message: String): Boolean

Given jobname/jobid, checks for the desired message continuously (based on the interval and attempts specified).

waitForStatusCommon

fun waitForStatusCommon(params: MonitorJobWaitForParams): Job

Given jobname/jobid, checks for the desired "status" (default is "OUTPUT") continuously (based on the interval and attempts specified).

Properties

connection

val connection: ZOSConnection

httpClient

var httpClient: OkHttpClient