Interface for downloading all spool content with DownloadJobs API

export
interface

  IDownloadAllSpoolContentParms

### Hierarchy

- IDownloadAllSpoolContentParms

## Index

### Properties

- binary
- encoding
- extension
- jobid
- jobname
- omitJobidDirectory
- outDir
- record
- recordRange
- waitForActive
- waitForOutput

## Properties

### Optional binary

binary: boolean

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:65

If you specify true for this field, the file will be downloaded in binary mode

memberof

  IDownloadSpoolContentParms

### Optional encoding

encoding: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:79

The codepage to use for translation from EBCDIC

memberof

  IDownloadSpoolContentParms

### Optional extension

extension: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:58

The extension to use for the files. Defaults to `.txt` e.g. .log

memberof

  IDownloadAllSpoolContentParms

### jobid

jobid: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:41

JOB ID of the job for which you want to download all output e.g. JOB00001

memberof

  IDownloadAllSpoolContentParms

### jobname

jobname: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:33

Name of the job for which you want to download all output e.g. MYJOBNM

memberof

  IDownloadAllSpoolContentParms

### Optional omitJobidDirectory

omitJobidDirectory: boolean

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:50

If you specify false or do not specify this field, a directory with the jobid of the job as the name will automatically be appended to the outDir. If you specify true, no directory will be appended to your outDir.

memberof

  IDownloadAllSpoolContentParms

### Optional outDir

outDir: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:25

The directory to which you would like to download the output Default value: DownloadJobs.DEFAULT_JOBS_OUTPUT_DIR

memberof

  IDownloadAllSpoolContentParms

### Optional record

record: boolean

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:72

If you specify true for this field, the file will be downloaded in record mode

memberof

  IDownloadSpoolContentParms

### Optional recordRange

recordRange: string

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:87

Optional record range e.g. 0-100

memberof

  IDownloadAllSpoolContentParms

### Optional waitForActive

waitForActive: boolean

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:92

Wait for the job to reach output status

### Optional waitForOutput

waitForOutput: boolean

- Defined in @zowe/zos-jobs-for-zowe-sdk/src/doc/input/IDownloadAllSpoolContentParms.ts:98

Wait for the job to reach output status

Generated using TypeDoc