2021-03-03 04:02:17 +01:00
{
"id" : "securitySolution" ,
"client" : {
"classes" : [
{
"id" : "def-public.Plugin" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "Plugin" ,
"description" : [ ] ,
"signature" : [
"Plugin" ,
" implements " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.Plugin" ,
"text" : "Plugin"
} ,
"<" ,
"PluginSetup" ,
", " ,
"PluginStart" ,
", " ,
"SetupPlugins"
] ,
"children" : [
{
"id" : "def-public.Plugin.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "Object" ,
"label" : "initializerContext" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.PluginInitializerContext" ,
"text" : "PluginInitializerContext"
} ,
"<object>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.Plugin.setup" ,
"type" : "Function" ,
"label" : "setup" ,
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
} ,
", " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.PluginStart" ,
"text" : "PluginStart"
} ,
">, plugins: " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.SetupPlugins" ,
"text" : "SetupPlugins"
} ,
") => " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.PluginSetup" ,
"text" : "PluginSetup"
}
] ,
"description" : [ ] ,
"children" : [
{
"type" : "Object" ,
"label" : "core" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
} ,
", " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.PluginStart" ,
"text" : "PluginStart"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 98
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "Object" ,
"label" : "plugins" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.SetupPlugins" ,
"text" : "SetupPlugins"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 98
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 98
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.Plugin.start" ,
"type" : "Function" ,
"label" : "start" ,
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreStart" ,
"text" : "CoreStart"
} ,
", plugins: " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
} ,
") => {}"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "Object" ,
"label" : "core" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreStart" ,
"text" : "CoreStart"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 348
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "Object" ,
"label" : "plugins" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 348
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 348
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.Plugin.stop" ,
"type" : "Function" ,
"label" : "stop" ,
"signature" : [
"() => {}"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 393
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 72
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-public.PluginSetup" ,
"type" : "Interface" ,
"label" : "PluginSetup" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.PluginSetup.resolver" ,
"type" : "Function" ,
"label" : "resolver" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 69
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"() => Promise<" ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.ResolverPluginSetup" ,
"text" : "ResolverPluginSetup"
} ,
">"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 68
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-public.PluginStart" ,
"type" : "Interface" ,
"label" : "PluginStart" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 72
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [
2021-03-06 02:12:28 +01:00
{
"id" : "def-server.AppClient" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "AppClient" ,
"description" : [ ] ,
"children" : [
{
"id" : "def-server.AppClient.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "string" ,
"label" : "spaceId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/client/client.ts" ,
"lineNumber" : 13
}
} ,
{
"type" : "Object" ,
"label" : "config" ,
"isRequired" : true ,
"signature" : [
"Readonly<{} & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; endpointResultListDefaultFirstPageIndex: number; endpointResultListDefaultPageSize: number; alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; packagerTaskInterval: string; validateArtifactDownloads: boolean; }>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/client/client.ts" ,
"lineNumber" : 13
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/client/client.ts" ,
"lineNumber" : 13
}
} ,
{
"id" : "def-server.AppClient.getSignalsIndex" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => string"
] ,
"description" : [ ] ,
"label" : "getSignalsIndex" ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/client/client.ts" ,
"lineNumber" : 19
} ,
"tags" : [ ] ,
"returnComment" : [ ]
}
] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/client/client.ts" ,
"lineNumber" : 10
} ,
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
"id" : "def-server.Plugin" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "Plugin" ,
"description" : [ ] ,
"signature" : [
"Plugin" ,
" implements " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.Plugin" ,
"text" : "Plugin"
} ,
"<" ,
"PluginSetup" ,
", " ,
"PluginStart" ,
", " ,
"SetupPlugins"
] ,
"children" : [
{
"id" : "def-server.Plugin.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "Object" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.PluginInitializerContext" ,
"text" : "PluginInitializerContext"
} ,
"<unknown>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 144
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 144
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.Plugin.setup" ,
"type" : "Function" ,
"label" : "setup" ,
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
} ,
", " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.PluginStart" ,
"text" : "PluginStart"
} ,
">, plugins: " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.SetupPlugins" ,
"text" : "SetupPlugins"
} ,
") => {}"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "Object" ,
"label" : "core" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
} ,
", " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.PluginStart" ,
"text" : "PluginStart"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 156
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "Object" ,
"label" : "plugins" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.SetupPlugins" ,
"text" : "SetupPlugins"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 156
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 156
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.Plugin.start" ,
"type" : "Function" ,
"label" : "start" ,
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreStart" ,
"text" : "CoreStart"
} ,
", plugins: " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
} ,
") => {}"
] ,
"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/security_solution/server/plugin.ts" ,
2021-03-11 17:17:43 +01:00
"lineNumber" : 337
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "Object" ,
"label" : "plugins" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.StartPlugins" ,
"text" : "StartPlugins"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-11 17:17:43 +01:00
"lineNumber" : 337
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-11 17:17:43 +01:00
"lineNumber" : 337
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.Plugin.stop" ,
"type" : "Function" ,
"label" : "stop" ,
"signature" : [
"() => void"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-11 17:17:43 +01:00
"lineNumber" : 398
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 128
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
2021-03-06 02:12:28 +01:00
}
] ,
"functions" : [
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.buildRouteValidation" ,
"type" : "Function" ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-03-06 02:12:28 +01:00
"type" : "Uncategorized" ,
"label" : "schema" ,
"isRequired" : true ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"T"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/utils/build_validation/route_validation.ts" ,
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
2021-03-06 02:12:28 +01:00
}
] ,
"signature" : [
"<T extends " ,
"Mixed" ,
", A = " ,
"TypeOf" ,
"<T>>(schema: T) => " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.RouteValidationFunction" ,
"text" : "RouteValidationFunction"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
"<A>"
] ,
"description" : [ ] ,
"label" : "buildRouteValidation" ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/utils/build_validation/route_validation.ts" ,
"lineNumber" : 30
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.buildSiemResponse" ,
"type" : "Function" ,
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "response" ,
"isRequired" : true ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"{ custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | " ,
"Stream" ,
" | undefined>(options: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.CustomHttpResponseOptions" ,
"text" : "CustomHttpResponseOptions"
} ,
"<T>) => " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaResponse" ,
"text" : "KibanaResponse"
} ,
"<T>; badRequest: (options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.ErrorHttpResponseOptions" ,
"text" : "ErrorHttpResponseOptions"
} ,
") => " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaResponse" ,
"text" : "KibanaResponse"
}
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/routes/utils.ts" ,
"lineNumber" : 291
}
2021-03-03 04:02:17 +01:00
}
] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"(response: { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | " ,
"Stream" ,
" | undefined>(options: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.CustomHttpResponseOptions" ,
"text" : "CustomHttpResponseOptions"
} ,
"<T>) => " ,
"KibanaResponse" ,
"<T>; badRequest: (options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.ErrorHttpResponseOptions" ,
"text" : "ErrorHttpResponseOptions"
} ,
") => " ,
"KibanaResponse"
] ,
"description" : [ ] ,
"label" : "buildSiemResponse" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/routes/utils.ts" ,
"lineNumber" : 291
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"returnComment" : [ ] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
2021-03-06 02:12:28 +01:00
} ,
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.createBootstrapIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<{ path: string; method: \"PUT\"; body: unknown; }, boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/create_bootstrap_index.ts" ,
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "index" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/create_bootstrap_index.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
2021-03-06 02:12:28 +01:00
"<{ path: string; method: \"PUT\"; body: unknown; }, boolean>, index: string) => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "createBootstrapIndex" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/create_bootstrap_index.ts" ,
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.deleteAllIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<" ,
"IndicesDeleteParams" ,
", Promise<any>>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts" ,
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "pattern" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts" ,
"lineNumber" : 13
}
} ,
{
"type" : "number" ,
"label" : "maxAttempts" ,
"isRequired" : true ,
"signature" : [
"number"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts" ,
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
2021-03-06 02:12:28 +01:00
"<" ,
"IndicesDeleteParams" ,
", Promise<any>>, pattern: string, maxAttempts?: number) => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteAllIndex" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.deletePolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<{ path: string; method: \"DELETE\"; }, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_policy.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "policy" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_policy.ts" ,
"lineNumber" : 12
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
"<{ path: string; method: \"DELETE\"; }, unknown>, policy: string) => Promise<unknown>"
] ,
"description" : [ ] ,
"label" : "deletePolicy" ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_policy.ts" ,
"lineNumber" : 10
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.deleteTemplate" ,
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
"<" ,
"IndicesDeleteTemplateParams" ,
", unknown>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_template.ts" ,
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "name" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_template.ts" ,
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
"<" ,
2021-03-06 02:12:28 +01:00
"IndicesDeleteTemplateParams" ,
", unknown>, name: string) => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteTemplate" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_template.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.getIndexExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<{ index: string; size: number; terminate_after: number; allow_no_indices: boolean; }, { _shards: { total: number; }; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_index_exists.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "index" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_index_exists.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
2021-03-06 02:12:28 +01:00
"<{ index: string; size: number; terminate_after: number; allow_no_indices: boolean; }, { _shards: { total: number; }; }>, index: string) => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getIndexExists" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_index_exists.ts" ,
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.getPolicyExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<{ path: string; method: \"GET\"; }, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_policy_exists.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "policy" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_policy_exists.ts" ,
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
2021-03-06 02:12:28 +01:00
"<{ path: string; method: \"GET\"; }, unknown>, policy: string) => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getPolicyExists" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_policy_exists.ts" ,
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.getTemplateExists" ,
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
"<" ,
"IndicesExistsTemplateParams" ,
", boolean>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_template_exists.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
"label" : "template" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_template_exists.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
"<" ,
"IndicesExistsTemplateParams" ,
", boolean>, template: string) => Promise<boolean>"
] ,
"description" : [ ] ,
"label" : "getTemplateExists" ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_template_exists.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.readPrivileges" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<{}, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/privileges/read_privileges.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "index" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/privileges/read_privileges.ts" ,
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
2021-03-06 02:12:28 +01:00
"<{}, unknown>, index: string) => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "readPrivileges" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/privileges/read_privileges.ts" ,
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.setPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<{ path: string; method: \"PUT\"; body: unknown; }, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_policy.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "policy" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_policy.ts" ,
"lineNumber" : 12
}
} ,
{
"type" : "Unknown" ,
"label" : "body" ,
"isRequired" : true ,
"signature" : [
"unknown"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_policy.ts" ,
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
2021-03-06 02:12:28 +01:00
"<{ path: string; method: \"PUT\"; body: unknown; }, unknown>, policy: string, body: unknown) => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "setPolicy" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_policy.ts" ,
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.setTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Function" ,
"label" : "callWithRequest" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.CallWithRequest" ,
"text" : "CallWithRequest"
} ,
2021-03-06 02:12:28 +01:00
"<" ,
"IndicesPutTemplateParams" ,
", unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts" ,
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "name" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts" ,
"lineNumber" : 13
}
} ,
{
"type" : "Unknown" ,
"label" : "body" ,
"isRequired" : true ,
"signature" : [
"unknown"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts" ,
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(callWithRequest: " ,
"CallWithRequest" ,
2021-03-06 02:12:28 +01:00
"<" ,
"IndicesPutTemplateParams" ,
", unknown>, name: string, body: unknown) => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "setTemplate" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.transformError" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"type" : "CompoundType" ,
"label" : "err" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"Error & Partial<" ,
"ResponseError" ,
"<Record<string, any>, " ,
"Context" ,
">>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/routes/utils.ts" ,
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(err: Error & Partial<" ,
"ResponseError" ,
"<Record<string, any>, " ,
"Context" ,
">>) => " ,
"OutputError"
] ,
"description" : [ ] ,
"label" : "transformError" ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/routes/utils.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"id" : "def-server.AppRequestContext" ,
"type" : "Interface" ,
"label" : "AppRequestContext" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.AppRequestContext.getAppClient" ,
"type" : "Function" ,
"label" : "getAppClient" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 18
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"() => " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.AppClient" ,
"text" : "AppClient"
}
]
}
] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
"id" : "def-server.ConfigType" ,
"type" : "Type" ,
"label" : "ConfigType" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/config.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 43
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ readonly enabled: boolean; readonly signalsIndex: string; readonly maxRuleImportExportSize: number; readonly maxRuleImportPayloadBytes: number; readonly maxTimelineImportExportSize: number; readonly maxTimelineImportPayloadBytes: number; readonly endpointResultListDefaultFirstPageIndex: number; readonly endpointResultListDefaultPageSize: number; readonly alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; readonly packagerTaskInterval: string; readonly validateArtifactDownloads: boolean; }"
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-server.PluginSetup" ,
"type" : "Interface" ,
"label" : "PluginSetup" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 105
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-server.PluginStart" ,
"type" : "Interface" ,
"label" : "PluginStart" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 107
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"common" : {
"classes" : [ ] ,
"functions" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.addIdToItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Uncategorized" ,
2021-03-06 02:12:28 +01:00
"label" : "item" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"NotArray<T>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/add_remove_id_to_item.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"<T>(item: NotArray<T>) => T"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "addIdToItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/add_remove_id_to_item.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.DefaultArray" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Uncategorized" ,
2021-03-06 02:12:28 +01:00
"label" : "codec" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"C"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_array.ts" ,
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"<C extends " ,
2021-03-03 04:02:17 +01:00
"Mixed" ,
2021-03-06 02:12:28 +01:00
">(codec: C) => " ,
"Type" ,
"<" ,
2021-03-03 04:02:17 +01:00
"TypeOf" ,
2021-03-06 02:12:28 +01:00
"<C>[], " ,
"TypeOf" ,
"<C>[] | undefined, unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nTypes the DefaultArray<C> as:\n - If undefined, then a default array will be set\n - If an array is sent in, then the array will be validated to ensure all elements are type C"
] ,
"label" : "DefaultArray" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_array.ts" ,
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.exactCheck" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"type" : "Unknown" ,
"label" : "original" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"unknown"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/exact_check.ts" ,
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"type" : "CompoundType" ,
"label" : "decoded" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"Either" ,
"<" ,
"Errors" ,
", T>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/exact_check.ts" ,
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"<T>(original: unknown, decoded: " ,
2021-03-03 04:02:17 +01:00
"Either" ,
2021-03-06 02:12:28 +01:00
"<" ,
"Errors" ,
", T>) => " ,
"Either" ,
"<" ,
"Errors" ,
", T>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nGiven an original object and a decoded object this will return an error\nif and only if the original object has additional keys that the decoded\nobject does not have. If the original decoded already has an error, then\nthis will return the error as is and not continue.\n\nNOTE: You MUST use t.exact(...) for this to operate correctly as your schema\nneeds to remove additional keys before the compare\n\nYou might not need this in the future if the below issue is solved:\nhttps://github.com/gcanti/io-ts/issues/322\n"
] ,
"label" : "exactCheck" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/exact_check.ts" ,
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
2021-03-06 02:12:28 +01:00
{
"tags" : [ ] ,
"id" : "def-common.foldLeftRight" ,
"type" : "Function" ,
"label" : "foldLeftRight" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/test_utils.ts" ,
"lineNumber" : 29
} ,
"signature" : [
"<T>(ma: " ,
"Either" ,
"<" ,
"Errors" ,
", unknown>) => Message<unknown>"
] ,
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
"id" : "def-common.formatErrors" ,
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
"label" : "errors" ,
"isRequired" : true ,
"signature" : [
"Errors"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/format_errors.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(errors: " ,
"Errors" ,
") => string[]"
] ,
"description" : [ ] ,
"label" : "formatErrors" ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/format_errors.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 11
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.getPaths" ,
"type" : "Function" ,
"children" : [
{
"type" : "CompoundType" ,
"label" : "validation" ,
"isRequired" : true ,
"signature" : [
"Either" ,
"<" ,
"Errors" ,
", A>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/test_utils.ts" ,
"lineNumber" : 36
}
}
] ,
"signature" : [
"<A>(validation: " ,
"Either" ,
"<" ,
"Errors" ,
", A>) => string[]"
] ,
"description" : [
"\nConvenience utility to keep the error message handling within tests to be\nvery concise."
] ,
"label" : "getPaths" ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/test_utils.ts" ,
"lineNumber" : 36
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.migratePackagePolicyToV7110" ,
"type" : "Function" ,
"children" : [
{
"type" : "CompoundType" ,
"label" : "packagePolicyDoc" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectUnsanitizedDoc" ,
"text" : "SavedObjectUnsanitizedDoc"
} ,
"<" ,
{
"pluginId" : "fleet" ,
"scope" : "common" ,
"docId" : "kibFleetPluginApi" ,
"section" : "def-common.PackagePolicy" ,
"text" : "PackagePolicy"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_11_0.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(packagePolicyDoc: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectUnsanitizedDoc" ,
"text" : "SavedObjectUnsanitizedDoc"
} ,
"<" ,
{
"pluginId" : "fleet" ,
"scope" : "common" ,
"docId" : "kibFleetPluginApi" ,
"section" : "def-common.PackagePolicy" ,
"text" : "PackagePolicy"
} ,
">) => " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectUnsanitizedDoc" ,
"text" : "SavedObjectUnsanitizedDoc"
} ,
"<" ,
{
"pluginId" : "fleet" ,
"scope" : "common" ,
"docId" : "kibFleetPluginApi" ,
"section" : "def-common.PackagePolicy" ,
"text" : "PackagePolicy"
} ,
">"
] ,
"description" : [ ] ,
"label" : "migratePackagePolicyToV7110" ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_11_0.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.migratePackagePolicyToV7120" ,
"type" : "Function" ,
"children" : [
{
"type" : "CompoundType" ,
"label" : "packagePolicyDoc" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectUnsanitizedDoc" ,
"text" : "SavedObjectUnsanitizedDoc"
} ,
"<" ,
{
"pluginId" : "fleet" ,
"scope" : "common" ,
"docId" : "kibFleetPluginApi" ,
"section" : "def-common.PackagePolicy" ,
"text" : "PackagePolicy"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_12_0.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(packagePolicyDoc: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectUnsanitizedDoc" ,
"text" : "SavedObjectUnsanitizedDoc"
} ,
"<" ,
{
"pluginId" : "fleet" ,
"scope" : "common" ,
"docId" : "kibFleetPluginApi" ,
"section" : "def-common.PackagePolicy" ,
"text" : "PackagePolicy"
} ,
">) => " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectUnsanitizedDoc" ,
"text" : "SavedObjectUnsanitizedDoc"
} ,
"<" ,
{
"pluginId" : "fleet" ,
"scope" : "common" ,
"docId" : "kibFleetPluginApi" ,
"section" : "def-common.PackagePolicy" ,
"text" : "PackagePolicy"
} ,
">"
] ,
"description" : [ ] ,
"label" : "migratePackagePolicyToV7120" ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_12_0.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.removeExternalLinkText" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "str" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/test_utils.ts" ,
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"(str: string) => string"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nConvenience utility to remove text appended to links by EUI"
] ,
"label" : "removeExternalLinkText" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/test_utils.ts" ,
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.removeIdFromItem" ,
"type" : "Function" ,
"children" : [
{
"type" : "Uncategorized" ,
"label" : "item" ,
"isRequired" : true ,
"signature" : [
"NotArray<T>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/add_remove_id_to_item.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 34
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"<T>(item: NotArray<T>) => T | Pick<T & { id?: string | undefined; }, Exclude<keyof T, \"id\">>"
] ,
"description" : [
"\nThis is to reverse the id you added to your arrays for ReactJS keys."
] ,
"label" : "removeIdFromItem" ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/add_remove_id_to_item.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 33
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.validate" ,
"type" : "Function" ,
"children" : [
{
"type" : "Uncategorized" ,
"label" : "obj" ,
"isRequired" : true ,
"signature" : [
"object"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/validate.ts" ,
"lineNumber" : 16
}
} ,
{
"type" : "Uncategorized" ,
"label" : "schema" ,
"isRequired" : true ,
"signature" : [
"T"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/validate.ts" ,
"lineNumber" : 17
}
}
] ,
"signature" : [
"<T extends " ,
"Mixed" ,
">(obj: object, schema: T) => [" ,
"TypeOf" ,
"<T> | null, string | null]"
] ,
"description" : [ ] ,
"label" : "validate" ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/validate.ts" ,
"lineNumber" : 15
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.validateEither" ,
"type" : "Function" ,
"children" : [
{
"type" : "Uncategorized" ,
"label" : "schema" ,
"isRequired" : true ,
"signature" : [
"T"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/validate.ts" ,
"lineNumber" : 30
}
} ,
{
"type" : "Uncategorized" ,
"label" : "obj" ,
"isRequired" : true ,
"signature" : [
"A"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/validate.ts" ,
"lineNumber" : 31
}
}
] ,
"signature" : [
"<T extends " ,
"Mixed" ,
", A extends unknown>(schema: T, obj: A) => " ,
"Either" ,
"<Error, A>"
] ,
"description" : [ ] ,
"label" : "validateEither" ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/validate.ts" ,
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [
{
"id" : "def-common.DefaultVersionNumberDecoded" ,
"type" : "Type" ,
"label" : "DefaultVersionNumberDecoded" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_version_number.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 24
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"number"
] ,
"initialIsOpen" : false
}
] ,
"objects" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.DefaultStringArray" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "DefaultStringArray" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nTypes the DefaultStringArray as:\n - If undefined, then a default array will be set\n - If an array is sent in, then the array will be validated to ensure all elements are a string"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_string_array.ts" ,
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Type" ,
2021-03-06 02:12:28 +01:00
"<string[], string[] | undefined, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
"id" : "def-common.DefaultUuid" ,
"type" : "Object" ,
"label" : "DefaultUuid" ,
"description" : [
"\nTypes the DefaultUuid as:\n - If null or undefined, then a default string uuid.v4() will be\n created otherwise it will be checked just against an empty string"
] ,
"source" : {
"path" : "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_uuid.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 19
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Type" ,
"<string, string | undefined, unknown>"
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.DefaultVersionNumber" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "DefaultVersionNumber" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nTypes the DefaultVersionNumber as:\n - If null or undefined, then a default of the number 1 will be used"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_version_number.ts" ,
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Type" ,
2021-03-06 02:12:28 +01:00
"<number, number | undefined, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.NonEmptyString" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "NonEmptyString" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nTypes the NonEmptyString as:\n - A string that is not empty"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security_solution/common/detection_engine/schemas/types/non_empty_string.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Type" ,
2021-03-06 02:12:28 +01:00
"<string, string, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
}
]
}
}