Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetJobs

Class to handle obtaining of z/OS batch job information

export

Hierarchy

  • GetJobs

Index

Methods

Methods

Static Private filterResultsByStatuses

Static getJcl

  • Get JCL from a job.

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • jobname: string

      the job name for the job for which you want to retrieve JCL

    • jobid: string

      the job ID for the job for which you want to retrieve JCL

    Returns Promise<any>

    • job document on resolve

Static getJclCommon

Static getJclForJob

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • job: IJob

      the job for which you would like to retrieve JCL

    Returns Promise<any>

    • promise that resolves to JCL content

Static getJob

Static getJobs

Static getJobsByOwner

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • owner: string

      owner for which to get jobs. Supports wildcard e.g. IBMU* returns jobs owned by all users whose ID beings with "IBMU"

    Returns Promise<IJob[]>

    • promise that resolves to an array of IJob objects (matching jobs)

Static getJobsByOwnerAndPrefix

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • owner: string

      owner for which to get jobs. Supports wildcard e.g. IBMU* returns jobs owned by all users whose ID beings with "IBMU"

    • prefix: string

      prefix for which to get jobs. Supports wildcard e.g. JOBNM* returns jobs with names starting with "JOBNM"

    Returns Promise<IJob[]>

    • promise that resolves to an array of IJob objects (matching jobs)

Static getJobsByParameters

Static getJobsByPrefix

  • Get jobs that match a job name preixl Defaults to jobs owned by the user ID in the session.

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • prefix: string

      job name prefix for which to list jobs. Supports wildcard e.g. JOBNM* returns jobs with names starting with "JOBNM"

    Returns Promise<IJob[]>

    • promise that resolves to an array of IJob objects (matching jobs)

Static getJobsCommon

Static getSpoolContent

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • jobFile: IJobFile

      the spool file for which you want to retrieve the content

    • Optional encoding: string

      the code page to use for EBCDIC translation

    Returns Promise<any>

    • promise that resolves to the spool content

Static getSpoolContentById

  • getSpoolContentById(session: AbstractSession, jobname: string, jobid: string, spoolId: number, encoding?: string): Promise<any>

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • jobname: string

      the job name for the job containing the spool content

    • jobid: string

      the job id for the job containing the spool content

    • spoolId: number

      id number assigned by zosmf that identifies the particular job spool file (DD)

    • Optional encoding: string

    Returns Promise<any>

    • promise that resolves to the spool content

Static getSpoolContentCommon

  • Get spool content from a job.

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • jobFile: IJobFile

      the spool file for which you want to retrieve the content

    • Optional encoding: string

      the code page to use for EBCDIC translation

    Returns Promise<any>

    • promise that resolves to the spool content

Static getSpoolFiles

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • jobname: string

      the job name for the job for which you want to get a list of spool files

    • jobid: string

      the job ID for the job for which you want to get a list of spool files

    Returns Promise<any>

    • promise that resolves to an array of IJobFile objects

Static getSpoolFilesCommon

Static getSpoolFilesForJob

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • job: IJob

      the job for which you would like to get a list of job spool files

    Returns Promise<any>

    • promise that resolves to an array of IJobFile objects

Static getStatus

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

    static
    memberof

    GetJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • jobname: string

      the job name for the job for which you want to get status

    • jobid: string

      the job ID for the job for which you want to get status

    Returns Promise<any>

    • promise that resolves to an IJob object representing the job

Static getStatusCommon

Static getStatusForJob

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

    static
    memberof

    GetJobs

    Parameters

    Returns Promise<any>

    • promise that resolves to an IJob object representing the job

Generated using TypeDoc