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

### Hierarchy

- List

## Index

### Accessors

- log

### Methods

- allMembers
- dataSet
- dataSetsMatchingPattern
- fileList
- fs
- fsWithPath
- membersMatchingPattern

## Accessors

### Static Private log

- get log(): any

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

  #### 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:44

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

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

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

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

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

  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

### Static membersMatchingPattern

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

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

  List data set members that match a DSLEVEL pattern

  example

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### dataSetName: string

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

Generated using TypeDoc