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

GetJobs

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

Class to handle obtaining of z/OS batch job information

Constructors

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

Functions

fun getJcl(jobName: String, jobId: String): String

Get JCL from a job.

fun getJclCommon(params: CommonJobParams): String

Get the JCL that was used to submit a job.

fun getJclForJob(job: Job): String

Get JCL from a job. Alternate version of the API that accepts a Job object returned by other APIs such as SubmitJobs.

fun getJob(jobId: String): Job

Get a single job object from an input job id.

fun getJobs(): List<Job>

Get jobs (defaults to the user ID of the session as owner).

fun getJobsByOwner(owner: String): List<Job>

Get jobs that are owned by a certain user or pattern of users.

getJobsByOwnerAndPrefix

fun getJobsByOwnerAndPrefix(owner: String, prefix: String): List<Job>

Get a list of jobs that match an owner and prefix.

getJobsByPrefix

fun getJobsByPrefix(prefix: String): List<Job>

Get jobs that match a job name by prefix. Defaults to job(s) owned by the user ID in the session.

fun getJobsCommon(params: GetJobParams): List<Job>

Get jobs filtered by owner and prefix.

getSpoolContent

fun getSpoolContent(file: SpoolFile): String

Get spool content from a job (keeping naming convention patter with this duplication function).

getSpoolContentById

fun getSpoolContentById(jobName: String, jobId: String, spoolId: Int): String

Get spool content from a job using the job name, job ID, and spool ID number from z/OSMF.

getSpoolContentCommon

fun getSpoolContentCommon(file: SpoolFile): String

Get spool content from a job.

fun getSpoolFiles(jobName: String, jobId: String): List<SpoolFile>

Get a list of all spool files for a job.

getSpoolFilesCommon

fun getSpoolFilesCommon(params: CommonJobParams): List<SpoolFile>

Get a list of all job spool files for a job.

getSpoolFilesForJob

fun getSpoolFilesForJob(job: Job): List<SpoolFile>

Get a list of all job spool files for a job. Alternate version of the API that accepts a Job object returned by other APIs such as SubmitJobs.

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

Get the status and other details (e.g. owner, return code) for a job.

getStatusCommon

fun getStatusCommon(params: CommonJobParams): Job

Get the status and other details (e.g. owner, return code) for a job.

getStatusForJob

fun getStatusForJob(job: Job): Job

Get the status and other details (e.g. owner, return code) for a job Alternate version of the API that accepts a Job object returned by other APIs such as SubmitJobs. Even though the parameter and return value are of the same type, the Job object returned will have the current status of the job.

fun getStatusValue(jobName: String, jobId: String): String

Get the status value only for a given job name and id.

getStatusValueForJob

fun getStatusValueForJob(job: Job): String

Get the status value for a given job object.

Properties

var connection: ZOSConnection

var httpClient: OkHttpClient

var response: Response<*>? = null