Upload | Zowe Node.js SDK

Hierarchy

Upload

Accessors

Static Private log

get log(): Logger

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:955
Get Log

Returns Logger

applicationLogger.

Methods

Static bufferToDataSet

bufferToDataSet(session: AbstractSession, fileBuffer: Buffer, dataSetName: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:153
Writing data buffer to a data set.

throws

{ImperativeError} When encounter error scenarios.

Parameters
- session: AbstractSession
  
  z/OS connection info
- fileBuffer: Buffer
  
  Data buffer to be written
- dataSetName: string
  
  Name of the data set to write to
- Default value options: IUploadOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the outcome

Static bufferToUSSFile

bufferToUSSFile(session: AbstractSession, ussname: string, buffer: Buffer, binary?: boolean, localEncoding?: string, etag?: string, returnEtag?: boolean, responseTimeout?: number): Promise<any>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:484
Upload content to USS file

deprecated

In favor of bufferToUssFile() which implements IUploadOptions

Parameters
- session: AbstractSession
  
  z/OS connection info
- ussname: string
  
  Name of the USS file to write to
- buffer: Buffer
  
  Data to be written
- Default value binary: boolean = false
  
  The indicator to upload the file in binary mode
- Optional localEncoding: string
- Optional etag: string
- Optional returnEtag: boolean
- Optional responseTimeout: number
Returns Promise<any>

Static bufferToUssFile

bufferToUssFile(session: AbstractSession, ussname: string, buffer: Buffer, options?: IUploadOptions): Promise<any>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:463
Upload content to USS file

Parameters
- session: AbstractSession
  
  z/OS connection info
- ussname: string
  
  Name of the USS file to write to
- buffer: Buffer
  
  Data to be written
- Default value options: IUploadOptions = {}
Returns Promise<any>

Static dirToPds

dirToPds(session: AbstractSession, inputDir: string, dataSetName: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:99
Upload content from a directory to a PDS

throws

{ImperativeError} When encounter error scenarios.

Parameters
- session: AbstractSession
  
  z/OS connection info
- inputDir: string
  
  path to a file
- dataSetName: string
  
  Name of the data set to write to
- Default value options: IUploadOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the out come

Static dirToUSSDir

dirToUSSDir(session: AbstractSession, inputDirectory: string, ussname: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:670
Upload local directory to USS directory

Parameters
- session: AbstractSession
  
  z/OS connection info
- inputDirectory: string
  
  the path of local directory
- ussname: string
  
  the name of uss folder
- Default value options: IUploadOptions = {}
Returns Promise<IZosFilesResponse>

Static dirToUSSDirRecursive

dirToUSSDirRecursive(session: AbstractSession, inputDirectory: string, ussname: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:789
Upload directory to USS recursively

Parameters
- session: AbstractSession
  
  z/OS connection info
- inputDirectory: string
  
  the path of local directory
- ussname: string
  
  the name of uss folder
- Default value options: IUploadOptions = {}
Returns Promise<IZosFilesResponse>

Static fileToDataset

fileToDataset(session: AbstractSession, inputFile: string, dataSetName: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:50
Upload content from file to data set

throws

{ImperativeError} When encounter error scenarios.

Parameters
- session: AbstractSession
  
  z/OS connection info
- inputFile: string
  
  path to a file
- dataSetName: string
  
  Name of the data set to write to
- Default value options: IUploadOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the out come

Static fileToUSSFile

fileToUSSFile(session: AbstractSession, inputFile: string, ussname: string, binary?: boolean, localEncoding?: string, task?: ITaskWithStatus, etag?: string, returnEtag?: boolean): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:645
deprecated

In favor of fileToUssFile() which implements IUploadOptions

Parameters
- session: AbstractSession
- inputFile: string
- ussname: string
- Default value binary: boolean = false
- Optional localEncoding: string
- Optional task: ITaskWithStatus
- Optional etag: string
- Optional returnEtag: boolean
Returns Promise<IZosFilesResponse>

Static fileToUssFile

fileToUssFile(session: AbstractSession, inputFile: string, ussname: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:581
Upload content from a local file to remote USS file

Parameters
- session: AbstractSession
  
  z/OS connection info
- inputFile: string
  
  Path to local file
- ussname: string
  
  Name of USS file to write to
- Default value options: IUploadOptions = {}
  
  Uploading options
Returns Promise<IZosFilesResponse>
- A response indicating the outcome

Static Private formatStringForDisplay

formatStringForDisplay(stringInput: string): string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:1000
helper function to prepare file names for display on progress bar

Parameters
- stringInput: string
  
  string input to be formated
Returns string

Static Private generateHeadersBasedOnOptions

generateHeadersBasedOnOptions(options: IUploadOptions, context?: string): IHeaderContent[]

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:1013
helper function to generate the headers based on the options used

Parameters
- options: IUploadOptions
  
  upload options
- Optional context: string
  
  context method from where you call this function (can be "buffer", "stream" or undefined)
Returns IHeaderContent[]

Static Private getDirs

getDirs(dirPath: string): IUploadDir[]

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:979
Returns an array of sub-directories objects, containing directory name, and full path specification

Parameters
- dirPath: string
  
  full-path for the directory to check
Returns IUploadDir[]

Static Private hasDirs

hasDirs(dirPath: string): boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:965
Checks if a given directory has sub-directories or not

Parameters
- dirPath: string
  
  full-path for the directory to check
Returns boolean

Static isDirectoryExist

isDirectoryExist(session: AbstractSession, ussname: string): Promise<boolean>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:763
Check if USS directory exists

Parameters
- session: AbstractSession
  
  z/OS connection info
- ussname: string
  
  the name of uss folder
Returns Promise<boolean>

Static pathToDataSet

pathToDataSet(session: AbstractSession, inputPath: string, dataSetName: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:290
Upload content from input path to dataSet or PDS members

throws

{ImperativeError} When encounter error scenarios.

example

pathToDataSet(session, "file.txt", "ps.name")

example

pathToDataset(session, "file.txt", "psd.name(member)")

example

pathToDataSet(session, "directory", "pds.name")

example

pathToDataset(session, "/full/path/file.txt", "ps.name")

Note: This method does everything needed to do from checking if path is file or directory and if data set is sequential file or PDS to determine what name to be used when upload content to data set. All you have to specify is a directory and a dsname.

Parameters
- session: AbstractSession
  
  z/OS connection info
- inputPath: string
  
  User input path to file or directory
- dataSetName: string
  
  Name of the data set to write to
- Default value options: IUploadOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the out come

Static streamToDataSet

streamToDataSet(session: AbstractSession, fileStream: Readable, dataSetName: string, options?: IUploadOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:217
Writing data buffer to a data set.

throws

{ImperativeError} When encounter error scenarios.

Parameters
- session: AbstractSession
  
  z/OS connection info
- fileStream: Readable
- dataSetName: string
  
  Name of the data set to write to
- Default value options: IUploadOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the out come

Static streamToUSSFile

streamToUSSFile(session: AbstractSession, ussname: string, uploadStream: Readable, binary?: boolean, localEncoding?: string, task?: ITaskWithStatus, etag?: string): Promise<{ apiResponse: any; commandResponse: any; success: boolean }>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:558
Upload content to USS file
deprecated
- In favor of streamToUssFile() which implements IUploadOptions
Parameters
- session: AbstractSession
  
  z/OS connection info
- ussname: string
  
  Name of the USS file to write to
- uploadStream: Readable
  
  Data to be written
- Default value binary: boolean = false
  
  The indicator to upload the file in binary mode
- Optional localEncoding: string
- Optional task: ITaskWithStatus
- Optional etag: string
Returns Promise<{ apiResponse: any; commandResponse: any; success: boolean }>

Static streamToUssFile

streamToUssFile(session: AbstractSession, ussname: string, uploadStream: Readable, options?: IUploadOptions): Promise<{ apiResponse: any; commandResponse: any; success: boolean }>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:510
Upload content to USS file

Parameters
- session: AbstractSession
  
  z/OS connection info
- ussname: string
  
  Name of the USS file to write to
- uploadStream: Readable
  
  Data to be written
- Default value options: IUploadOptions = {}
Returns Promise<{ apiResponse: any; commandResponse: any; success: boolean }>
- A response indicating the outcome

Static Private uploadFile

uploadFile(localPath: string, ussPath: string, session: AbstractSession, options: IUploadOptions): Promise<void>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:906
Parameters
- localPath: string
- ussPath: string
- session: AbstractSession
- options: IUploadOptions
Returns Promise<void>

Static Private uploadFileAndTagBasedOnAttributes

uploadFileAndTagBasedOnAttributes(localPath: string, ussPath: string, session: AbstractSession, attributes: ZosFilesAttributes): Promise<void>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/upload/Upload.ts:929
Parameters
- localPath: string
- ussPath: string
- session: AbstractSession
- attributes: ZosFilesAttributes
Returns Promise<void>

Hierarchy

Index

Accessors

Methods

Accessors

Static Private log

Returns Logger

Methods

Static bufferToDataSet

Parameters

session: AbstractSession

fileBuffer: Buffer

dataSetName: string

Default value options: IUploadOptions = {}

Returns Promise<IZosFilesResponse>

Static bufferToUSSFile

Parameters

session: AbstractSession

ussname: string

buffer: Buffer

Default value binary: boolean = false

Optional localEncoding: string

Optional etag: string

Optional returnEtag: boolean

Optional responseTimeout: number

Returns Promise<any>

Static bufferToUssFile

Parameters

session: AbstractSession

ussname: string

buffer: Buffer

Default value options: IUploadOptions = {}

Returns Promise<any>

Static dirToPds

Parameters

session: AbstractSession

inputDir: string

dataSetName: string

Default value options: IUploadOptions = {}

Returns Promise<IZosFilesResponse>

Static dirToUSSDir

Parameters

session: AbstractSession

inputDirectory: string

ussname: string

Default value options: IUploadOptions = {}

Returns Promise<IZosFilesResponse>

Static dirToUSSDirRecursive

Parameters

session: AbstractSession

inputDirectory: string

ussname: string

Default value options: IUploadOptions = {}

Returns Promise<IZosFilesResponse>

Static fileToDataset

Parameters

session: AbstractSession

inputFile: string

dataSetName: string

Default value options: IUploadOptions = {}

Returns Promise<IZosFilesResponse>

Static fileToUSSFile

Parameters

session: AbstractSession

inputFile: string

ussname: string

Default value binary: boolean = false

Optional localEncoding: string

Optional task: ITaskWithStatus

Optional etag: string

Optional returnEtag: boolean

Returns Promise<IZosFilesResponse>

Static fileToUssFile

Parameters

session: AbstractSession

inputFile: string

ussname: string

Default value options: IUploadOptions = {}

Returns Promise<IZosFilesResponse>

Static Private formatStringForDisplay