List | Zowe Node.js SDK

This class holds helper functions that are used to list data sets and its members through the z/OS MF APIs

Hierarchy

List

Index

Properties

CONTROL_CHAR_REGEX

Accessors

Methods

Properties

Static Private CONTROL_CHAR_REGEX

CONTROL_CHAR_REGEX: RegExp = new RegExp(/[\x00-\x1f\x7f\x80-\x9f]/g)

Accessors

Static Private log

get log(): any

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/list/List.ts:462
Returns any

Methods

Static allMembers

allMembers(session: AbstractSession, dataSetName: string, options?: IListOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/list/List.ts:48
Retrieve all members from a PDS

throws

{ImperativeError} data set name must be set

throws

{Error} When the ZosmfRestClient throws an error

see

https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua700/IZUHPINFO_API_GetListDataSetMembers.htm

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- dataSetName: string
  
  contains the data set name
- Default value options: IListOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the outcome of the API

Static dataSet

dataSet(session: AbstractSession, dataSetName: string, options?: IListOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/list/List.ts:134
Retrieve all members from a data set name

throws

{ImperativeError} data set name must be set

throws

{Error} When the ZosmfRestClient throws an error

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- dataSetName: string
  
  contains the data set name
- Default value options: IListOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the outcome of the API

Static dataSetsMatchingPattern

dataSetsMatchingPattern(session: AbstractSession, patterns: string[], options?: IDsmListOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/list/List.ts:372
List data sets that match a DSLEVEL pattern
example
```
// List all "PS" and "PO" datasets that match the pattern "USER.**.DATASET"
await List.dataSetsMatchingPattern(session, "USER.**.DATASET");
```
Parameters
- session: AbstractSession
  
  z/OSMF connection info
- patterns: string[]
  
  Data set patterns to include
- Default value options: IDsmListOptions = {}
  
  Contains options for the z/OSMF request
Returns Promise<IZosFilesResponse>

List of z/OSMF list responses for each data set

Static fileList

fileList(session: AbstractSession, path: string, options?: IUSSListOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/list/List.ts:204
Retrieve a list of all files from a path name

throws

{ImperativeError} data set name must be set

throws

{Error} When the ZosmfRestClient throws an error

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- path: string
  
  contains the uss path name
- Default value options: IUSSListOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the outcome of the API

Static fs

fs(session: AbstractSession, options?: IFsOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/list/List.ts:277
Retrieve zfs files

throws

{ImperativeError} data set name must be set

throws

{Error} When the ZosmfRestClient throws an error

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- Default value options: IFsOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the outcome of the API

Static fsWithPath

fsWithPath(session: AbstractSession, options?: IFsOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/list/List.ts:325
Retrieve zfs files if indicated path

throws

{ImperativeError} data set name must be set

throws

{Error} When the ZosmfRestClient throws an error

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- Default value options: IFsOptions = {}
Returns Promise<IZosFilesResponse>

A response indicating the outcome of the API

Hierarchy

Index

Properties

Accessors

Methods

Properties

Static Private CONTROL_CHAR_REGEX

Accessors

Static Private log

Returns any

Methods

Static allMembers

Parameters

session: AbstractSession

dataSetName: string

Default value options: IListOptions = {}

Returns Promise<IZosFilesResponse>

Static dataSet

Parameters

session: AbstractSession

dataSetName: string

Default value options: IListOptions = {}

Returns Promise<IZosFilesResponse>

Static dataSetsMatchingPattern

Parameters

session: AbstractSession

patterns: string[]

Default value options: IDsmListOptions = {}

Returns Promise<IZosFilesResponse>

Static fileList

Parameters

session: AbstractSession

path: string

Default value options: IUSSListOptions = {}

Returns Promise<IZosFilesResponse>

Static fs

Parameters

session: AbstractSession

Default value options: IFsOptions = {}

Returns Promise<IZosFilesResponse>

Static fsWithPath

Parameters

session: AbstractSession

Default value options: IFsOptions = {}

Returns Promise<IZosFilesResponse>