2021-03-03 04:02:17 +01:00
{
"id" : "lists" ,
"client" : {
"classes" : [
{
"id" : "def-public.Plugin" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "Plugin" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.Plugin" ,
"text" : "Plugin"
} ,
" implements " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.Plugin" ,
"text" : "Plugin"
} ,
"<" ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginSetup" ,
"text" : "PluginSetup"
} ,
", " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginStart" ,
"text" : "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/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 19
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 19
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" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.StartPlugins" ,
"text" : "StartPlugins"
} ,
", " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginStart" ,
"text" : "PluginStart"
} ,
">, plugins: " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.SetupPlugins" ,
"text" : "SetupPlugins"
} ,
") => " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.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" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.StartPlugins" ,
"text" : "StartPlugins"
} ,
", " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginStart" ,
"text" : "PluginStart"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 22
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "Object" ,
"label" : "plugins" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.SetupPlugins" ,
"text" : "SetupPlugins"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 22
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 22
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" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.StartPlugins" ,
"text" : "StartPlugins"
} ,
") => " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginStart" ,
"text" : "PluginStart"
}
] ,
"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/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "Object" ,
"label" : "plugins" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.StartPlugins" ,
"text" : "StartPlugins"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"functions" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.addEndpointExceptionListWithValidation" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "{\n http,\n signal,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.AddEndpointExceptionListProps" ,
"text" : "AddEndpointExceptionListProps"
}
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 532
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, signal, }: " ,
"AddEndpointExceptionListProps" ,
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | {}>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "addEndpointExceptionListWithValidation" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 532
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.addExceptionListItemWithValidation" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "{\n http,\n listItem,\n signal,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.AddExceptionListItemProps" ,
"text" : "AddExceptionListItemProps"
}
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 109
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, listItem, signal, }: " ,
"AddExceptionListItemProps" ,
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "addExceptionListItemWithValidation" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 109
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.addExceptionListWithValidation" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n http,\n list,\n signal,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
2021-03-06 02:12:28 +01:00
"pluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"scope" : "public" ,
2021-03-06 02:12:28 +01:00
"docId" : "kibListsPluginApi" ,
"section" : "def-public.AddExceptionListProps" ,
"text" : "AddExceptionListProps"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, list, signal, }: " ,
"AddExceptionListProps" ,
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "addExceptionListWithValidation" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.exportListWithValidation" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n http,\n listId,\n signal,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.ExportListParams" ,
"text" : "ExportListParams"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/lists/api.ts" ,
"lineNumber" : 174
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, listId, signal, }: " ,
"ExportListParams" ,
") => Promise<Blob>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "exportListWithValidation" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/lists/api.ts" ,
"lineNumber" : 174
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.fetchExceptionListByIdWithValidation" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n http,\n id,\n namespaceType,\n signal,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.ApiCallByIdProps" ,
"text" : "ApiCallByIdProps"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 299
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, id, namespaceType, signal, }: " ,
"ApiCallByIdProps" ,
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "fetchExceptionListByIdWithValidation" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 299
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.updateExceptionListItemWithValidation" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n http,\n listItem,\n signal,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.UpdateExceptionListItemProps" ,
"text" : "UpdateExceptionListItemProps"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 195
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, listItem, signal, }: " ,
"UpdateExceptionListItemProps" ,
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "updateExceptionListItemWithValidation" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/api.ts" ,
"lineNumber" : 195
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useApi" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "http" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
2021-03-06 02:12:28 +01:00
"pluginId" : "core" ,
2021-03-03 04:02:17 +01:00
"scope" : "public" ,
2021-03-06 02:12:28 +01:00
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-public.HttpSetup" ,
"text" : "HttpSetup"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/use_api.ts" ,
"lineNumber" : 41
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"(http: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-public.HttpSetup" ,
"text" : "HttpSetup"
} ,
2021-03-03 04:02:17 +01:00
") => " ,
2021-03-06 02:12:28 +01:00
"ExceptionsApi"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "useApi" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/use_api.ts" ,
"lineNumber" : 41
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useAsync" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Function" ,
"label" : "fn" ,
"isRequired" : true ,
"signature" : [
"(...args: Args) => Promise<Result>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/common/hooks/use_async.ts" ,
"lineNumber" : 26
}
}
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"<Args extends unknown[], Result>(fn: (...args: Args) => Promise<Result>) => " ,
2021-03-03 04:02:17 +01:00
"Async" ,
2021-03-06 02:12:28 +01:00
"<Args, Result>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\n"
] ,
"label" : "useAsync" ,
"source" : {
"path" : "x-pack/plugins/lists/public/common/hooks/use_async.ts" ,
"lineNumber" : 25
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [
"An {@link AsyncTask} containing the underlying task's state along with a start callback"
] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useCreateListIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => " ,
"Async" ,
"<[args: " ,
"OptionalSignalArgs" ,
"<" ,
2021-03-06 02:12:28 +01:00
"ApiParams" ,
">], { acknowledged: boolean; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "useCreateListIndex" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/lists/hooks/use_create_list_index.ts" ,
"lineNumber" : 15
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.useCursor" ,
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
"label" : "{ pageIndex, pageSize }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.UseCursorProps" ,
"text" : "UseCursorProps"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/common/hooks/use_cursor.ts" ,
"lineNumber" : 20
}
}
] ,
"signature" : [
"({ pageIndex, pageSize }: " ,
"UseCursorProps" ,
") => [string | undefined, SetCursor]"
] ,
"description" : [ ] ,
"label" : "useCursor" ,
"source" : {
"path" : "x-pack/plugins/lists/public/common/hooks/use_cursor.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.useDeleteList" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => " ,
"Async" ,
"<[args: " ,
"OptionalSignalArgs" ,
"<" ,
"DeleteListParams" ,
">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>"
] ,
"description" : [ ] ,
"label" : "useDeleteList" ,
"source" : {
"path" : "x-pack/plugins/lists/public/lists/hooks/use_delete_list.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useExceptionListItems" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n http,\n lists,\n pagination = {\n page: 1,\n perPage: 20,\n total: 0,\n },\n filterOptions,\n showDetectionsListsOnly,\n showEndpointListsOnly,\n matchFilters,\n onError,\n onSuccess,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.UseExceptionListProps" ,
"text" : "UseExceptionListProps"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/use_exception_list_items.ts" ,
"lineNumber" : 39
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, lists, pagination, filterOptions, showDetectionsListsOnly, showEndpointListsOnly, matchFilters, onError, onSuccess, }: " ,
"UseExceptionListProps" ,
") => " ,
"ReturnExceptionListAndItems"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nHook for using to get an ExceptionList and it's ExceptionListItems\n"
] ,
"label" : "useExceptionListItems" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/use_exception_list_items.ts" ,
"lineNumber" : 39
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useExceptionLists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n errorMessage,\n http,\n pagination = {\n page: 1,\n perPage: 20,\n total: 0,\n },\n filterOptions = {},\n namespaceTypes,\n notifications,\n showTrustedApps = false,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.UseExceptionListsProps" ,
"text" : "UseExceptionListsProps"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/use_exception_lists.ts" ,
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ errorMessage, http, pagination, filterOptions, namespaceTypes, notifications, showTrustedApps, }: " ,
"UseExceptionListsProps" ,
") => " ,
"ReturnExceptionLists"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nHook for fetching ExceptionLists\n"
] ,
"label" : "useExceptionLists" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/use_exception_lists.ts" ,
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.useExportList" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => " ,
"Async" ,
"<[args: " ,
"OptionalSignalArgs" ,
"<" ,
"ExportListParams" ,
">], Blob>"
] ,
"description" : [ ] ,
"label" : "useExportList" ,
"source" : {
"path" : "x-pack/plugins/lists/public/lists/hooks/use_export_list.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useFindLists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => " ,
"Async" ,
"<[args: " ,
"OptionalSignalArgs" ,
"<" ,
2021-03-06 02:12:28 +01:00
"FindListsParams" ,
">], { cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "useFindLists" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/lists/hooks/use_find_lists.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useImportList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => " ,
"Async" ,
"<[args: " ,
"OptionalSignalArgs" ,
"<" ,
2021-03-06 02:12:28 +01:00
"ImportListParams" ,
">], { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "useImportList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/lists/hooks/use_import_list.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useIsMounted" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"() => GetIsMounted"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\n"
] ,
"label" : "useIsMounted" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/common/hooks/use_is_mounted.ts" ,
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [
"A {@link GetIsMounted} getter function returning whether the component is currently mounted"
] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.usePersistExceptionItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n http,\n onError,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.PersistHookProps" ,
"text" : "PersistHookProps"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/persist_exception_item.ts" ,
"lineNumber" : 35
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, onError, }: " ,
"PersistHookProps" ,
") => " ,
"ReturnPersistExceptionItem"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nHook for creating or updating ExceptionListItem\n"
] ,
"label" : "usePersistExceptionItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/persist_exception_item.ts" ,
"lineNumber" : 35
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.usePersistExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n http,\n onError,\n}" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.PersistHookProps" ,
"text" : "PersistHookProps"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/persist_exception_list.ts" ,
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ http, onError, }: " ,
"PersistHookProps" ,
") => " ,
"ReturnPersistExceptionList"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nHook for creating or updating ExceptionList\n"
] ,
"label" : "usePersistExceptionList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/exceptions/hooks/persist_exception_list.ts" ,
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useReadListIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => " ,
"Async" ,
"<[args: " ,
"OptionalSignalArgs" ,
"<" ,
"ApiParams" ,
">], { list_index: boolean; list_item_index: boolean; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "useReadListIndex" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/lists/hooks/use_read_list_index.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.useReadListPrivileges" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => " ,
"Async" ,
"<[args: " ,
"OptionalSignalArgs" ,
"<" ,
"ApiParams" ,
">], unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "useReadListPrivileges" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/lists/hooks/use_read_list_privileges.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.withOptionalSignal" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"type" : "Function" ,
"label" : "fn" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"(args: Args) => Result"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/common/with_optional_signal.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"<Args extends SignalArgs, Result>(fn: (args: Args) => Result) => (args: " ,
"OptionalSignalArgs" ,
"<Args>) => Result"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\n"
] ,
"label" : "withOptionalSignal" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/public/common/with_optional_signal.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [
"An async function where the AbortSignal argument is optional"
] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"id" : "def-public.ExceptionList" ,
"type" : "Interface" ,
"label" : "ExceptionList" ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.ExceptionList" ,
"text" : "ExceptionList"
} ,
" extends { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }"
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.ExceptionList.totalItems" ,
"type" : "number" ,
"label" : "totalItems" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 42
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 41
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.ExceptionListFilter" ,
"type" : "Interface" ,
"label" : "ExceptionListFilter" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListFilter.name" ,
"type" : "CompoundType" ,
"label" : "name" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 126
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | null | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListFilter.list_id" ,
"type" : "CompoundType" ,
"label" : "list_id" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 127
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | null | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListFilter.created_by" ,
"type" : "CompoundType" ,
"label" : "created_by" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 128
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | null | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListFilter.type" ,
"type" : "CompoundType" ,
"label" : "type" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 129
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | null | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListFilter.tags" ,
"type" : "CompoundType" ,
"label" : "tags" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 130
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | null | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 125
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.ExceptionListIdentifiers" ,
"type" : "Interface" ,
"label" : "ExceptionListIdentifiers" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListIdentifiers.id" ,
"type" : "string" ,
"label" : "id" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 63
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListIdentifiers.listId" ,
"type" : "string" ,
"label" : "listId" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 64
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListIdentifiers.namespaceType" ,
"type" : "CompoundType" ,
"label" : "namespaceType" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 65
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"single\" | \"agnostic\""
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ExceptionListIdentifiers.type" ,
"type" : "CompoundType" ,
"label" : "type" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"endpoint\" | \"detection\""
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 62
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.Pagination" ,
"type" : "Interface" ,
"label" : "Pagination" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.Pagination.page" ,
"type" : "number" ,
"label" : "page" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.Pagination.perPage" ,
"type" : "number" ,
"label" : "perPage" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.Pagination.total" ,
"type" : "number" ,
"label" : "total" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"number | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.UseExceptionListItemsSuccess" ,
"type" : "Interface" ,
"label" : "UseExceptionListItemsSuccess" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.UseExceptionListItemsSuccess.exceptions" ,
"type" : "Array" ,
"label" : "exceptions" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 46
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.UseExceptionListItemsSuccess.pagination" ,
"type" : "Object" ,
"label" : "pagination" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 47
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.Pagination" ,
"text" : "Pagination"
}
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 45
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.UseExceptionListsSuccess" ,
"type" : "Interface" ,
"label" : "UseExceptionListsSuccess" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.UseExceptionListsSuccess.exceptions" ,
"type" : "Array" ,
"label" : "exceptions" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 121
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.UseExceptionListsSuccess.pagination" ,
"type" : "Object" ,
"label" : "pagination" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 122
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.Pagination" ,
"text" : "Pagination"
}
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/public/exceptions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 120
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-public.PluginSetup" ,
"type" : "Interface" ,
"label" : "PluginSetup" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 9
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/lists/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 11
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.ExceptionListClient" ,
2021-03-03 04:02:17 +01:00
"type" : "Class" ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ExceptionListClient" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.Unnamed" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{ user, savedObjectsClient }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.ConstructorOptions" ,
"text" : "ConstructorOptions"
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.getExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n listId,\n id,\n namespaceType,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.GetExceptionListOptions" ,
"text" : "GetExceptionListOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 66
}
}
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({ listId, id, namespaceType, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.GetExceptionListOptions" ,
"text" : "GetExceptionListOptions"
} ,
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getExceptionList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.getExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n itemId,\n id,\n namespaceType,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.GetExceptionListItemOptions" ,
"text" : "GetExceptionListItemOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 75
}
}
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({ itemId, id, namespaceType, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.GetExceptionListItemOptions" ,
"text" : "GetExceptionListItemOptions"
} ,
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.createEndpointList" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>"
] ,
"description" : [
"\nThis creates an agnostic space endpoint list if it does not exist. This tries to be\nas fast as possible by ignoring conflict errors and not returning the contents of the\nlist if it already exists."
] ,
"label" : "createEndpointList" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 90
} ,
"tags" : [ ] ,
"returnComment" : [
"ExceptionListSchema if it created the endpoint list, otherwise null if it already exists"
]
} ,
{
"id" : "def-server.ExceptionListClient.createTrustedAppsList" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>"
] ,
"description" : [
"\nCreate the Trusted Apps Agnostic list if it does not yet exist (`null` is returned if it does exist)"
] ,
"label" : "createTrustedAppsList" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 102
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ExceptionListClient.createEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n comments,\n description,\n entries,\n itemId,\n meta,\n name,\n osTypes,\n tags,\n type,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateEndpointListItemOptions" ,
"text" : "CreateEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 116
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ comments, description, entries, itemId, meta, name, osTypes, tags, type, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateEndpointListItemOptions" ,
"text" : "CreateEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nThis is the same as \"createListItem\" except it applies specifically to the agnostic endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the agnostic endpoint\nbeing there and existing before the item is inserted into the agnostic endpoint list."
] ,
"label" : "createEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 116
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.updateEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n _version,\n comments,\n description,\n entries,\n id,\n itemId,\n meta,\n name,\n osTypes,\n tags,\n type,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.UpdateEndpointListItemOptions" ,
"text" : "UpdateEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 152
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ _version, comments, description, entries, id, itemId, meta, name, osTypes, tags, type, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.UpdateEndpointListItemOptions" ,
"text" : "UpdateEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nThis is the same as \"updateExceptionListItem\" except it applies specifically to the endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the endpoint\nbeing there if it did not exist before. If the list did not exist before, then creating it here will still cause a\nreturn of null but at least the list exists again."
] ,
"label" : "updateEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 152
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.getEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n itemId,\n id,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetEndpointListItemOptions" ,
"text" : "GetEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 188
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ itemId, id, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetEndpointListItemOptions" ,
"text" : "GetEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nThis is the same as \"getExceptionListItem\" except it applies specifically to the endpoint list."
] ,
"label" : "getEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 188
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.createExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n description,\n immutable,\n listId,\n meta,\n name,\n namespaceType,\n tags,\n type,\n version,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.CreateExceptionListOptions" ,
"text" : "CreateExceptionListOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 196
}
}
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ description, immutable, listId, meta, name, namespaceType, tags, type, version, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.CreateExceptionListOptions" ,
"text" : "CreateExceptionListOptions"
} ,
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "createExceptionList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 196
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.updateExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n _version,\n id,\n description,\n listId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n version,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.UpdateExceptionListOptions" ,
"text" : "UpdateExceptionListOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 223
}
}
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ _version, id, description, listId, meta, name, namespaceType, osTypes, tags, type, version, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.UpdateExceptionListOptions" ,
"text" : "UpdateExceptionListOptions"
} ,
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "updateExceptionList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 223
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.deleteExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n id,\n listId,\n namespaceType,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteExceptionListOptions" ,
"text" : "DeleteExceptionListOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 254
}
}
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id, listId, namespaceType, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteExceptionListOptions" ,
"text" : "DeleteExceptionListOptions"
} ,
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteExceptionList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 254
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.createExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n comments,\n description,\n entries,\n itemId,\n listId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.CreateExceptionListItemOptions" ,
"text" : "CreateExceptionListItemOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 268
}
}
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ comments, description, entries, itemId, listId, meta, name, namespaceType, osTypes, tags, type, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.CreateExceptionListItemOptions" ,
"text" : "CreateExceptionListItemOptions"
} ,
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "createExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 268
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.updateExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n _version,\n comments,\n description,\n entries,\n id,\n itemId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.UpdateExceptionListItemOptions" ,
"text" : "UpdateExceptionListItemOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 299
}
}
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ _version, comments, description, entries, id, itemId, meta, name, namespaceType, osTypes, tags, type, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.UpdateExceptionListItemOptions" ,
"text" : "UpdateExceptionListItemOptions"
} ,
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "updateExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 299
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.deleteExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n id,\n itemId,\n namespaceType,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteExceptionListItemOptions" ,
"text" : "DeleteExceptionListItemOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 332
}
}
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id, itemId, namespaceType, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteExceptionListItemOptions" ,
"text" : "DeleteExceptionListItemOptions"
} ,
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 332
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.deleteExceptionListItemById" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n id,\n namespaceType,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteExceptionListItemByIdOptions" ,
"text" : "DeleteExceptionListItemByIdOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 346
}
}
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id, namespaceType, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteExceptionListItemByIdOptions" ,
"text" : "DeleteExceptionListItemByIdOptions"
} ,
") => Promise<void>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteExceptionListItemById" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 346
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.deleteEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n id,\n itemId,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteEndpointListItemOptions" ,
"text" : "DeleteEndpointListItemOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 361
}
}
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id, itemId, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.DeleteEndpointListItemOptions" ,
"text" : "DeleteEndpointListItemOptions"
} ,
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nThis is the same as \"deleteExceptionListItem\" except it applies specifically to the endpoint list."
] ,
"label" : "deleteEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 361
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [
{
"type" : "Object" ,
"label" : "{\n listId,\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n namespaceType,\n }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.FindExceptionListItemOptions" ,
"text" : "FindExceptionListItemOptions"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 374
}
}
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.FindExceptionListItemOptions" ,
"text" : "FindExceptionListItemOptions"
} ,
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "findExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 374
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findExceptionListsItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n listId,\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n namespaceType,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindExceptionListsItemOptions" ,
"text" : "FindExceptionListsItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 396
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindExceptionListsItemOptions" ,
"text" : "FindExceptionListsItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "findExceptionListsItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 396
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findValueListExceptionListItems" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n perPage,\n page,\n sortField,\n sortOrder,\n valueListId,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindValueListExceptionListsItems" ,
"text" : "FindValueListExceptionListsItems"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 418
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ perPage, page, sortField, sortOrder, valueListId, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindValueListExceptionListsItems" ,
"text" : "FindValueListExceptionListsItems"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "findValueListExceptionListItems" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 418
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n namespaceType,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindExceptionListOptions" ,
"text" : "FindExceptionListOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 436
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ filter, perPage, page, sortField, sortOrder, namespaceType, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindExceptionListOptions" ,
"text" : "FindExceptionListOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ data: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "findExceptionList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 436
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindEndpointListItemOptions" ,
"text" : "FindEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 464
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ filter, perPage, page, sortField, sortOrder, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindEndpointListItemOptions" ,
"text" : "FindEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nThis is the same as \"findExceptionList\" except it applies specifically to the endpoint list and will\nauto-call the \"createEndpointList\" for you so that you have the best chance of the endpoint\nbeing there if it did not exist before. If the list did not exist before, then creating it here should give you\na good guarantee that you will get an empty record set rather than null. I keep the null as the return value in\nthe off chance that you still might somehow not get into a race condition where the endpoint list does\nnot exist because someone deleted it in-between the initial create and then the find."
] ,
"label" : "findEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 464
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
2021-03-06 02:12:28 +01:00
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
"lineNumber" : 56
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.ListClient" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "ListClient" ,
"description" : [ ] ,
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.Unnamed" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{ spaceId, user, config, callCluster }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.ConstructorOptions" ,
"text" : "ConstructorOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 85
2021-03-03 04:02:17 +01:00
}
}
] ,
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 85
}
} ,
{
"id" : "def-server.ListClient.getListIndex" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => string"
] ,
"description" : [ ] ,
"label" : "getListIndex" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 92
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.getListItemIndex" ,
"type" : "Function" ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => string"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getListItemIndex" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 100
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListOptions" ,
"text" : "GetListOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 108
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListOptions" ,
"text" : "GetListOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getList" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 108
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n id,\n deserializer,\n immutable,\n serializer,\n name,\n description,\n type,\n meta,\n version,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateListOptions" ,
"text" : "CreateListOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 114
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateListOptions" ,
"text" : "CreateListOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "createList" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 114
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createListIfItDoesNotExist" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n id,\n deserializer,\n serializer,\n name,\n description,\n immutable,\n type,\n meta,\n version,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateListIfItDoesNotExistOptions" ,
"text" : "CreateListIfItDoesNotExistOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 143
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateListIfItDoesNotExistOptions" ,
"text" : "CreateListIfItDoesNotExistOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "createListIfItDoesNotExist" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 143
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListIndexExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
"signature" : [
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "getListIndexExists" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 172
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.getListItemIndexExists" ,
"type" : "Function" ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getListItemIndexExists" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 178
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createListBootStrapIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
"signature" : [
"() => Promise<unknown>"
] ,
"description" : [ ] ,
"label" : "createListBootStrapIndex" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 184
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.createListItemBootStrapIndex" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "createListItemBootStrapIndex" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 190
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.getListPolicyExists" ,
"type" : "Function" ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getListPolicyExists" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 196
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemPolicyExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
"signature" : [
"() => Promise<boolean>"
] ,
"description" : [ ] ,
"label" : "getListItemPolicyExists" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 202
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.getListTemplateExists" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "getListTemplateExists" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 208
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.getListItemTemplateExists" ,
"type" : "Function" ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<boolean>"
] ,
"description" : [ ] ,
"label" : "getListItemTemplateExists" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 214
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.getListTemplate" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => Record<string, unknown>"
] ,
"description" : [ ] ,
"label" : "getListTemplate" ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 220
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
"id" : "def-server.ListClient.getListItemTemplate" ,
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
"() => Record<string, unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getListItemTemplate" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 225
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.setListTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "setListTemplate" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 230
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.setListItemTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "setListItemTemplate" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 237
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.setListPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "setListPolicy" ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 244
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
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.ListClient.setListItemPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "setListItemPolicy" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 250
} ,
"tags" : [ ] ,
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteListIndex" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 256
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteListItemIndex" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 262
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "deleteListPolicy" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 268
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [ ] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "deleteListItemPolicy" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 274
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "deleteListTemplate" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 280
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "deleteListItemTemplate" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 286
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.DeleteListItemOptions" ,
"text" : "DeleteListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 292
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.DeleteListItemOptions" ,
"text" : "DeleteListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "deleteListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 292
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemByValue" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n listId,\n value,\n type,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.DeleteListItemByValueOptions" ,
"text" : "DeleteListItemByValueOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 298
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ listId, value, type, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.DeleteListItemByValueOptions" ,
"text" : "DeleteListItemByValueOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteListItemByValue" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 298
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.DeleteListOptions" ,
"text" : "DeleteListOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 314
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.DeleteListOptions" ,
"text" : "DeleteListOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "deleteList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 314
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.exportListItemsToStream" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n stringToAppend,\n listId,\n stream,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.ExportListItemsToStreamOptions" ,
"text" : "ExportListItemsToStreamOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 326
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ stringToAppend, listId, stream, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.ExportListItemsToStreamOptions" ,
"text" : "ExportListItemsToStreamOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => void"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "exportListItemsToStream" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 326
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.importListItemsToStream" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n deserializer,\n serializer,\n type,\n listId,\n stream,\n meta,\n version,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.ImportListItemsToStreamOptions" ,
"text" : "ImportListItemsToStreamOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 342
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ deserializer, serializer, type, listId, stream, meta, version, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.ImportListItemsToStreamOptions" ,
"text" : "ImportListItemsToStreamOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "importListItemsToStream" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 342
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemByValue" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n listId,\n value,\n type,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListItemByValueOptions" ,
"text" : "GetListItemByValueOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 370
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ listId, value, type, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListItemByValueOptions" ,
"text" : "GetListItemByValueOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getListItemByValue" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 370
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n id,\n deserializer,\n serializer,\n listId,\n value,\n type,\n meta,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateListItemOptions" ,
"text" : "CreateListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 386
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id, deserializer, serializer, listId, value, type, meta, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.CreateListItemOptions" ,
"text" : "CreateListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "createListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 386
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.updateListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n _version,\n id,\n value,\n meta,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.UpdateListItemOptions" ,
"text" : "UpdateListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 411
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ _version, id, value, meta, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.UpdateListItemOptions" ,
"text" : "UpdateListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "updateListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 411
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.updateList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n _version,\n id,\n name,\n description,\n meta,\n version,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.UpdateListOptions" ,
"text" : "UpdateListOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 430
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ _version, id, name, description, meta, version, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.UpdateListOptions" ,
"text" : "UpdateListOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "updateList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 430
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListItemOptions" ,
"text" : "GetListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 453
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ id }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListItemOptions" ,
"text" : "GetListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 453
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemByValues" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n type,\n listId,\n value,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListItemsByValueOptions" ,
"text" : "GetListItemsByValueOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 463
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ type, listId, value, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.GetListItemsByValueOptions" ,
"text" : "GetListItemsByValueOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "getListItemByValues" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 463
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.searchListItemByValues" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n type,\n listId,\n value,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.SearchListItemByValuesOptions" ,
"text" : "SearchListItemByValuesOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 479
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ type, listId, value, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.SearchListItemByValuesOptions" ,
"text" : "SearchListItemByValuesOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "searchListItemByValues" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 479
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.findList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n filter,\n currentIndexPosition,\n perPage,\n page,\n sortField,\n sortOrder,\n searchAfter,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindListOptions" ,
"text" : "FindListOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 495
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindListOptions" ,
"text" : "FindListOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "findList" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 495
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.findListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"children" : [
{
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "{\n listId,\n filter,\n currentIndexPosition,\n perPage,\n page,\n sortField,\n sortOrder,\n searchAfter,\n }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindListItemOptions" ,
"text" : "FindListItemOptions"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 519
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.FindListItemOptions" ,
"text" : "FindListItemOptions"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
"label" : "findListItem" ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 519
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
"lineNumber" : 79
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"functions" : [ ] ,
"interfaces" : [
{
"id" : "def-server.CreateExceptionListItemOptions" ,
"type" : "Interface" ,
"label" : "CreateExceptionListItemOptions" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.comments" ,
"type" : "Array" ,
"label" : "comments" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 118
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ comment: string; }[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.entries" ,
"type" : "Array" ,
"label" : "entries" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 119
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.itemId" ,
"type" : "string" ,
"label" : "itemId" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 120
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.listId" ,
"type" : "string" ,
"label" : "listId" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 121
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.namespaceType" ,
"type" : "CompoundType" ,
"label" : "namespaceType" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 122
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"single\" | \"agnostic\""
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.name" ,
"type" : "string" ,
"label" : "name" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 123
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.osTypes" ,
"type" : "Array" ,
"label" : "osTypes" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 124
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(\"windows\" | \"linux\" | \"macos\")[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.description" ,
"type" : "string" ,
"label" : "description" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 125
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.meta" ,
"type" : "Uncategorized" ,
"label" : "meta" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 126
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"object | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.tags" ,
"type" : "Array" ,
"label" : "tags" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 127
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.CreateExceptionListItemOptions.type" ,
"type" : "string" ,
"label" : "type" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 128
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"simple\""
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 117
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.ListPluginSetup" ,
"type" : "Interface" ,
"label" : "ListPluginSetup" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.ListPluginSetup.getExceptionListClient" ,
"type" : "Function" ,
"label" : "getExceptionListClient" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 41
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.GetExceptionListClientType" ,
"text" : "GetExceptionListClientType"
}
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.ListPluginSetup.getListClient" ,
"type" : "Function" ,
"label" : "getListClient" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 42
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.GetListClientType" ,
"text" : "GetListClientType"
}
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 40
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.ListsApiRequestHandlerContext" ,
"type" : "Interface" ,
"label" : "ListsApiRequestHandlerContext" ,
"description" : [ ] ,
"tags" : [
"public"
] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.ListsApiRequestHandlerContext.getListClient" ,
"type" : "Function" ,
"label" : "getListClient" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"() => " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.ListClient" ,
"text" : "ListClient"
}
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.ListsApiRequestHandlerContext.getExceptionListClient" ,
"type" : "Function" ,
"label" : "getExceptionListClient" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 50
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"() => " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.ExceptionListClient" ,
"text" : "ExceptionListClient"
}
]
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 48
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
2021-03-10 20:21:39 +01:00
"functions" : [
{
"id" : "def-common.buildExceptionFilter" ,
"type" : "Function" ,
"children" : [
{
"id" : "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}" ,
"type" : "Object" ,
"label" : "{\n lists,\n excludeExceptions,\n chunkSize,\n}" ,
"tags" : [ ] ,
"description" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}.lists" ,
"type" : "Array" ,
"label" : "lists" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/exceptions/build_exceptions_filter.ts" ,
"lineNumber" : 74
} ,
"signature" : [
"(({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}.excludeExceptions" ,
"type" : "boolean" ,
"label" : "excludeExceptions" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/exceptions/build_exceptions_filter.ts" ,
"lineNumber" : 75
}
} ,
{
"tags" : [ ] ,
"id" : "def-common.buildExceptionFilter.{\n- lists,\n excludeExceptions,\n chunkSize,\n}.chunkSize" ,
"type" : "number" ,
"label" : "chunkSize" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/exceptions/build_exceptions_filter.ts" ,
"lineNumber" : 76
}
}
] ,
"source" : {
"path" : "x-pack/plugins/lists/common/exceptions/build_exceptions_filter.ts" ,
"lineNumber" : 73
}
}
] ,
"signature" : [
"({ lists, excludeExceptions, chunkSize, }: { lists: (({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]; excludeExceptions: boolean; chunkSize: number; }) => " ,
{
"pluginId" : "data" ,
"scope" : "common" ,
"docId" : "kibDataPluginApi" ,
"section" : "def-common.Filter" ,
"text" : "Filter"
} ,
" | undefined"
] ,
"description" : [ ] ,
"label" : "buildExceptionFilter" ,
"source" : {
"path" : "x-pack/plugins/lists/common/exceptions/build_exceptions_filter.ts" ,
"lineNumber" : 69
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
2021-03-03 04:02:17 +01:00
"interfaces" : [ ] ,
"enums" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.ExceptionListTypeEnum" ,
2021-03-03 04:02:17 +01:00
"type" : "Enum" ,
2021-03-06 02:12:28 +01:00
"label" : "ExceptionListTypeEnum" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 219
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.OperatorEnum" ,
2021-03-03 04:02:17 +01:00
"type" : "Enum" ,
2021-03-06 02:12:28 +01:00
"label" : "OperatorEnum" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 276
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.OperatorTypeEnum" ,
2021-03-03 04:02:17 +01:00
"type" : "Enum" ,
2021-03-06 02:12:28 +01:00
"label" : "OperatorTypeEnum" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 281
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"misc" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.Comment" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "Comment" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/comment.ts" ,
"lineNumber" : 32
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.CommentsArray" ,
"type" : "Type" ,
"label" : "CommentsArray" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/types/comment.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]"
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.CreateComment" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "CreateComment" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/types/create_comment.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 18
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ comment: string; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.CreateCommentsArray" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "CreateCommentsArray" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/create_comment.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ comment: string; }[]"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.CreateExceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "CreateExceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.ts" ,
"lineNumber" : 55
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.CreateExceptionListSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "CreateExceptionListSchema" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.ts" ,
"lineNumber" : 50
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ description: string; name: string; type: \"endpoint\" | \"detection\"; } & { list_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; version?: number | undefined; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.ENDPOINT_LIST_ID" ,
"type" : "string" ,
"label" : "ENDPOINT_LIST_ID" ,
"description" : [
"\nThis ID is used for _both_ the Saved Object ID and for the list_id\nfor the single global space agnostic endpoint list"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/constants.ts" ,
"lineNumber" : 45
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"endpoint_list\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.ENDPOINT_TRUSTED_APPS_LIST_ID" ,
"type" : "string" ,
"label" : "ENDPOINT_TRUSTED_APPS_LIST_ID" ,
"description" : [
"ID of trusted apps agnostic list"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/constants.ts" ,
"lineNumber" : 56
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"endpoint_trusted_apps\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.EntriesArray" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "EntriesArray" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entries.ts" ,
"lineNumber" : 22
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.Entry" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "Entry" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entries.ts" ,
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.EntryExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "EntryExists" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entry_exists.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.EntryList" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "EntryList" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entry_list.ts" ,
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.EntryMatch" ,
"type" : "Type" ,
"label" : "EntryMatch" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/types/entry_match.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; }"
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.EntryMatchAny" ,
"type" : "Type" ,
"label" : "EntryMatchAny" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/types/entry_match_any.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 23
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; }"
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.EntryNested" ,
"type" : "Type" ,
"label" : "EntryNested" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/types/entry_nested.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; }"
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.ExceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "ExceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.ts" ,
"lineNumber" : 53
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.ExceptionListSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "ExceptionListSchema" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/response/exception_list_schema.ts" ,
"lineNumber" : 52
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\"; updated_at: string; updated_by: string; version: number; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.ExceptionListType" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "ExceptionListType" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
"lineNumber" : 217
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"endpoint\" | \"detection\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.ListSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "ListSchema" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/response/list_schema.ts" ,
"lineNumber" : 48
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.NamespaceType" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "NamespaceType" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/default_namespace.ts" ,
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"single\" | \"agnostic\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.NestedEntriesArray" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "NestedEntriesArray" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.ts" ,
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.Operator" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "Operator" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 275
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"excluded\" | \"included\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.OsTypeArray" ,
"type" : "Type" ,
"label" : "OsTypeArray" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 325
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(\"windows\" | \"linux\" | \"macos\")[]"
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.Type" ,
"type" : "Type" ,
"label" : "Type" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
"lineNumber" : 123
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.UpdateExceptionListItemSchema" ,
"type" : "Type" ,
"label" : "UpdateExceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.ts" ,
"lineNumber" : 55
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"long\" | \"double\" | \"date_nanos\" | \"geo_point\" | \"geo_shape\" | \"short\" | \"binary\" | \"date_range\" | \"ip_range\" | \"shape\" | \"integer\" | \"byte\" | \"float\" | \"double_range\" | \"float_range\" | \"half_float\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
}
] ,
"objects" : [
{
"tags" : [ ] ,
"id" : "def-common.comment" ,
"type" : "Object" ,
"label" : "comment" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/types/comment.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"IntersectionC" ,
"<[" ,
"ExactC" ,
"<" ,
"TypeC" ,
"<{ comment: " ,
"Type" ,
"<string, string, unknown>; created_at: " ,
"StringC"
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.createExceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "createExceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.ts" ,
"lineNumber" : 33
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"IntersectionC" ,
"<[" ,
2021-03-03 04:02:17 +01:00
"ExactC" ,
"<" ,
"TypeC" ,
2021-03-06 02:12:28 +01:00
"<{ description: " ,
2021-03-03 04:02:17 +01:00
"StringC" ,
2021-03-06 02:12:28 +01:00
"; entries: " ,
"Type"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.entriesExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "entriesExists" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entry_exists.ts" ,
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"ExactC" ,
"<" ,
"TypeC" ,
"<{ field: " ,
"Type" ,
"<string, string, unknown>; operator: " ,
2021-03-03 04:02:17 +01:00
"KeyofC" ,
2021-03-06 02:12:28 +01:00
"<{ excluded: null; included: null; }>; type: " ,
"KeyofC"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.entriesList" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "entriesList" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entry_list.ts" ,
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"ExactC" ,
"<" ,
"TypeC" ,
2021-03-06 02:12:28 +01:00
"<{ field: " ,
"Type" ,
"<string, string, unknown>; list: " ,
"ExactC" ,
"<" ,
"TypeC"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.entriesMatch" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "entriesMatch" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entry_match.ts" ,
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"ExactC" ,
"<" ,
"TypeC" ,
2021-03-06 02:12:28 +01:00
"<{ field: " ,
"Type" ,
"<string, string, unknown>; operator: " ,
"KeyofC" ,
"<{ excluded: null; included: null; }>; type: " ,
"KeyofC"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.entriesMatchAny" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "entriesMatchAny" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entry_match_any.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"ExactC" ,
"<" ,
"TypeC" ,
"<{ field: " ,
"Type" ,
"<string, string, unknown>; operator: " ,
2021-03-06 02:12:28 +01:00
"KeyofC" ,
"<{ excluded: null; included: null; }>; type: " ,
2021-03-03 04:02:17 +01:00
"KeyofC"
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
"id" : "def-common.entriesNested" ,
"type" : "Object" ,
"label" : "entriesNested" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/types/entry_nested.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"ExactC" ,
"<" ,
"TypeC" ,
"<{ entries: " ,
"Type" ,
"<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[], unknown>; field: " ,
"Type" ,
"<string, string, unknown>; type: " ,
"KeyofC"
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.entry" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "entry" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/entries.ts" ,
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"UnionC" ,
"<[" ,
"ExactC" ,
"<" ,
"TypeC" ,
"<{ field: " ,
"Type" ,
"<string, string, unknown>; operator: " ,
"KeyofC"
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.exceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "exceptionListItemSchema" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.ts" ,
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"ExactC" ,
"<" ,
"TypeC" ,
2021-03-06 02:12:28 +01:00
"<{ _version: " ,
"UnionC" ,
"<[" ,
"StringC" ,
", " ,
"UndefinedC"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.exceptionListType" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "exceptionListType" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
"lineNumber" : 215
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"KeyofC" ,
2021-03-06 02:12:28 +01:00
"<{ detection: null; endpoint: null; }>"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.listSchema" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "listSchema" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/response/list_schema.ts" ,
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"ExactC" ,
"<" ,
"TypeC" ,
2021-03-06 02:12:28 +01:00
"<{ _version: " ,
"UnionC" ,
"<[" ,
"StringC" ,
", " ,
"UndefinedC"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.namespaceType" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "namespaceType" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/default_namespace.ts" ,
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"KeyofC" ,
"<{ agnostic: null; single: null; }>"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.nestedEntryItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "nestedEntryItem" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"UnionC" ,
"<[" ,
"ExactC" ,
"<" ,
"TypeC" ,
"<{ field: " ,
"Type" ,
"<string, string, unknown>; operator: " ,
"KeyofC"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
"id" : "def-common.osTypeArray" ,
"type" : "Object" ,
"label" : "osTypeArray" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/lists/common/schemas/common/schemas.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 324
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Type" ,
"<(\"windows\" | \"linux\" | \"macos\")[], (\"windows\" | \"linux\" | \"macos\")[] | undefined, unknown>"
] ,
"initialIsOpen" : false
}
]
}
}