Class Search

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

Hierarchy

Search

Index

Properties

timerExpired

Methods

Properties

Static Private timerExpired

timerExpired: boolean = false

Methods

Static dataSets

dataSets(session: AbstractSession, searchOptions: ISearchOptions): Promise<IZosFilesResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/search/Search.ts:49
Retrieve all data sets and members to search

throws

{ImperativeError} data set name must be set

throws

{Error} When the ZosmfRestClient throws an error

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- searchOptions: ISearchOptions
  
  contains the data set search options, including name, searchString, timeout, and maxConcurrentRequests
Returns Promise<IZosFilesResponse>

A response indicating the outcome of the API

Static Private searchLocal

searchLocal(session: AbstractSession, searchOptions: ISearchOptions, searchItems: ISearchItem[]): Promise<ISearchResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/search/Search.ts:277
Perform a deep search locally

throws

{ImperativeError} when a download fails, or timeout is exceeded.

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- searchOptions: ISearchOptions
  
  Search options
- searchItems: ISearchItem[]
Returns Promise<ISearchResponse>

A list of members that contain the searched for term, and locations where the term appears

Static Private searchOnMainframe

searchOnMainframe(session: AbstractSession, searchOptions: ISearchOptions, searchItems: ISearchItem[]): Promise<ISearchResponse>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/search/Search.ts:213
Perform a prelimiary search on z/OSMF

throws

{ImperativeError} when a download fails, or timeout is exceeded.

Parameters
- session: AbstractSession
  
  z/OS MF connection info
- searchOptions: ISearchOptions
  
  Search options
- searchItems: ISearchItem[]
  
  List of items for searching
Returns Promise<ISearchResponse>

A list of members that contain the searched for term

Generated using TypeDoc