Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDownloadAllSpoolContentParms

Interface for downloading all spool content with DownloadJobs API

export
interface

IDownloadAllSpoolContentParms

Hierarchy

  • IDownloadAllSpoolContentParms

Index

Properties

Optional binary

binary: boolean

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

memberof

IDownloadSpoolContentParms

Optional extension

extension: string

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

memberof

IDownloadAllSpoolContentParms

jobid

jobid: string

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

memberof

IDownloadAllSpoolContentParms

jobname

jobname: string

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

memberof

IDownloadAllSpoolContentParms

Optional omitJobidDirectory

omitJobidDirectory: boolean

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

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

memberof

IDownloadAllSpoolContentParms

Optional record

record: boolean

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

memberof

IDownloadSpoolContentParms

Generated using TypeDoc