mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
* WIP [Regression] Histogram aggregation always shows an error message Closes: #62624 * make getInternalStartServices private * fix ts issues * remove createSearchSource from static contract * fix some jest test * move searh_source to static contract * fix types * fix function tests * fix jest / add createStartServicesGetter * fix comments: saved_object_management * maps: fix PR comments * maps: update types * fix heck_published_api_changes * move searchSource into runtime contract * cleanup * fix ts error * cleanup * remove extra dependencies * fix Discover * fix Discover JEST * fix PR comments Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> # Conflicts: # src/plugins/data/public/public.api.md
This commit is contained in:
parent
fa509f1fd8
commit
c4cff972d0
108 changed files with 1009 additions and 1295 deletions
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [createSearchSource](./kibana-plugin-plugins-data-public.createsearchsource.md)
|
||||
|
||||
## createSearchSource variable
|
||||
|
||||
Deserializes a json string and a set of referenced objects to a `SearchSource` instance. Use this method to re-create the search source serialized using `searchSource.serialize`<!-- -->.
|
||||
|
||||
This function is a factory function that returns the actual utility when calling it with the required service dependency (index patterns contract). A pre-wired version is also exposed in the start contract of the data plugin as part of the search service
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
createSearchSource: (indexPatterns: Pick<import("../../index_patterns/index_patterns").IndexPatternsService, "get" | "clearCache" | "getFieldsForTimePattern" | "getFieldsForWildcard" | "getIds" | "getTitles" | "getFields" | "getCache" | "getDefault" | "make">) => (searchSourceJson: string, references: SavedObjectReference[]) => Promise<SearchSource>
|
||||
```
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## ISearchSource type
|
||||
|
||||
\*
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
@ -21,7 +21,6 @@
|
|||
| [RequestTimeoutError](./kibana-plugin-plugins-data-public.requesttimeouterror.md) | Class used to signify that a request timed out. Useful for applications to conditionally handle this type of error differently than other errors. |
|
||||
| [SearchError](./kibana-plugin-plugins-data-public.searcherror.md) | |
|
||||
| [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) | |
|
||||
| [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) | |
|
||||
| [TimeHistory](./kibana-plugin-plugins-data-public.timehistory.md) | |
|
||||
|
||||
## Enumerations
|
||||
|
@ -101,7 +100,6 @@
|
|||
| [castEsToKbnFieldTypeName](./kibana-plugin-plugins-data-public.castestokbnfieldtypename.md) | Get the KbnFieldType name for an esType string |
|
||||
| [connectToQueryState](./kibana-plugin-plugins-data-public.connecttoquerystate.md) | Helper to setup two-way syncing of global data and a state container |
|
||||
| [createSavedQueryService](./kibana-plugin-plugins-data-public.createsavedqueryservice.md) | |
|
||||
| [createSearchSource](./kibana-plugin-plugins-data-public.createsearchsource.md) | Deserializes a json string and a set of referenced objects to a <code>SearchSource</code> instance. Use this method to re-create the search source serialized using <code>searchSource.serialize</code>.<!-- -->This function is a factory function that returns the actual utility when calling it with the required service dependency (index patterns contract). A pre-wired version is also exposed in the start contract of the data plugin as part of the search service |
|
||||
| [ES\_SEARCH\_STRATEGY](./kibana-plugin-plugins-data-public.es_search_strategy.md) | |
|
||||
| [esFilters](./kibana-plugin-plugins-data-public.esfilters.md) | |
|
||||
| [esKuery](./kibana-plugin-plugins-data-public.eskuery.md) | |
|
||||
|
@ -140,7 +138,7 @@
|
|||
| [IpRangeKey](./kibana-plugin-plugins-data-public.iprangekey.md) | |
|
||||
| [ISearch](./kibana-plugin-plugins-data-public.isearch.md) | |
|
||||
| [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) | |
|
||||
| [ISearchSource](./kibana-plugin-plugins-data-public.isearchsource.md) | |
|
||||
| [ISearchSource](./kibana-plugin-plugins-data-public.isearchsource.md) | \* |
|
||||
| [MatchAllFilter](./kibana-plugin-plugins-data-public.matchallfilter.md) | |
|
||||
| [ParsedInterval](./kibana-plugin-plugins-data-public.parsedinterval.md) | |
|
||||
| [PhraseFilter](./kibana-plugin-plugins-data-public.phrasefilter.md) | |
|
||||
|
|
|
@ -1,20 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [(constructor)](./kibana-plugin-plugins-data-public.searchsource._constructor_.md)
|
||||
|
||||
## SearchSource.(constructor)
|
||||
|
||||
Constructs a new instance of the `SearchSource` class
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
constructor(fields?: SearchSourceFields);
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| fields | <code>SearchSourceFields</code> | |
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [create](./kibana-plugin-plugins-data-public.searchsource.create.md)
|
||||
|
||||
## SearchSource.create() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
create(): SearchSource;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`SearchSource`
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [createChild](./kibana-plugin-plugins-data-public.searchsource.createchild.md)
|
||||
|
||||
## SearchSource.createChild() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
createChild(options?: {}): SearchSource;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>{}</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`SearchSource`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [createCopy](./kibana-plugin-plugins-data-public.searchsource.createcopy.md)
|
||||
|
||||
## SearchSource.createCopy() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
createCopy(): SearchSource;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`SearchSource`
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [destroy](./kibana-plugin-plugins-data-public.searchsource.destroy.md)
|
||||
|
||||
## SearchSource.destroy() method
|
||||
|
||||
Completely destroy the SearchSource. {<!-- -->undefined<!-- -->}
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
destroy(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [fetch](./kibana-plugin-plugins-data-public.searchsource.fetch.md)
|
||||
|
||||
## SearchSource.fetch() method
|
||||
|
||||
Fetch this source and reject the returned Promise on error
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
fetch(options?: FetchOptions): Promise<any>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>FetchOptions</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [getField](./kibana-plugin-plugins-data-public.searchsource.getfield.md)
|
||||
|
||||
## SearchSource.getField() method
|
||||
|
||||
Get fields from the fields
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getField<K extends keyof SearchSourceFields>(field: K, recurse?: boolean): SearchSourceFields[K];
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| field | <code>K</code> | |
|
||||
| recurse | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`SearchSourceFields[K]`
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [getFields](./kibana-plugin-plugins-data-public.searchsource.getfields.md)
|
||||
|
||||
## SearchSource.getFields() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getFields(): {
|
||||
type?: string | undefined;
|
||||
query?: import("../..").Query | undefined;
|
||||
filter?: Filter | Filter[] | (() => Filter | Filter[] | undefined) | undefined;
|
||||
sort?: Record<string, import("./types").SortDirection | import("./types").SortDirectionNumeric> | Record<string, import("./types").SortDirection | import("./types").SortDirectionNumeric>[] | undefined;
|
||||
highlight?: any;
|
||||
highlightAll?: boolean | undefined;
|
||||
aggs?: any;
|
||||
from?: number | undefined;
|
||||
size?: number | undefined;
|
||||
source?: string | boolean | string[] | undefined;
|
||||
version?: boolean | undefined;
|
||||
fields?: string | boolean | string[] | undefined;
|
||||
index?: import("../..").IndexPattern | undefined;
|
||||
searchAfter?: import("./types").EsQuerySearchAfter | undefined;
|
||||
timeout?: string | undefined;
|
||||
terminate_after?: number | undefined;
|
||||
};
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`{
|
||||
type?: string | undefined;
|
||||
query?: import("../..").Query | undefined;
|
||||
filter?: Filter | Filter[] | (() => Filter | Filter[] | undefined) | undefined;
|
||||
sort?: Record<string, import("./types").SortDirection | import("./types").SortDirectionNumeric> | Record<string, import("./types").SortDirection | import("./types").SortDirectionNumeric>[] | undefined;
|
||||
highlight?: any;
|
||||
highlightAll?: boolean | undefined;
|
||||
aggs?: any;
|
||||
from?: number | undefined;
|
||||
size?: number | undefined;
|
||||
source?: string | boolean | string[] | undefined;
|
||||
version?: boolean | undefined;
|
||||
fields?: string | boolean | string[] | undefined;
|
||||
index?: import("../..").IndexPattern | undefined;
|
||||
searchAfter?: import("./types").EsQuerySearchAfter | undefined;
|
||||
timeout?: string | undefined;
|
||||
terminate_after?: number | undefined;
|
||||
}`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [getId](./kibana-plugin-plugins-data-public.searchsource.getid.md)
|
||||
|
||||
## SearchSource.getId() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getId(): string;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [getOwnField](./kibana-plugin-plugins-data-public.searchsource.getownfield.md)
|
||||
|
||||
## SearchSource.getOwnField() method
|
||||
|
||||
Get the field from our own fields, don't traverse up the chain
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getOwnField<K extends keyof SearchSourceFields>(field: K): SearchSourceFields[K];
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| field | <code>K</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`SearchSourceFields[K]`
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [getParent](./kibana-plugin-plugins-data-public.searchsource.getparent.md)
|
||||
|
||||
## SearchSource.getParent() method
|
||||
|
||||
Get the parent of this SearchSource {<!-- -->undefined\|searchSource<!-- -->}
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getParent(): SearchSource | undefined;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`SearchSource | undefined`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [getSearchRequestBody](./kibana-plugin-plugins-data-public.searchsource.getsearchrequestbody.md)
|
||||
|
||||
## SearchSource.getSearchRequestBody() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getSearchRequestBody(): Promise<any>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [history](./kibana-plugin-plugins-data-public.searchsource.history.md)
|
||||
|
||||
## SearchSource.history property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
history: SearchRequest[];
|
||||
```
|
|
@ -1,46 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md)
|
||||
|
||||
## SearchSource class
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class SearchSource
|
||||
```
|
||||
|
||||
## Constructors
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [(constructor)(fields)](./kibana-plugin-plugins-data-public.searchsource._constructor_.md) | | Constructs a new instance of the <code>SearchSource</code> class |
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [history](./kibana-plugin-plugins-data-public.searchsource.history.md) | | <code>SearchRequest[]</code> | |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [create()](./kibana-plugin-plugins-data-public.searchsource.create.md) | | |
|
||||
| [createChild(options)](./kibana-plugin-plugins-data-public.searchsource.createchild.md) | | |
|
||||
| [createCopy()](./kibana-plugin-plugins-data-public.searchsource.createcopy.md) | | |
|
||||
| [destroy()](./kibana-plugin-plugins-data-public.searchsource.destroy.md) | | Completely destroy the SearchSource. {<!-- -->undefined<!-- -->} |
|
||||
| [fetch(options)](./kibana-plugin-plugins-data-public.searchsource.fetch.md) | | Fetch this source and reject the returned Promise on error |
|
||||
| [getField(field, recurse)](./kibana-plugin-plugins-data-public.searchsource.getfield.md) | | Get fields from the fields |
|
||||
| [getFields()](./kibana-plugin-plugins-data-public.searchsource.getfields.md) | | |
|
||||
| [getId()](./kibana-plugin-plugins-data-public.searchsource.getid.md) | | |
|
||||
| [getOwnField(field)](./kibana-plugin-plugins-data-public.searchsource.getownfield.md) | | Get the field from our own fields, don't traverse up the chain |
|
||||
| [getParent()](./kibana-plugin-plugins-data-public.searchsource.getparent.md) | | Get the parent of this SearchSource {<!-- -->undefined\|searchSource<!-- -->} |
|
||||
| [getSearchRequestBody()](./kibana-plugin-plugins-data-public.searchsource.getsearchrequestbody.md) | | |
|
||||
| [onRequestStart(handler)](./kibana-plugin-plugins-data-public.searchsource.onrequeststart.md) | | Add a handler that will be notified whenever requests start |
|
||||
| [serialize()](./kibana-plugin-plugins-data-public.searchsource.serialize.md) | | Serializes the instance to a JSON string and a set of referenced objects. Use this method to get a representation of the search source which can be stored in a saved object.<!-- -->The references returned by this function can be mixed with other references in the same object, however make sure there are no name-collisions. The references will be named <code>kibanaSavedObjectMeta.searchSourceJSON.index</code> and <code>kibanaSavedObjectMeta.searchSourceJSON.filter[<number>].meta.index</code>.<!-- -->Using <code>createSearchSource</code>, the instance can be re-created. |
|
||||
| [setField(field, value)](./kibana-plugin-plugins-data-public.searchsource.setfield.md) | | |
|
||||
| [setFields(newFields)](./kibana-plugin-plugins-data-public.searchsource.setfields.md) | | |
|
||||
| [setParent(parent, options)](./kibana-plugin-plugins-data-public.searchsource.setparent.md) | | Set a searchSource that this source should inherit from |
|
||||
| [setPreferredSearchStrategyId(searchStrategyId)](./kibana-plugin-plugins-data-public.searchsource.setpreferredsearchstrategyid.md) | | \*\*\* PUBLIC API \*\*\* |
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [onRequestStart](./kibana-plugin-plugins-data-public.searchsource.onrequeststart.md)
|
||||
|
||||
## SearchSource.onRequestStart() method
|
||||
|
||||
Add a handler that will be notified whenever requests start
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
onRequestStart(handler: (searchSource: ISearchSource, options?: FetchOptions) => Promise<unknown>): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| handler | <code>(searchSource: ISearchSource, options?: FetchOptions) => Promise<unknown></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [serialize](./kibana-plugin-plugins-data-public.searchsource.serialize.md)
|
||||
|
||||
## SearchSource.serialize() method
|
||||
|
||||
Serializes the instance to a JSON string and a set of referenced objects. Use this method to get a representation of the search source which can be stored in a saved object.
|
||||
|
||||
The references returned by this function can be mixed with other references in the same object, however make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index` and `kibanaSavedObjectMeta.searchSourceJSON.filter[<number>].meta.index`<!-- -->.
|
||||
|
||||
Using `createSearchSource`<!-- -->, the instance can be re-created.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
serialize(): {
|
||||
searchSourceJSON: string;
|
||||
references: SavedObjectReference[];
|
||||
};
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`{
|
||||
searchSourceJSON: string;
|
||||
references: SavedObjectReference[];
|
||||
}`
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [setField](./kibana-plugin-plugins-data-public.searchsource.setfield.md)
|
||||
|
||||
## SearchSource.setField() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setField<K extends keyof SearchSourceFields>(field: K, value: SearchSourceFields[K]): this;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| field | <code>K</code> | |
|
||||
| value | <code>SearchSourceFields[K]</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [setFields](./kibana-plugin-plugins-data-public.searchsource.setfields.md)
|
||||
|
||||
## SearchSource.setFields() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setFields(newFields: SearchSourceFields): this;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| newFields | <code>SearchSourceFields</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [setParent](./kibana-plugin-plugins-data-public.searchsource.setparent.md)
|
||||
|
||||
## SearchSource.setParent() method
|
||||
|
||||
Set a searchSource that this source should inherit from
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setParent(parent?: ISearchSource, options?: SearchSourceOptions): this;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| parent | <code>ISearchSource</code> | |
|
||||
| options | <code>SearchSourceOptions</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`this`
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) > [setPreferredSearchStrategyId](./kibana-plugin-plugins-data-public.searchsource.setpreferredsearchstrategyid.md)
|
||||
|
||||
## SearchSource.setPreferredSearchStrategyId() method
|
||||
|
||||
\*\*\* PUBLIC API \*\*\*
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setPreferredSearchStrategyId(searchStrategyId: string): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| searchStrategyId | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue