Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CancelJobs

Class to handle deletion of job information

export

Hierarchy

  • CancelJobs

Index

Accessors

Static Private log

  • get log(): Logger

Methods

Static cancelJob

  • cancelJob(session: AbstractSession, jobname: string, jobid: string, version?: string): Promise<void>
  • Cancel and purge a job

    static
    memberof

    CancelJobs

    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

    • Optional version: string

    Returns Promise<void>

    • promise that resolves when the API call is complete

Static cancelJobCommon

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

    static
    memberof

    CancelJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • parms: ICancelJobParms

      parm object (see ICancelJobParms interface for details)

    Returns Promise<void>

    • promise that resolves when the API call is complete

Static cancelJobForJob

  • cancelJobForJob(session: AbstractSession, job: IJob, version?: string): Promise<void>
  • Cancel and purge a job Alternative version of the cancel API accepting an IJob object returned from other APIs such as GetJobs and SubmitJobs

    static
    memberof

    CancelJobs

    Parameters

    • session: AbstractSession

      z/OSMF connection info

    • job: IJob

      the job that you want to cancel

    • Optional version: string

      version of cancel request

    Returns Promise<void>

    • promise that resolves when the API call is complete

Generated using TypeDoc