This interface defines the options that can be sent into the upload data set function

### Hierarchy

- IOptions
  - IUploadOptions

## Index

### Properties

- ascii_files
- attributes
- binary
- binary_files
- encoding
- etag
- filesMap
- includeHidden
- localEncoding
- maxConcurrentRequests
- recall
- record
- recursive
- responseTimeout
- returnEtag
- task
- volume

## Properties

### Optional ascii_files

ascii_files: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/doc/IUploadOptions.ts:40

The list of files to be uploaded in ASCII mode

### Optional attributes

attributes: ZosFilesAttributes

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/doc/IUploadOptions.ts:50

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 binary_files

binary_files: string

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

The list of files to be uploaded in binary mode

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

etag: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/doc/IUploadOptions.ts:65

Etag value to pass to z/OSMF API request. It is used to check if the file was modified on target system before it is updated.

### Optional filesMap

filesMap: IUploadMap

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

The map of files and their upload mode to be used for binary_files and ascii_files

### Optional includeHidden

includeHidden: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/doc/IUploadOptions.ts:78

Specifies whether hidden files whose names begin with a dot should be uploaded.

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

maxConcurrentRequests: number

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

The maximum REST requests to perform at once Increasing this value results in faster uploads but increases resource consumption on z/OS and risks encountering an error caused by making too many requests at once. Default: 1

### Optional recall

recall: string

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

The migrated recall option

example

  "wait, nowait, error"

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

recursive: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/doc/IUploadOptions.ts:30

The indicator to upload the directories recursively

### 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/upload/doc/IUploadOptions.ts:73

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