Class to handle deletion of job information

export

### Hierarchy

- CancelJobs

## Index

### Accessors

- log

### Methods

- cancelJob
- cancelJobCommon
- cancelJobForJob

## Accessors

### Static Private log

- get log(): Logger

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/CancelJobs.ts:99

  Getter for Zowe logger

  #### Returns Logger

## Methods

### Static cancelJob

- cancelJob(session: AbstractSession, jobname: string, jobid: string, version?: string): Promise<undefined | IJobFeedback>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/CancelJobs.ts:36

  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<undefined | IJobFeedback>

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

### Static cancelJobCommon

- cancelJobCommon(session: AbstractSession, parms: ICancelJobParms): Promise<undefined | IJobFeedback>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/CancelJobs.ts:65

  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<undefined | IJobFeedback>

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

### Static cancelJobForJob

- cancelJobForJob(session: AbstractSession, job: IJob, version?: "1.0" | "2.0"): Promise<undefined | IJobFeedback>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/CancelJobs.ts:51

  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: "1.0" | "2.0"

    version of cancel request

  #### Returns Promise<undefined | IJobFeedback>

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

Generated using TypeDoc