{ "id": "dataEnhanced", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [ { "tags": [], "id": "def-public.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 17 }, "signature": [ "\"ese\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.EQL_SEARCH_STRATEGY", "type": "string", "label": "EQL_SEARCH_STRATEGY", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 19 }, "signature": [ "\"eql\"" ], "initialIsOpen": false } ], "objects": [], "start": { "id": "def-public.DataEnhancedStart", "type": "Type", "label": "DataEnhancedStart", "tags": [], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/public/plugin.ts", "lineNumber": 40 }, "signature": [ "void" ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [ { "id": "def-server.EnhancedDataServerPlugin", "type": "Class", "tags": [], "label": "EnhancedDataServerPlugin", "description": [], "signature": [ { "pluginId": "dataEnhanced", "scope": "server", "docId": "kibDataEnhancedPluginApi", "section": "def-server.EnhancedDataServerPlugin", "text": "EnhancedDataServerPlugin" }, " implements ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.Plugin", "text": "Plugin" }, "" ], "children": [ { "id": "def-server.EnhancedDataServerPlugin.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "initializerContext", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, "; pageSize: number; trackingInterval: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 48 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 48 } }, { "id": "def-server.EnhancedDataServerPlugin.setup", "type": "Function", "label": "setup", "signature": [ "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, "<", { "pluginId": "data", "scope": "server", "docId": "kibDataPluginApi", "section": "def-server.DataPluginStart", "text": "DataPluginStart" }, ", unknown>, deps: SetupDependencies) => void" ], "description": [], "children": [ { "type": "Object", "label": "core", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, "<", { "pluginId": "data", "scope": "server", "docId": "kibDataPluginApi", "section": "def-server.DataPluginStart", "text": "DataPluginStart" }, ", unknown>" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 53 } }, { "type": "Object", "label": "deps", "isRequired": true, "signature": [ "SetupDependencies" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 53 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 53 } }, { "id": "def-server.EnhancedDataServerPlugin.start", "type": "Function", "label": "start", "signature": [ "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreStart", "text": "CoreStart" }, ", { taskManager }: ", { "pluginId": "dataEnhanced", "scope": "server", "docId": "kibDataEnhancedPluginApi", "section": "def-server.StartDependencies", "text": "StartDependencies" }, ") => void" ], "description": [], "children": [ { "type": "Object", "label": "core", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreStart", "text": "CoreStart" } ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 95 } }, { "type": "Object", "label": "{ taskManager }", "isRequired": true, "signature": [ { "pluginId": "dataEnhanced", "scope": "server", "docId": "kibDataEnhancedPluginApi", "section": "def-server.StartDependencies", "text": "StartDependencies" } ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 95 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 95 } }, { "id": "def-server.EnhancedDataServerPlugin.stop", "type": "Function", "label": "stop", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 101 } } ], "source": { "path": "x-pack/plugins/data_enhanced/server/plugin.ts", "lineNumber": 42 }, "initialIsOpen": false } ], "functions": [], "interfaces": [], "enums": [], "misc": [ { "tags": [], "id": "def-server.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 17 }, "signature": [ "\"ese\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-server.EQL_SEARCH_STRATEGY", "type": "string", "label": "EQL_SEARCH_STRATEGY", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 19 }, "signature": [ "\"eql\"" ], "initialIsOpen": false } ], "objects": [] }, "common": { "classes": [], "functions": [ { "id": "def-common.pollSearch", "type": "Function", "children": [ { "type": "Function", "label": "search", "isRequired": true, "signature": [ "() => Promise" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", "lineNumber": 16 } }, { "type": "Function", "label": "cancel", "isRequired": false, "signature": [ "(() => void) | undefined" ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", "lineNumber": 17 } }, { "type": "Object", "label": "{ pollInterval = 1000, abortSignal }", "isRequired": true, "signature": [ { "pluginId": "dataEnhanced", "scope": "common", "docId": "kibDataEnhancedPluginApi", "section": "def-common.IAsyncSearchOptions", "text": "IAsyncSearchOptions" } ], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", "lineNumber": 18 } } ], "signature": [ ">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ", { "pluginId": "dataEnhanced", "scope": "common", "docId": "kibDataEnhancedPluginApi", "section": "def-common.IAsyncSearchOptions", "text": "IAsyncSearchOptions" }, ") => ", "Observable", "" ], "description": [], "label": "pollSearch", "source": { "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", "lineNumber": 15 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-common.EqlSearchStrategyRequest", "type": "Interface", "label": "EqlSearchStrategyRequest", "signature": [ { "pluginId": "dataEnhanced", "scope": "common", "docId": "kibDataEnhancedPluginApi", "section": "def-common.EqlSearchStrategyRequest", "text": "EqlSearchStrategyRequest" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, "<", { "pluginId": "dataEnhanced", "scope": "common", "docId": "kibDataEnhancedPluginApi", "section": "def-common.EqlRequestParams", "text": "EqlRequestParams" }, ">" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.EqlSearchStrategyRequest.options", "type": "Object", "label": "options", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 24 }, "signature": [ "TransportRequestOptions", " | undefined" ] } ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-common.IAsyncSearchOptions", "type": "Interface", "label": "IAsyncSearchOptions", "signature": [ { "pluginId": "dataEnhanced", "scope": "common", "docId": "kibDataEnhancedPluginApi", "section": "def-common.IAsyncSearchOptions", "text": "IAsyncSearchOptions" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IAsyncSearchOptions.pollInterval", "type": "number", "label": "pollInterval", "description": [ "\nThe number of milliseconds to wait between receiving a response and sending another request" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 33 }, "signature": [ "number | undefined" ] } ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 29 }, "initialIsOpen": false }, { "id": "def-common.SearchSessionRequestInfo", "type": "Interface", "label": "SearchSessionRequestInfo", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchSessionRequestInfo.id", "type": "string", "label": "id", "description": [ "\nID of the async search request" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 72 } }, { "tags": [], "id": "def-common.SearchSessionRequestInfo.strategy", "type": "string", "label": "strategy", "description": [ "\nSearch strategy used to submit the search request" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 76 } }, { "tags": [], "id": "def-common.SearchSessionRequestInfo.status", "type": "string", "label": "status", "description": [ "\nstatus" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 80 } }, { "tags": [], "id": "def-common.SearchSessionRequestInfo.error", "type": "string", "label": "error", "description": [ "\nAn optional error. Set if status is set to error." ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 84 }, "signature": [ "string | undefined" ] } ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 68 }, "initialIsOpen": false }, { "id": "def-common.SearchSessionSavedObjectAttributes", "type": "Interface", "label": "SearchSessionSavedObjectAttributes", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.sessionId", "type": "string", "label": "sessionId", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 12 } }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.name", "type": "string", "label": "name", "description": [ "\nUser-facing session name to be displayed in session management" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 16 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.appId", "type": "string", "label": "appId", "description": [ "\nApp that created the session. e.g 'discover'" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 20 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.created", "type": "string", "label": "created", "description": [ "\nCreation time of the session" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 24 } }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.touched", "type": "string", "label": "touched", "description": [ "\nLast touch time of the session" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 28 } }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.expires", "type": "string", "label": "expires", "description": [ "\nExpiration time of the session. Expiration itself is managed by Elasticsearch." ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 32 } }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.status", "type": "Enum", "label": "status", "description": [ "\nstatus" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 36 }, "signature": [ { "pluginId": "dataEnhanced", "scope": "common", "docId": "kibDataEnhancedPluginApi", "section": "def-common.SearchSessionStatus", "text": "SearchSessionStatus" } ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.urlGeneratorId", "type": "string", "label": "urlGeneratorId", "description": [ "\nurlGeneratorId" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 40 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.initialState", "type": "Object", "label": "initialState", "description": [ "\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session." ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 45 }, "signature": [ "Record | undefined" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.restoreState", "type": "Object", "label": "restoreState", "description": [ "\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones." ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 50 }, "signature": [ "Record | undefined" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.idMapping", "type": "Object", "label": "idMapping", "description": [ "\nMapping of search request hashes to their corresponsing info (async search id, etc.)" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 54 }, "signature": [ "Record" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.persisted", "type": "boolean", "label": "persisted", "description": [ "\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system." ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 59 } }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.realmType", "type": "string", "label": "realmType", "description": [ "\nThe realm type/name & username uniquely identifies the user who created this search session" ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 63 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.realmName", "type": "string", "label": "realmName", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 64 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SearchSessionSavedObjectAttributes.username", "type": "string", "label": "username", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 65 }, "signature": [ "string | undefined" ] } ], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 11 }, "initialIsOpen": false } ], "enums": [ { "id": "def-common.SearchSessionStatus", "type": "Enum", "label": "SearchSessionStatus", "tags": [], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/status.ts", "lineNumber": 8 }, "initialIsOpen": false } ], "misc": [ { "tags": [], "id": "def-common.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 17 }, "signature": [ "\"ese\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.EQL_SEARCH_STRATEGY", "type": "string", "label": "EQL_SEARCH_STRATEGY", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 19 }, "signature": [ "\"eql\"" ], "initialIsOpen": false }, { "id": "def-common.EqlRequestParams", "type": "Type", "label": "EqlRequestParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 21 }, "signature": [ "EqlSearch>" ], "initialIsOpen": false }, { "id": "def-common.EqlSearchStrategyResponse", "type": "Type", "label": "EqlSearchStrategyResponse", "tags": [], "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/types.ts", "lineNumber": 27 }, "signature": [ "IKibanaSearchResponse>" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.SEARCH_SESSION_TYPE", "type": "string", "label": "SEARCH_SESSION_TYPE", "description": [], "source": { "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", "lineNumber": 10 }, "signature": [ "\"search-session\"" ], "initialIsOpen": false } ], "objects": [] } }