This interface defines the options that can be sent to get a data set or USS file function

export
interface

  IGetOptions

### Hierarchy

- IOptions
  - IGetOptions
    - IDownloadSingleOptions

## Index

### Properties

- binary
- encoding
- localEncoding
- queryParams
- range
- record
- responseTimeout
- task
- volume

## Properties

### 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 encoding

encoding: string

Inherited from IOptions.encoding

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

Code page encoding

### 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 queryParams

queryParams: string

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

Optional query parameters

memberof

  IGetOptions

### Optional range

range: string

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