kibana/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.md
Lukas Olson a9273ca001
[data.search] Add search session methods to search service contract (#87966)
* [data.search] Add search session methods to search service contract

* Fix types

* Fix tests and switch to cancel

* Update docs

* Fix types/tests

* Fix tests

* Update status of SO before cancelling search requests

* Add API integration test

* Fix types

* Update expiration route to use config defaultExpiration

* Fix test

* Update docs

* New logic for extend

* Remove declare module

* Review feedback

* fix ts

* Remove test that is no longer valid

* Fix undefined bug

* Use DataRequestHandlerContext in maps

* ts

Co-authored-by: Liza K <liza.katz@elastic.co>
2021-02-03 08:08:54 -07:00

1.4 KiB

Home > kibana-plugin-plugins-data-server > ISearchStart

ISearchStart interface

Signature:

export interface ISearchStart<SearchStrategyRequest extends IKibanaSearchRequest = IEsSearchRequest, SearchStrategyResponse extends IKibanaSearchResponse = IEsSearchResponse> 

Properties

Property Type Description
aggs AggsStart
asScoped (request: KibanaRequest) => IScopedSearchClient
getSearchStrategy (name?: string) => ISearchStrategy<SearchStrategyRequest, SearchStrategyResponse> Get other registered search strategies by name (or, by default, the Elasticsearch strategy). For example, if a new strategy needs to use the already-registered ES search strategy, it can use this function to accomplish that.
searchSource {
asScoped: (request: KibanaRequest) => Promise<ISearchStartSearchSource>;
}