import RuleConfigurationSeveritySearchBuilder from 'opengate-js/src/searching/builder/RuleConfigurationSeveritySearchBuilder.js'RuleConfigurationSeveritySearchBuilder
Extends:
Defined a search over ruleConfigurationSeverity catalog
Example:
ogapi.ruleConfigurationSeveritySearchBuilder()
Constructor Summary
| Public Constructor | ||
| public |
constructor(parent: InternalOpenGateAPI) |
|
Member Summary
| Public Members | ||
| public |
customFilters: {} |
|
Method Summary
| Public Methods | ||
| public |
Build a instance of StaticSearch |
|
Inherited Summary
| From class SearchBuilder | ||
| public |
[route]: * |
|
| public |
addSortAscendingBy(filterField: string): SearchBuilder Add ascending param into the sort search object |
|
| public |
addSortBy(filterField: string, typeSort: string): SearchBuilder Add ascending/descending param into the sort search object |
|
| public |
addSortDescendingBy(filterField: string): SearchBuilder Add descending param into the sort search object |
|
| public |
Build a instance of Search |
|
| public |
filter(filter: FilterBuilder | object): SearchBuilder The search request will have this filter |
|
| public |
findAllFields(input: *): Promise Return a promise which it will contains an array with fields recommended with complete structure |
|
| public |
findFieldPath(field: *): Promise Return a promise which it will contains an string with the path of a field |
|
| public |
findFields(input: *): Promise Return a promise which it will contains an array with fields recommended with only identifier |
|
| public |
limit(size: number, start: number): SearchBuilder Set reponse pagination. |
|
| public |
removeSortBy(filterField: string): SearchBuilder Remove sort param from the search object |
|
| public |
withTimeout(ms: number): SearchBuilder The request will have a specific time out if it will be exceeded then the promise throw an exception |
|
Public Constructors
public constructor(parent: InternalOpenGateAPI) source
Constructor
Override:
SearchBuilder#constructorParams:
| Name | Type | Attribute | Description |
| parent | InternalOpenGateAPI |
|
Instance of our InternalOpenGateAPI |
Public Members
public customFilters: {} source
Public Methods
public build(): StaticSearch source
Build a instance of StaticSearch
Override:
SearchBuilder#buildThrow:
Throw error on url build |
Example:
ogapi.ruleConfigurationSeveritySearchBuilder().build()