This interface defines options for downloading a single data set or USS file

### Hierarchy

- IGetOptions
  - IDownloadSingleOptions

## Index

### Properties

- attributes
- binary
- directory
- encoding
- extension
- file
- localEncoding
- overwrite
- pattern
- preserveOriginalLetterCase
- queryParams
- range
- record
- responseTimeout
- returnEtag
- stream
- task
- volume

## Properties

### Optional attributes

attributes: ZosFilesAttributes

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:72

The ZosFilesAttributes instance describe upload attributes for the files and directories

### Optional binary

binary: boolean

Inherited from IOptions.binary

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptions.ts:27

The indicator to view the data set or USS file in binary mode Has priority over record for datasets If binary and record are both specified, binary is used

### Optional directory

directory: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:37

The local directory to download all members from a pds

example

  "./path/to/dir"

### Optional encoding

encoding: string

Inherited from IOptions.encoding

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptions.ts:41

Code page encoding

### Optional extension

extension: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:31

The extension you want to use for the file

example

  .txt

example

  .c

### Optional file

file: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:24

The local file to download the data set to

example

  "./path/to/file.txt"

### Optional localEncoding

localEncoding: string

Inherited from IOptions.localEncoding

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptions.ts:46

The local file encoding to pass as a "Content-Type" header

### Optional overwrite

overwrite: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:58

Specifies whether local files should be overwritten when downloaded.

### Optional pattern

pattern: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:68

An optional pattern for restricting the response list

### Optional preserveOriginalLetterCase

preserveOriginalLetterCase: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:53

Indicates if the created directories and files use the original letter case, which is for data sets always uppercase. The default value is false for backward compability. If the option "directory" or "file" is provided, this option doesn't have any effect. This option has only effect on automatically generated directories and files.

### Optional queryParams

queryParams: string

Inherited from IGetOptions.queryParams

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/get/doc/IGetOptions.ts:32

Optional query parameters

memberof

  IGetOptions

### Optional range

range: string

Inherited from IGetOptions.range

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/get/doc/IGetOptions.ts:25

Range of records to return

memberof

  IGetOptions

### Optional record

record: boolean

Inherited from IOptions.record

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptions.ts:35

The indicator to view the data set in record mode Should not be specified for USS files If binary and record are both specified, binary is used

### Optional responseTimeout

responseTimeout: number

Inherited from IZosFilesOptions.responseTimeout

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IZosFilesOptions.ts:22

The maximum amount of time for the TSO servlet to wait for a response before returning an error

### Optional returnEtag

returnEtag: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:45

The indicator to force return of ETag. If set to 'true' it forces the response to include an "ETag" header, regardless of the size of the response data. If it is not present, the the default is to only send an Etag for data sets smaller than a system determined length, which is at least 8MB.

### Optional stream

stream: Writable

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/download/doc/IDownloadOptions.ts:63

Optional stream to write the file contents

### Optional task

task: ITaskWithStatus

Inherited from IOptions.task

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptions.ts:59

Task status object used by CLI handlers to create progress bars Optional

### Optional volume

volume: string

Inherited from IOptions.volume

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptions.ts:52

The volume on which the data set is stored

Generated using TypeDoc