Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeleteJobs

Class to handle deletion of job information

export

Hierarchy

  • DeleteJobs

Index

Accessors

Static Private log

  • get log(): Logger

Methods

Static deleteJob

  • deleteJob(session: AbstractSession, jobname: string, jobid: string): Promise<void>
  • 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<void>

    • promise that resolves when the API call is complete

Static deleteJobCommon

  • deleteJobCommon(session: AbstractSession, parms: IDeleteJobParms): Promise<void>
  • Cancel and purge a job Full version of the API with a parameter object

    static
    memberof

    DeleteJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • parms: IDeleteJobParms

      parm object (see IDeleteJobParms interface for details)

    Returns Promise<void>

    • promise that resolves when the API call is complete

Static deleteJobForJob

  • deleteJobForJob(session: AbstractSession, job: IJob, modifyVersion?: "1.0" | "2.0"): Promise<void>
  • 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<void>

    • promise that resolves when the API call is completel

Generated using TypeDoc