kibana/api_docs/discover.devdocs.json

1701 lines
No EOL
55 KiB
JSON

{
"id": "discover",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "discover",
"id": "def-public.loadSharingDataHelpers",
"type": "Function",
"tags": [],
"label": "loadSharingDataHelpers",
"description": [],
"signature": [
"() => Promise<typeof ",
"src/plugins/discover/public/utils/get_sharing_data",
">"
],
"path": "src/plugins/discover/public/utils/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "discover",
"id": "def-public.ISearchEmbeddable",
"type": "Interface",
"tags": [],
"label": "ISearchEmbeddable",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.ISearchEmbeddable",
"text": "ISearchEmbeddable"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SearchInput",
"text": "SearchInput"
},
", ",
"SearchOutput",
", any>"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.ISearchEmbeddable.getSavedSearch",
"type": "Function",
"tags": [],
"label": "getSavedSearch",
"description": [],
"signature": [
"() => ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput",
"type": "Interface",
"tags": [],
"label": "SearchInput",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.SearchInput",
"text": "SearchInput"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
}
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.timeslice",
"type": "Object",
"tags": [],
"label": "timeslice",
"description": [],
"signature": [
"[number, number] | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.hidePanelTitles",
"type": "CompoundType",
"tags": [],
"label": "hidePanelTitles",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"SortOrder",
"[] | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.rowHeight",
"type": "number",
"tags": [],
"label": "rowHeight",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.SearchInput.rowsPerPage",
"type": "number",
"tags": [],
"label": "rowsPerPage",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "discover",
"id": "def-public.SEARCH_EMBEDDABLE_TYPE",
"type": "string",
"tags": [],
"label": "SEARCH_EMBEDDABLE_TYPE",
"description": [],
"signature": [
"\"search\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup",
"type": "Interface",
"tags": [],
"label": "DiscoverSetup",
"description": [],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.docViews",
"type": "Object",
"tags": [],
"label": "docViews",
"description": [],
"signature": [
"{ addDocView(docViewRaw: ",
"DocViewInput",
" | ",
"DocViewInputFn",
"): void; }"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [
"\n`share` plugin URL locator for Discover app. Use it to generate links into\nDiscover application, for example, navigate:\n\n```ts\nawait plugins.discover.locator.navigate({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```\n\nGenerate a location:\n\n```ts\nconst location = await plugins.discover.locator.getLocation({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```"
],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocator",
"text": "DiscoverAppLocator"
},
" | undefined"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "discover",
"id": "def-public.DiscoverStart",
"type": "Interface",
"tags": [],
"label": "DiscoverStart",
"description": [],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [
"\n`share` plugin URL locator for Discover app. Use it to generate links into\nDiscover application, for example, navigate:\n\n```ts\nawait plugins.discover.locator.navigate({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```\n\nGenerate a location:\n\n```ts\nconst location = await plugins.discover.locator.getLocation({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```"
],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocator",
"text": "DiscoverAppLocator"
},
" | undefined"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.customize",
"type": "Function",
"tags": [],
"label": "customize",
"description": [],
"signature": [
"(profileName: string, callback: ",
"CustomizationCallback",
") => void"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.customize.$1",
"type": "string",
"tags": [],
"label": "profileName",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.customize.$2",
"type": "Function",
"tags": [],
"label": "callback",
"description": [],
"signature": [
"CustomizationCallback"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "discover",
"id": "def-server.DiscoverServerPluginLocatorService",
"type": "Interface",
"tags": [],
"label": "DiscoverServerPluginLocatorService",
"description": [],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-server.DiscoverServerPluginLocatorService.asScopedClient",
"type": "Function",
"tags": [],
"label": "asScopedClient",
"description": [],
"signature": [
"(req: ",
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "discover",
"scope": "server",
"docId": "kibDiscoverPluginApi",
"section": "def-server.LocatorServiceScopedClient",
"text": "LocatorServiceScopedClient"
},
">"
],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-server.DiscoverServerPluginLocatorService.asScopedClient.$1",
"type": "Object",
"tags": [],
"label": "req",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-server.DiscoverServerPluginStartDeps",
"type": "Interface",
"tags": [],
"label": "DiscoverServerPluginStartDeps",
"description": [],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-server.DiscoverServerPluginStartDeps.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
}
],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-server.LocatorServiceScopedClient",
"type": "Interface",
"tags": [],
"label": "LocatorServiceScopedClient",
"description": [],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-server.LocatorServiceScopedClient.columnsFromLocator",
"type": "Function",
"tags": [],
"label": "columnsFromLocator",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
") => Promise<string[] | undefined>"
],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "discover",
"id": "def-server.LocatorServiceScopedClient.columnsFromLocator.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
}
],
"path": "src/plugins/discover/server/locator/columns_from_locator.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "discover",
"id": "def-server.LocatorServiceScopedClient.searchSourceFromLocator",
"type": "Function",
"tags": [],
"label": "searchSourceFromLocator",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
") => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
">"
],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "discover",
"id": "def-server.LocatorServiceScopedClient.searchSourceFromLocator.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
}
],
"path": "src/plugins/discover/server/locator/searchsource_from_locator.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "discover",
"id": "def-server.LocatorServiceScopedClient.titleFromLocator",
"type": "Function",
"tags": [],
"label": "titleFromLocator",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
") => Promise<string>"
],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "discover",
"id": "def-server.LocatorServiceScopedClient.titleFromLocator.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
}
],
"path": "src/plugins/discover/server/locator/title_from_locator.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "discover",
"id": "def-server.DiscoverServerPluginStart",
"type": "Interface",
"tags": [],
"label": "DiscoverServerPluginStart",
"description": [],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-server.DiscoverServerPluginStart.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "server",
"docId": "kibDiscoverPluginApi",
"section": "def-server.DiscoverServerPluginLocatorService",
"text": "DiscoverServerPluginLocatorService"
}
],
"path": "src/plugins/discover/server/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition",
"type": "Class",
"tags": [],
"label": "DiscoverAppLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorDefinition",
"text": "DiscoverAppLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
">"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"DISCOVER_APP_LOCATOR\""
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"DiscoverAppLocatorDependencies"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
") => Promise<{ app: string; path: string; state: ",
"MainHistoryLocationState",
"; }>"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
}
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams",
"type": "Interface",
"tags": [],
"label": "DiscoverAppLocatorParams",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.savedSearchId",
"type": "string",
"tags": [],
"label": "savedSearchId",
"description": [
"\nOptionally set saved search ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.dataViewId",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [
"\nOptionally set index pattern / data view ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.indexPatternId",
"type": "string",
"tags": [
"deprecated"
],
"label": "indexPatternId",
"description": [
"\nDuplication of dataViewId"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "exploratoryView",
"path": "x-pack/plugins/exploratory_view/public/components/shared/exploratory_view/hooks/use_discover_link.tsx"
},
{
"plugin": "dataVisualizer",
"path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx"
},
{
"plugin": "dataVisualizer",
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx"
},
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx"
},
{
"plugin": "cloudSecurityPosture",
"path": "x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx"
},
{
"plugin": "discoverEnhanced",
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts"
},
{
"plugin": "discoverEnhanced",
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts"
},
{
"plugin": "osquery",
"path": "x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx"
},
{
"plugin": "osquery",
"path": "x-pack/plugins/osquery/public/discover/view_results_in_discover.tsx"
},
{
"plugin": "osquery",
"path": "x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx"
},
{
"plugin": "synthetics",
"path": "x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx"
}
]
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.dataViewSpec",
"type": "Object",
"tags": [],
"label": "dataViewSpec",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [
"\nOptionally set the time range in the time picker."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.refreshInterval",
"type": "CompoundType",
"tags": [],
"label": "refreshInterval",
"description": [
"\nOptionally set the refresh interval."
],
"signature": [
"(",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" & ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"\nOptionally apply filters."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [
"\nOptionally set a query."
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.useHash",
"type": "CompoundType",
"tags": [],
"label": "useHash",
"description": [
"\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.searchSessionId",
"type": "string",
"tags": [],
"label": "searchSessionId",
"description": [
"\nBackground search session id"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [
"\nColumns displayed in the table"
],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [
"\nUsed interval of the histogram"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"string[][] | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.savedQuery",
"type": "string",
"tags": [],
"label": "savedQuery",
"description": [
"\nid of the used saved query"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.viewMode",
"type": "CompoundType",
"tags": [],
"label": "viewMode",
"description": [
"\nTable view: Documents vs Field Statistics"
],
"signature": [
"VIEW_MODE",
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.hideAggregatedPreview",
"type": "CompoundType",
"tags": [],
"label": "hideAggregatedPreview",
"description": [
"\nHide mini distribution/preview charts when in Field Statistics mode"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.breakdownField",
"type": "string",
"tags": [],
"label": "breakdownField",
"description": [
"\nBreakdown field"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.isAlertResults",
"type": "CompoundType",
"tags": [],
"label": "isAlertResults",
"description": [
"\nUsed when navigating to particular alert results"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.profile",
"type": "string",
"tags": [],
"label": "profile",
"description": [
"\nThe Discover profile to use"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "discover",
"id": "def-common.APP_ICON",
"type": "string",
"tags": [],
"label": "APP_ICON",
"description": [],
"signature": [
"\"discoverApp\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_DEFAULT_SIZE_SETTING",
"description": [],
"signature": [
"\"context:defaultSize\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.CONTEXT_STEP_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_STEP_SETTING",
"description": [],
"signature": [
"\"context:step\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"description": [],
"signature": [
"\"context:tieBreakerFields\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DEFAULT_COLUMNS_SETTING",
"type": "string",
"tags": [],
"label": "DEFAULT_COLUMNS_SETTING",
"description": [],
"signature": [
"\"defaultColumns\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DISCOVER_APP_LOCATOR",
"type": "string",
"tags": [],
"label": "DISCOVER_APP_LOCATOR",
"description": [],
"signature": [
"\"DISCOVER_APP_LOCATOR\""
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocator",
"type": "Type",
"tags": [],
"label": "DiscoverAppLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
">"
],
"path": "src/plugins/discover/common/locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DOC_HIDE_TIME_COLUMN_SETTING",
"type": "string",
"tags": [],
"label": "DOC_HIDE_TIME_COLUMN_SETTING",
"description": [],
"signature": [
"\"doc_table:hideTimeColumn\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DOC_TABLE_LEGACY",
"type": "string",
"tags": [],
"label": "DOC_TABLE_LEGACY",
"description": [],
"signature": [
"\"doc_table:legacy\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.ENABLE_SQL",
"type": "string",
"tags": [],
"label": "ENABLE_SQL",
"description": [],
"signature": [
"\"discover:enableSql\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.FIELDS_LIMIT_SETTING",
"type": "string",
"tags": [],
"label": "FIELDS_LIMIT_SETTING",
"description": [],
"signature": [
"\"fields:popularLimit\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.HIDE_ANNOUNCEMENTS",
"type": "string",
"tags": [],
"label": "HIDE_ANNOUNCEMENTS",
"description": [],
"signature": [
"\"hideAnnouncements\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.MAX_DOC_FIELDS_DISPLAYED",
"type": "string",
"tags": [],
"label": "MAX_DOC_FIELDS_DISPLAYED",
"description": [],
"signature": [
"\"discover:maxDocFieldsDisplayed\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.MODIFY_COLUMNS_ON_SWITCH",
"type": "string",
"tags": [],
"label": "MODIFY_COLUMNS_ON_SWITCH",
"description": [],
"signature": [
"\"discover:modifyColumnsOnSwitch\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"discover\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.ROW_HEIGHT_OPTION",
"type": "string",
"tags": [],
"label": "ROW_HEIGHT_OPTION",
"description": [],
"signature": [
"\"discover:rowHeightOption\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SAMPLE_ROWS_PER_PAGE_SETTING",
"type": "string",
"tags": [],
"label": "SAMPLE_ROWS_PER_PAGE_SETTING",
"description": [],
"signature": [
"\"discover:sampleRowsPerPage\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SAMPLE_SIZE_SETTING",
"type": "string",
"tags": [],
"label": "SAMPLE_SIZE_SETTING",
"description": [],
"signature": [
"\"discover:sampleSize\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SEARCH_EMBEDDABLE_TYPE",
"type": "string",
"tags": [],
"label": "SEARCH_EMBEDDABLE_TYPE",
"description": [],
"signature": [
"\"search\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SEARCH_FIELDS_FROM_SOURCE",
"type": "string",
"tags": [],
"label": "SEARCH_FIELDS_FROM_SOURCE",
"description": [],
"signature": [
"\"discover:searchFieldsFromSource\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING",
"type": "string",
"tags": [],
"label": "SEARCH_ON_PAGE_LOAD_SETTING",
"description": [],
"signature": [
"\"discover:searchOnPageLoad\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SHOW_FIELD_STATISTICS",
"type": "string",
"tags": [],
"label": "SHOW_FIELD_STATISTICS",
"description": [],
"signature": [
"\"discover:showFieldStatistics\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SHOW_MULTIFIELDS",
"type": "string",
"tags": [],
"label": "SHOW_MULTIFIELDS",
"description": [],
"signature": [
"\"discover:showMultiFields\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SORT_DEFAULT_ORDER_SETTING",
"type": "string",
"tags": [],
"label": "SORT_DEFAULT_ORDER_SETTING",
"description": [],
"signature": [
"\"discover:sort:defaultOrder\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.TRUNCATE_MAX_HEIGHT",
"type": "string",
"tags": [],
"label": "TRUNCATE_MAX_HEIGHT",
"description": [],
"signature": [
"\"truncate:maxHeight\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}