Class to handle downloading of job information

export

### Hierarchy

- DownloadJobs

## Index

### Properties

- DEFAULT_JOBS_OUTPUT_DIR
- DEFAULT_JOBS_OUTPUT_FILE_EXT

### Accessors

- log

### Methods

- downloadAllSpoolContentCommon
- downloadSpoolContent
- downloadSpoolContentCommon
- getSpoolDownloadFilePath

## Properties

### Static Readonly DEFAULT_JOBS_OUTPUT_DIR

DEFAULT_JOBS_OUTPUT_DIR: string = "./output"

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/DownloadJobs.ts:37

Default directory where output will be placed

static
memberof

  DownloadJobs

### Static Readonly DEFAULT_JOBS_OUTPUT_FILE_EXT

DEFAULT_JOBS_OUTPUT_FILE_EXT: string = ".txt"

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/DownloadJobs.ts:45

Default extension of downloaded folders

static
memberof

  DownloadJobs

## Accessors

### Static Private log

- get log(): Logger

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/DownloadJobs.ts:207

  Getter for Zowe logger

  #### Returns Logger

## Methods

### Static downloadAllSpoolContentCommon

- downloadAllSpoolContentCommon(session: AbstractSession, parms: IDownloadAllSpoolContentParms): Promise<void>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/DownloadJobs.ts:68

  Download all job output (spool content) for a job to a the local directory

  static
  memberof

    DownloadJobs

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### parms: IDownloadAllSpoolContentParms

    parameter object (see IDownloadAllSpoolContentParms for details)

  #### Returns Promise<void>

  - a promise which will resolve when the download is complete

### Static downloadSpoolContent

- downloadSpoolContent(session: AbstractSession, jobFile: IJobFile): Promise<void>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/DownloadJobs.ts:55

  Download spool content to a the default download directory

  static
  memberof

    DownloadJobs

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### jobFile: IJobFile

    spool file to download

  #### Returns Promise<void>

  - content downloaded

### Static downloadSpoolContentCommon

- downloadSpoolContentCommon(session: AbstractSession, parms: IDownloadSpoolContentParms): Promise<void>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/DownloadJobs.ts:103

  Download spool content to specified directory

  static
  memberof

    DownloadJobs

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### parms: IDownloadSpoolContentParms

    parm object (see IDownloadSpoolContentParms interface for details)

  #### Returns Promise<void>

  - promise that resolves when the file is downloaded

### Static getSpoolDownloadFilePath

- getSpoolDownloadFilePath(parms: IDownloadSpoolContentParms): string

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/DownloadJobs.ts:180

  Get the file where a specified spool file (IJobFile) would be downloaded to

  static
  memberof

    DownloadJobs

  #### Parameters

  - ##### parms: IDownloadSpoolContentParms

    parm object (see IDownloadSpoolContentParms interface for details)

  #### Returns string

  the file path that the spool file would be downloaded to

Generated using TypeDoc