Class to handle the searching of z/OS batch job spool output

export

### Hierarchy

- SearchJobs

## Index

### Methods

- searchJobs
- searchSpoolContentCommon

## Methods

### Static searchJobs

- searchJobs(session: AbstractSession, searchParms: ISearchJobsParms): Promise<string>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/SearchJobs.ts:36

  Search Jobs - Search the spool output of the specified job name for a string or regular expression

  static
  throws

    {ImperativeError} --search-string or --search-regx must be specified

  memberof

    searchJobs

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### searchParms: ISearchJobsParms

    The search parameters for the API call

  #### Returns Promise<string>

  - promise that resolves to spool output

### Static Private searchSpoolContentCommon

- searchSpoolContentCommon(session: AbstractSession, searchString: string, searchRegex: string, caseInsensitive: boolean, jobFile: IJobFile, startingLine: number): Promise<any>

- - Defined in @zowe/zos-jobs-for-zowe-sdk/src/SearchJobs.ts:131

  Search the spool of the specified file for the a search string or regular expression

  static
  memberof

    searchJobs

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### searchString: string

    The string to search for in the spool output

  - ##### searchRegex: string

    The regex to search for in the spool output

  - ##### caseInsensitive: boolean

    Specify if a search is case sensitive

  - ##### jobFile: IJobFile

    The job spool file to search

  - ##### startingLine: number

    The line to start the searching from

  #### Returns Promise<any>

  - promise that resolves to spool output and response headers

Generated using TypeDoc