Options
All
  • Public
  • Public/Protected
  • All
Menu

Class to handle deletion of job information

export

Hierarchy

  • DeleteJobs

Index

Accessors

Static Private log

Methods

Static deleteJob

  • Cancel and purge a job

    static
    memberof

    DeleteJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • jobname: string

      job name to be translated into parms object

    • jobid: string

      job id to be translated into parms object

    Returns Promise<undefined | IJobFeedback>

    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0

Static deleteJobCommon

Static deleteJobForJob

  • Cancel and purge a job Alternative version of the delete API accepting an IJob object returned from other APIs such as GetJobs and SubmitJobs

    static
    memberof

    DeleteJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • job: IJob

      the job that you want to delete

    • Optional modifyVersion: "1.0" | "2.0"

      version of the X-IBM-Job-Modify-Version header to use (see ZosmfHeaders)

    Returns Promise<undefined | IJobFeedback>

    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0

Generated using TypeDoc