7ff28959b1
* Update api docs * update api docs after merge from master
358 lines
No EOL
11 KiB
JSON
358 lines
No EOL
11 KiB
JSON
{
|
|
"id": "dataEnhanced",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-public.ENHANCED_ES_SEARCH_STRATEGY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENHANCED_ES_SEARCH_STRATEGY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ese\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-public.EQL_SEARCH_STRATEGY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "EQL_SEARCH_STRATEGY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"eql\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-public.DataEnhancedStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DataEnhancedStart",
|
|
"description": [],
|
|
"signature": [
|
|
"void"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/public/plugin.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"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"
|
|
},
|
|
"<void, void, ",
|
|
"DataEnhancedSetupDependencies",
|
|
", ",
|
|
"DataEnhancedStartDependencies",
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initializerContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<Readonly<{} & { search: Readonly<{} & { sessions: Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
"DataEnhancedStartDependencies",
|
|
", unknown>, deps: ",
|
|
"DataEnhancedSetupDependencies",
|
|
") => void"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
"DataEnhancedStartDependencies",
|
|
", unknown>"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.setup.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"signature": [
|
|
"DataEnhancedSetupDependencies"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", { taskManager }: ",
|
|
"DataEnhancedStartDependencies",
|
|
") => void"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.start.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ taskManager }",
|
|
"description": [],
|
|
"signature": [
|
|
"DataEnhancedStartDependencies"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EnhancedDataServerPlugin.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.ENHANCED_ES_SEARCH_STRATEGY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENHANCED_ES_SEARCH_STRATEGY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ese\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dataEnhanced",
|
|
"id": "def-server.EQL_SEARCH_STRATEGY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "EQL_SEARCH_STRATEGY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"eql\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |