Skip to content

Commit 36ce4d2

Browse files
lukasolsonLiza K
andcommitted
[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>
1 parent cec0428 commit 36ce4d2

48 files changed

Lines changed: 617 additions & 680 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.dataapirequesthandlercontext.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.dataapirequesthandlercontext.session.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.iscopedsessionservice.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.iscopedsessionservice.search.md

Lines changed: 0 additions & 11 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchSessionService](./kibana-plugin-plugins-data-server.isearchsessionservice.md) &gt; [asScopedProvider](./kibana-plugin-plugins-data-server.isearchsessionservice.asscopedprovider.md)
4+
5+
## ISearchSessionService.asScopedProvider property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
asScopedProvider: (core: CoreStart) => (request: KibanaRequest) => IScopedSearchSessionsClient<T>;
11+
```
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchSessionService](./kibana-plugin-plugins-data-server.isearchsessionservice.md)
4+
5+
## ISearchSessionService interface
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export interface ISearchSessionService<T = unknown>
11+
```
12+
13+
## Properties
14+
15+
| Property | Type | Description |
16+
| --- | --- | --- |
17+
| [asScopedProvider](./kibana-plugin-plugins-data-server.isearchsessionservice.asscopedprovider.md) | <code>(core: CoreStart) =&gt; (request: KibanaRequest) =&gt; IScopedSearchSessionsClient&lt;T&gt;</code> | |
18+

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.asscoped.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
<b>Signature:</b>
88

99
```typescript
10-
asScoped: (request: KibanaRequest) => ISearchClient;
10+
asScoped: (request: KibanaRequest) => IScopedSearchClient;
1111
```

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export interface ISearchStart<SearchStrategyRequest extends IKibanaSearchRequest
1515
| Property | Type | Description |
1616
| --- | --- | --- |
1717
| [aggs](./kibana-plugin-plugins-data-server.isearchstart.aggs.md) | <code>AggsStart</code> | |
18-
| [asScoped](./kibana-plugin-plugins-data-server.isearchstart.asscoped.md) | <code>(request: KibanaRequest) =&gt; ISearchClient</code> | |
18+
| [asScoped](./kibana-plugin-plugins-data-server.isearchstart.asscoped.md) | <code>(request: KibanaRequest) =&gt; IScopedSearchClient</code> | |
1919
| [getSearchStrategy](./kibana-plugin-plugins-data-server.isearchstart.getsearchstrategy.md) | <code>(name?: string) =&gt; ISearchStrategy&lt;SearchStrategyRequest, SearchStrategyResponse&gt;</code> | 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. |
2020
| [searchSource](./kibana-plugin-plugins-data-server.isearchstart.searchsource.md) | <code>{</code><br/><code> asScoped: (request: KibanaRequest) =&gt; Promise&lt;ISearchStartSearchSource&gt;;</code><br/><code> }</code> | |
2121

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isessionservice.asscopedprovider.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isessionservice.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)