github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/unified_search.devdocs.json
Brian Seeders 6f4b81a3db Update api_docs
2022-05-24 15:50:44 +00:00

1139 lines
No EOL
39 KiB
JSON
Raw Blame History

{
"id": "unifiedSearch",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPicker",
"type": "Function",
"tags": [],
"label": "DataViewPicker",
"description": [],
"signature": [
"({ isMissingCurrent, currentDataViewId, onChangeDataView, onAddField, onDataViewCreated, trigger, selectableProps, showNewMenuTour, }: ",
"DataViewPickerProps",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPicker.$1",
"type": "Object",
"tags": [],
"label": "{\n isMissingCurrent,\n currentDataViewId,\n onChangeDataView,\n onAddField,\n onDataViewCreated,\n trigger,\n selectableProps,\n showNewMenuTour,\n}",
"description": [],
"signature": [
"DataViewPickerProps"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewsList",
"type": "Function",
"tags": [],
"label": "DataViewsList",
"description": [],
"signature": [
"({\n dataViewsList,\n onChangeDataView,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}: ",
"DataViewsListProps",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/dataview_picker/dataview_list.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewsList.$1",
"type": "Object",
"tags": [],
"label": "{\n dataViewsList,\n onChangeDataView,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}",
"description": [],
"signature": [
"DataViewsListProps"
],
"path": "src/plugins/unified_search/public/dataview_picker/dataview_list.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItem",
"type": "Function",
"tags": [],
"label": "FilterItem",
"description": [],
"signature": [
"(props: ",
"FilterItemProps",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItem.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"FilterItemProps"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterLabel",
"type": "Function",
"tags": [],
"label": "FilterLabel",
"description": [],
"signature": [
"(props: ",
"FilterLabelProps",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterLabel.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"FilterLabelProps"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInput",
"type": "Function",
"tags": [],
"label": "QueryStringInput",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.QueryStringInputProps",
"text": "QueryStringInputProps"
},
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/query_string_input/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInput.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.QueryStringInputProps",
"text": "QueryStringInputProps"
}
],
"path": "src/plugins/unified_search/public/query_string_input/index.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext",
"type": "Interface",
"tags": [],
"label": "ApplyGlobalFilterActionContext",
"description": [],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
"Filter",
"[]"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.timeFieldName",
"type": "string",
"tags": [],
"label": "timeFieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.embeddable",
"type": "Unknown",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.controlledBy",
"type": "string",
"tags": [],
"label": "controlledBy",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps",
"type": "Interface",
"tags": [],
"label": "QueryStringInputProps",
"description": [],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.indexPatterns",
"type": "Array",
"tags": [],
"label": "indexPatterns",
"description": [],
"signature": [
"(string | ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
")[]"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.disableAutoFocus",
"type": "CompoundType",
"tags": [],
"label": "disableAutoFocus",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.screenTitle",
"type": "string",
"tags": [],
"label": "screenTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.prepend",
"type": "Any",
"tags": [],
"label": "prepend",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.persistedLog",
"type": "Object",
"tags": [],
"label": "persistedLog",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.PersistedLog",
"text": "PersistedLog"
},
"<any> | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.bubbleSubmitEvent",
"type": "CompoundType",
"tags": [],
"label": "bubbleSubmitEvent",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.placeholder",
"type": "string",
"tags": [],
"label": "placeholder",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.disableLanguageSwitcher",
"type": "CompoundType",
"tags": [],
"label": "disableLanguageSwitcher",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.languageSwitcherPopoverAnchorPosition",
"type": "CompoundType",
"tags": [],
"label": "languageSwitcherPopoverAnchorPosition",
"description": [],
"signature": [
"\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onBlur",
"type": "Function",
"tags": [],
"label": "onBlur",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"((query: ",
"Query",
") => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChange.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"Query"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChangeQueryInputFocus",
"type": "Function",
"tags": [],
"label": "onChangeQueryInputFocus",
"description": [],
"signature": [
"((isFocused: boolean) => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChangeQueryInputFocus.$1",
"type": "boolean",
"tags": [],
"label": "isFocused",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onSubmit",
"type": "Function",
"tags": [],
"label": "onSubmit",
"description": [],
"signature": [
"((query: ",
"Query",
") => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onSubmit.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"Query"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.submitOnBlur",
"type": "CompoundType",
"tags": [],
"label": "submitOnBlur",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.size",
"type": "CompoundType",
"tags": [],
"label": "size",
"description": [],
"signature": [
"SuggestionsListSize",
" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.isInvalid",
"type": "CompoundType",
"tags": [],
"label": "isInvalid",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.isClearable",
"type": "CompoundType",
"tags": [],
"label": "isClearable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.iconType",
"type": "CompoundType",
"tags": [],
"label": "iconType",
"description": [],
"signature": [
"IconType",
" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.nonKqlMode",
"type": "CompoundType",
"tags": [],
"label": "nonKqlMode",
"description": [],
"signature": [
"\"text\" | \"lucene\" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.autoSubmit",
"type": "CompoundType",
"tags": [],
"label": "autoSubmit",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.storageKey",
"type": "string",
"tags": [],
"label": "storageKey",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.timeRangeForSuggestionsOverride",
"type": "CompoundType",
"tags": [],
"label": "timeRangeForSuggestionsOverride",
"description": [
"\nOverride whether autocomplete suggestions are restricted by time range."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ACTION_GLOBAL_APPLY_FILTER",
"type": "string",
"tags": [],
"label": "ACTION_GLOBAL_APPLY_FILTER",
"description": [],
"signature": [
"\"ACTION_GLOBAL_APPLY_FILTER\""
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IndexPatternSelectProps",
"type": "Type",
"tags": [],
"label": "IndexPatternSelectProps",
"description": [],
"signature": [
"Omit",
"<Omit<",
"EuiComboBoxProps",
"<any>, \"onChange\" | \"selectedOptions\" | \"options\" | \"isLoading\" | \"onSearchChange\">, \"placeholder\"> & Required<Pick<Omit<",
"EuiComboBoxProps",
"<any>, \"onChange\" | \"selectedOptions\" | \"options\" | \"isLoading\" | \"onSearchChange\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; onNoIndexPatterns?: (() => void) | undefined; }"
],
"path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.SearchBar",
"type": "CompoundType",
"tags": [],
"label": "SearchBar",
"description": [],
"signature": [
"React.ComponentClass<Pick<Omit<",
"SearchBarOwnProps",
" & ",
"SearchBarInjectedDeps",
", \"kibana\">, \"timeHistory\" | keyof ",
"SearchBarOwnProps",
" | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType<Omit<",
"SearchBarOwnProps",
" & ",
"SearchBarInjectedDeps",
", \"kibana\"> & ReactIntl.InjectedIntlProps>; }"
],
"path": "src/plugins/unified_search/public/search_bar/index.tsx",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.SearchBarProps",
"type": "Type",
"tags": [],
"label": "SearchBarProps",
"description": [],
"signature": [
"SearchBarOwnProps",
" & ",
"SearchBarInjectedDeps"
],
"path": "src/plugins/unified_search/public/search_bar/search_bar.tsx",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.StatefulSearchBarProps",
"type": "Type",
"tags": [],
"label": "StatefulSearchBarProps",
"description": [],
"signature": [
"SearchBarOwnProps",
" & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }"
],
"path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPublicPluginStart",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchPublicPluginStart",
"description": [
"\nUnified search plugin public Start contract"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPublicPluginStart.autocomplete",
"type": "Object",
"tags": [],
"label": "autocomplete",
"description": [
"\nautocomplete service\n{@link AutocompleteStart}"
],
"signature": [
"{ getQuerySuggestions: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFn",
"text": "QuerySuggestionGetFn"
},
"; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ",
"ValueSuggestionsGetFn",
"; }"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPublicPluginStart.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [
"\nprewired UI components\n{@link DataPublicPluginStartUi}"
],
"signature": [
"UnifiedSearchPublicPluginStartUi"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPluginSetup",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchPluginSetup",
"description": [],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPluginSetup.autocomplete",
"type": "Object",
"tags": [],
"label": "autocomplete",
"description": [],
"signature": [
"{ getQuerySuggestions: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFn",
"text": "QuerySuggestionGetFn"
},
"; getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin",
"type": "Class",
"tags": [],
"label": "UnifiedSearchServerPlugin",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPlugin",
"text": "UnifiedSearchServerPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPluginSetup",
"text": "UnifiedSearchServerPluginSetup"
},
", void, object, object>"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { timeout: moment.Duration; enabled: boolean; tiers: string[]; terminateAfter: moment.Duration; }>; }>; }>>"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"UnifiedSearchServerPluginStartDependencies",
", ",
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPluginStart",
"text": "UnifiedSearchServerPluginStart"
},
">, {}: ",
"UnifiedSearchServerPluginSetupDependencies",
") => { autocomplete: { getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }; }"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"UnifiedSearchServerPluginStartDependencies",
", ",
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPluginStart",
"text": "UnifiedSearchServerPluginStart"
},
">"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{}",
"description": [],
"signature": [
"UnifiedSearchServerPluginSetupDependencies"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
", {}: ",
"UnifiedSearchServerPluginStartDependencies",
") => {}"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "{}",
"description": [],
"signature": [
"UnifiedSearchServerPluginStartDependencies"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPluginStart",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchServerPluginStart",
"description": [],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"children": [],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPluginSetup",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchServerPluginSetup",
"description": [],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPluginSetup.autocomplete",
"type": "Object",
"tags": [],
"label": "autocomplete",
"description": [],
"signature": [
"{ getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink