2021-03-03 04:02:17 +01:00
{
"id" : "lists" ,
"client" : {
"classes" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"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"
} ,
", " ,
2021-06-07 23:55:35 +02:00
"SetupPlugins" ,
", " ,
"StartPlugins" ,
">"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Plugin.Unnamed" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "Constructor" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"any"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Plugin.Unnamed.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "initializerContext" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.PluginInitializerContext" ,
"text" : "PluginInitializerContext"
} ,
"<object>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Plugin.setup" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "setup" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
2021-04-15 17:36:10 +02:00
"StartPlugins" ,
2021-03-03 04:02:17 +01:00
", " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginStart" ,
"text" : "PluginStart"
} ,
">, plugins: " ,
2021-04-15 17:36:10 +02:00
"SetupPlugins" ,
2021-03-03 04:02:17 +01:00
") => " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginSetup" ,
"text" : "PluginSetup"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Plugin.setup.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "core" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
2021-04-15 17:36:10 +02:00
"StartPlugins" ,
2021-03-03 04:02:17 +01:00
", " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginStart" ,
"text" : "PluginStart"
} ,
">"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Plugin.setup.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "plugins" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"SetupPlugins"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.Plugin.start" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "start" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreStart" ,
"text" : "CoreStart"
} ,
", plugins: " ,
2021-04-15 17:36:10 +02:00
"StartPlugins" ,
2021-03-03 04:02:17 +01:00
") => " ,
{
"pluginId" : "lists" ,
"scope" : "public" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-public.PluginStart" ,
"text" : "PluginStart"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Plugin.start.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "core" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreStart" ,
"text" : "CoreStart"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.Plugin.start.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "plugins" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"StartPlugins"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/plugin.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
2021-05-27 11:30:15 +02:00
"functions" : [ ] ,
"interfaces" : [ ] ,
2021-03-03 04:02:17 +01:00
"enums" : [ ] ,
"misc" : [ ] ,
2021-04-15 17:36:10 +02:00
"objects" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.ExceptionBuilder" ,
"type" : "Object" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "ExceptionBuilder" ,
2021-04-15 17:36:10 +02:00
"description" : [ ] ,
"signature" : [
"typeof " ,
"x-pack/plugins/lists/public/exceptions/components/builder/index"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/shared_exports.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-04-15 17:36:10 +02:00
"initialIsOpen" : false
}
] ,
2021-03-03 04:02:17 +01:00
"setup" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.PluginSetup" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "PluginSetup" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.PluginStart" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "PluginStart" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/public/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
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" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.Unnamed" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "Constructor" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"any"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.Unnamed.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{ user, savedObjectsClient }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ConstructorOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.getExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getExceptionList" ,
"description" : [ ] ,
"signature" : [
"({ listId, id, namespaceType, }: " ,
"GetExceptionListOptions" ,
2021-06-07 23:55:35 +02:00
") => 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\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.getExceptionList.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n listId,\n id,\n namespaceType,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"GetExceptionListOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-06-07 21:02:57 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.getExceptionListSummary" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getExceptionListSummary" ,
"description" : [ ] ,
"signature" : [
"({ listId, id, namespaceType, }: " ,
"GetExceptionListSummaryOptions" ,
2021-06-07 23:55:35 +02:00
") => Promise<{ windows: number; linux: number; macos: number; total: number; } | null>"
2021-06-07 21:02:57 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-06-07 21:02:57 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.getExceptionListSummary.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{\n listId,\n id,\n namespaceType,\n }" ,
"description" : [ ] ,
"signature" : [
"GetExceptionListSummaryOptions"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.getExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getExceptionListItem" ,
"description" : [ ] ,
"signature" : [
"({ itemId, id, namespaceType, }: " ,
"GetExceptionListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.getExceptionListItem.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n itemId,\n id,\n namespaceType,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"GetExceptionListItemOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.createEndpointList" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createEndpointList" ,
2021-03-06 02:12:28 +01:00
"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."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"() => 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\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [
"ExceptionListSchema if it created the endpoint list, otherwise null if it already exists"
]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.createTrustedAppsList" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createTrustedAppsList" ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nCreate the Trusted Apps Agnostic list if it does not yet exist (`null` is returned if it does exist)"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"() => 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\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.createEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createEndpointListItem" ,
"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."
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-04-15 17:36:10 +02:00
"CreateEndpointListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.createEndpointListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "{\n comments,\n description,\n entries,\n itemId,\n meta,\n name,\n osTypes,\n tags,\n type,\n }" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"CreateEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.updateEndpointListItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "updateEndpointListItem" ,
"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."
] ,
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-04-15 17:36:10 +02:00
"UpdateEndpointListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.updateEndpointListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "{\n _version,\n comments,\n description,\n entries,\n id,\n itemId,\n meta,\n name,\n osTypes,\n tags,\n type,\n }" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"UpdateEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.getEndpointListItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getEndpointListItem" ,
"description" : [
"\nThis is the same as \"getExceptionListItem\" except it applies specifically to the endpoint list."
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
"({ itemId, id, }: " ,
2021-04-15 17:36:10 +02:00
"GetEndpointListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.getEndpointListItem.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "{\n itemId,\n id,\n }" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"GetEndpointListItemOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.createExceptionList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "createExceptionList" ,
"description" : [ ] ,
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, }: " ,
2021-04-15 17:36:10 +02:00
"CreateExceptionListOptions" ,
2021-06-07 23:55:35 +02:00
") => 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\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.createExceptionList.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{\n description,\n immutable,\n listId,\n meta,\n name,\n namespaceType,\n tags,\n type,\n version,\n }" ,
"description" : [ ] ,
"signature" : [
"CreateExceptionListOptions"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.updateExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "updateExceptionList" ,
"description" : [ ] ,
"signature" : [
"({ _version, id, description, listId, meta, name, namespaceType, osTypes, tags, type, version, }: " ,
"UpdateExceptionListOptions" ,
2021-06-07 23:55:35 +02:00
") => 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\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.updateExceptionList.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n _version,\n id,\n description,\n listId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n version,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"UpdateExceptionListOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.deleteExceptionList" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "deleteExceptionList" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"({ id, listId, namespaceType, }: " ,
"DeleteExceptionListOptions" ,
2021-06-07 23:55:35 +02:00
") => 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\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.deleteExceptionList.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n id,\n listId,\n namespaceType,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"DeleteExceptionListOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
2021-03-03 04:02:17 +01:00
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.createExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createExceptionListItem" ,
"description" : [ ] ,
"signature" : [
"({ comments, description, entries, itemId, listId, meta, name, namespaceType, osTypes, tags, type, }: " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.CreateExceptionListItemOptions" ,
"text" : "CreateExceptionListItemOptions"
} ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.createExceptionListItem.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n comments,\n description,\n entries,\n itemId,\n listId,\n meta,\n name,\n namespaceType,\n osTypes,\n tags,\n type,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.CreateExceptionListItemOptions" ,
"text" : "CreateExceptionListItemOptions"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.updateExceptionListItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "updateExceptionListItem" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"({ _version, comments, description, entries, id, itemId, meta, name, namespaceType, osTypes, tags, type, }: " ,
2021-03-06 02:12:28 +01:00
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
2021-05-06 21:29:47 +02:00
"section" : "def-server.UpdateExceptionListItemOptions" ,
"text" : "UpdateExceptionListItemOptions"
2021-03-06 02:12:28 +01:00
} ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.updateExceptionListItem.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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 namespaceType,\n osTypes,\n tags,\n type,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.UpdateExceptionListItemOptions" ,
"text" : "UpdateExceptionListItemOptions"
}
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.deleteExceptionListItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "deleteExceptionListItem" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"({ id, itemId, namespaceType, }: " ,
"DeleteExceptionListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.deleteExceptionListItem.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n id,\n itemId,\n namespaceType,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"DeleteExceptionListItemOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
2021-03-03 04:02:17 +01:00
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.deleteExceptionListItemById" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteExceptionListItemById" ,
"description" : [ ] ,
"signature" : [
"({ id, namespaceType, }: " ,
"DeleteExceptionListItemByIdOptions" ,
") => Promise<void>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.deleteExceptionListItemById.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n id,\n namespaceType,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"DeleteExceptionListItemByIdOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.deleteEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteEndpointListItem" ,
"description" : [
"\nThis is the same as \"deleteExceptionListItem\" except it applies specifically to the endpoint list."
] ,
"signature" : [
"({ id, itemId, }: " ,
"DeleteEndpointListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.deleteEndpointListItem.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n id,\n itemId,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"DeleteEndpointListItemOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findExceptionListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "findExceptionListItem" ,
"description" : [ ] ,
"signature" : [
"({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: " ,
"FindExceptionListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.findExceptionListItem.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"FindExceptionListItemOptions"
2021-03-06 02:12:28 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 02:12:28 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.findExceptionListsItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "findExceptionListsItem" ,
"description" : [ ] ,
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-05-06 21:29:47 +02:00
"FindExceptionListsItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.findExceptionListsItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"FindExceptionListsItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ExceptionListClient.findValueListExceptionListItems" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "findValueListExceptionListItems" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"({ perPage, page, sortField, sortOrder, valueListId, }: " ,
"FindValueListExceptionListsItems" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.findValueListExceptionListItems.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n perPage,\n page,\n sortField,\n sortOrder,\n valueListId,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"FindValueListExceptionListsItems"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findExceptionList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "findExceptionList" ,
"description" : [ ] ,
"signature" : [
"({ filter, perPage, page, sortField, sortOrder, namespaceType, }: " ,
"FindExceptionListOptions" ,
2021-06-07 23:55:35 +02: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\" | \"endpoint_events\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.findExceptionList.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n namespaceType,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"FindExceptionListOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ExceptionListClient.findEndpointListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "findEndpointListItem" ,
"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."
] ,
"signature" : [
"({ filter, perPage, page, sortField, sortOrder, }: " ,
"FindEndpointListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; 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-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ExceptionListClient.findEndpointListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n filter,\n perPage,\n page,\n sortField,\n sortOrder,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"FindEndpointListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
2021-03-06 02:12:28 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "ListClient" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.Unnamed" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "Constructor" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"any"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.Unnamed.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-23 19:31:08 +01:00
"label" : "{ spaceId, user, config, esClient }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ConstructorOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListIndex" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListIndex" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => string"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemIndex" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItemIndex" ,
"description" : [ ] ,
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
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getList" ,
"description" : [ ] ,
"signature" : [
"({ id }: " ,
"GetListOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.getList.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"GetListOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createList" ,
"description" : [ ] ,
"signature" : [
"({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: " ,
"CreateListOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.createList.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"CreateListOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ListClient.createListIfItDoesNotExist" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "createListIfItDoesNotExist" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: " ,
"CreateListIfItDoesNotExistOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.createListIfItDoesNotExist.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"CreateListIfItDoesNotExistOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListIndexExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListIndexExists" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemIndexExists" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItemIndexExists" ,
"description" : [ ] ,
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
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createListBootStrapIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createListBootStrapIndex" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => Promise<unknown>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createListItemBootStrapIndex" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createListItemBootStrapIndex" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => Promise<unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListPolicyExists" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListPolicyExists" ,
"description" : [ ] ,
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
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemPolicyExists" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItemPolicyExists" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => Promise<boolean>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListTemplateExists" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListTemplateExists" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => Promise<boolean>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemTemplateExists" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItemTemplateExists" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<boolean>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListTemplate" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListTemplate" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => Record<string, unknown>"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemTemplate" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItemTemplate" ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"() => Record<string, unknown>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.setListTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "setListTemplate" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.setListItemTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "setListItemTemplate" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.setListPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "setListPolicy" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
2021-03-06 02:12:28 +01:00
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.setListItemPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "setListItemPolicy" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListIndex" ,
"description" : [ ] ,
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
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemIndex" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListItemIndex" ,
"description" : [ ] ,
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
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListPolicy" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemPolicy" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListItemPolicy" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListTemplate" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListItemTemplate" ,
"description" : [ ] ,
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-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListItem" ,
"description" : [ ] ,
"signature" : [
"({ id }: " ,
"DeleteListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.deleteListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"DeleteListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteListItemByValue" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteListItemByValue" ,
"description" : [ ] ,
"signature" : [
"({ listId, value, type, }: " ,
"DeleteListItemByValueOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.deleteListItemByValue.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n listId,\n value,\n type,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"DeleteListItemByValueOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.deleteList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "deleteList" ,
"description" : [ ] ,
"signature" : [
"({ id }: " ,
"DeleteListOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.deleteList.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"DeleteListOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.exportListItemsToStream" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "exportListItemsToStream" ,
"description" : [ ] ,
"signature" : [
"({ stringToAppend, listId, stream, }: " ,
"ExportListItemsToStreamOptions" ,
") => void"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.exportListItemsToStream.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n stringToAppend,\n listId,\n stream,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ExportListItemsToStreamOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.importListItemsToStream" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "importListItemsToStream" ,
"description" : [ ] ,
"signature" : [
"({ deserializer, serializer, type, listId, stream, meta, version, }: " ,
"ImportListItemsToStreamOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.importListItemsToStream.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"ImportListItemsToStreamOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemByValue" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItemByValue" ,
"description" : [ ] ,
"signature" : [
"({ listId, value, type, }: " ,
"GetListItemByValueOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.getListItemByValue.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n listId,\n value,\n type,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"GetListItemByValueOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.createListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "createListItem" ,
"description" : [ ] ,
"signature" : [
"({ id, deserializer, serializer, listId, value, type, meta, }: " ,
"CreateListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.createListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"CreateListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ListClient.updateListItem" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "updateListItem" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-06 21:29:47 +02:00
"({ _version, id, value, meta, }: " ,
"UpdateListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.updateListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n _version,\n id,\n value,\n meta,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"UpdateListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.updateList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "updateList" ,
"description" : [ ] ,
"signature" : [
"({ _version, id, name, description, meta, version, }: " ,
"UpdateListOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.updateList.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n _version,\n id,\n name,\n description,\n meta,\n version,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"UpdateListOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItem" ,
"description" : [ ] ,
"signature" : [
"({ id }: " ,
"GetListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.getListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{ id }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"GetListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.getListItemByValues" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "getListItemByValues" ,
"description" : [ ] ,
"signature" : [
"({ type, listId, value, }: " ,
"GetListItemsByValueOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.getListItemByValues.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n type,\n listId,\n value,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"GetListItemsByValueOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-06 21:29:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.ListClient.searchListItemByValues" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "searchListItemByValues" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({ type, listId, value, }: " ,
2021-05-06 21:29:47 +02:00
"SearchListItemByValuesOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.searchListItemByValues.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "{\n type,\n listId,\n value,\n }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"SearchListItemByValuesOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.findList" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "findList" ,
"description" : [ ] ,
"signature" : [
"({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: " ,
"FindListOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.findList.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"FindListOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ListClient.findListItem" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
"label" : "findListItem" ,
"description" : [ ] ,
"signature" : [
"({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: " ,
"FindListItemOptions" ,
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.ListClient.findListItem.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-04-15 17:36:10 +02:00
"FindListItemOptions"
2021-03-03 04:02:17 +01:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/lists/list_client.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
}
] ,
"functions" : [ ] ,
"interfaces" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "CreateExceptionListItemOptions" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.comments" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "comments" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"{ comment: string; }[]"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.entries" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "entries" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.itemId" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "itemId" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.listId" ,
2021-06-07 23:55:35 +02:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "listId" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.namespaceType" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "namespaceType" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"single\" | \"agnostic\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.name" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "name" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.osTypes" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "osTypes" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"(\"windows\" | \"linux\" | \"macos\")[]"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.description" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "description" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.meta" ,
"type" : "Uncategorized" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "meta" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"object | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.tags" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "tags" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string[]"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CreateExceptionListItemOptions.type" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "type" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"simple\""
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.ListPluginSetup" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "ListPluginSetup" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.ListPluginSetup.getExceptionListClient" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getExceptionListClient" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"(savedObjectsClient: Pick<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsClient" ,
"text" : "SavedObjectsClient"
} ,
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, user: string) => " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.ExceptionListClient" ,
"text" : "ExceptionListClient"
}
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "lists" ,
"id" : "def-server.savedObjectsClient" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "savedObjectsClient" ,
"description" : [ ] ,
"signature" : [
"{ get: <T = unknown>(type: string, id: string, options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBaseOptions" ,
"text" : "SavedObjectsBaseOptions"
} ,
") => Promise<" ,
"SavedObject" ,
"<T>>; delete: (type: string, id: string, options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsDeleteOptions" ,
"text" : "SavedObjectsDeleteOptions"
} ,
") => Promise<{}>; create: <T = unknown>(type: string, attributes: T, options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCreateOptions" ,
"text" : "SavedObjectsCreateOptions"
} ,
" | undefined) => Promise<" ,
"SavedObject" ,
"<T>>; bulkCreate: <T = unknown>(objects: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBulkCreateObject" ,
"text" : "SavedObjectsBulkCreateObject"
} ,
"<T>[], options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCreateOptions" ,
"text" : "SavedObjectsCreateOptions"
} ,
" | undefined) => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBulkResponse" ,
"text" : "SavedObjectsBulkResponse"
} ,
"<T>>; checkConflicts: (objects?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCheckConflictsObject" ,
"text" : "SavedObjectsCheckConflictsObject"
} ,
"[], options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBaseOptions" ,
"text" : "SavedObjectsBaseOptions"
} ,
") => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCheckConflictsResponse" ,
"text" : "SavedObjectsCheckConflictsResponse"
} ,
">; find: <T = unknown, A = unknown>(options: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsFindOptions" ,
"text" : "SavedObjectsFindOptions"
} ,
") => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsFindResponse" ,
"text" : "SavedObjectsFindResponse"
} ,
"<T, A>>; bulkGet: <T = unknown>(objects?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBulkGetObject" ,
"text" : "SavedObjectsBulkGetObject"
} ,
"[], options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBaseOptions" ,
"text" : "SavedObjectsBaseOptions"
} ,
") => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBulkResponse" ,
"text" : "SavedObjectsBulkResponse"
} ,
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBaseOptions" ,
"text" : "SavedObjectsBaseOptions"
} ,
") => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsResolveResponse" ,
"text" : "SavedObjectsResolveResponse"
} ,
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsUpdateOptions" ,
"text" : "SavedObjectsUpdateOptions"
} ,
"<T>) => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsUpdateResponse" ,
"text" : "SavedObjectsUpdateResponse"
} ,
"<T>>; collectMultiNamespaceReferences: (objects: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCollectMultiNamespaceReferencesObject" ,
"text" : "SavedObjectsCollectMultiNamespaceReferencesObject"
} ,
"[], options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions" ,
"text" : "SavedObjectsCollectMultiNamespaceReferencesOptions"
} ,
" | undefined) => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse" ,
"text" : "SavedObjectsCollectMultiNamespaceReferencesResponse"
} ,
">; updateObjectsSpaces: (objects: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsUpdateObjectsSpacesObject" ,
"text" : "SavedObjectsUpdateObjectsSpacesObject"
} ,
"[], spacesToAdd: string[], spacesToRemove: string[], options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsUpdateObjectsSpacesOptions" ,
"text" : "SavedObjectsUpdateObjectsSpacesOptions"
} ,
" | undefined) => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsUpdateObjectsSpacesResponse" ,
"text" : "SavedObjectsUpdateObjectsSpacesResponse"
} ,
">; bulkUpdate: <T = unknown>(objects: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBulkUpdateObject" ,
"text" : "SavedObjectsBulkUpdateObject"
} ,
"<T>[], options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBulkUpdateOptions" ,
"text" : "SavedObjectsBulkUpdateOptions"
} ,
" | undefined) => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBulkUpdateResponse" ,
"text" : "SavedObjectsBulkUpdateResponse"
} ,
"<T>>; removeReferencesTo: (type: string, id: string, options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsRemoveReferencesToOptions" ,
"text" : "SavedObjectsRemoveReferencesToOptions"
} ,
" | undefined) => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsRemoveReferencesToResponse" ,
"text" : "SavedObjectsRemoveReferencesToResponse"
} ,
">; openPointInTimeForType: (type: string | string[], options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsOpenPointInTimeOptions" ,
"text" : "SavedObjectsOpenPointInTimeOptions"
} ,
") => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsOpenPointInTimeResponse" ,
"text" : "SavedObjectsOpenPointInTimeResponse"
} ,
">; closePointInTime: (id: string, options?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsBaseOptions" ,
"text" : "SavedObjectsBaseOptions"
} ,
" | undefined) => Promise<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsClosePointInTimeResponse" ,
"text" : "SavedObjectsClosePointInTimeResponse"
} ,
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsFindOptions" ,
"text" : "SavedObjectsFindOptions"
} ,
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsCreatePointInTimeFinderDependencies" ,
"text" : "SavedObjectsCreatePointInTimeFinderDependencies"
} ,
" | undefined) => " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.ISavedObjectsPointInTimeFinder" ,
"text" : "ISavedObjectsPointInTimeFinder"
} ,
"<T, A>; errors: typeof " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsErrorHelpers" ,
"text" : "SavedObjectsErrorHelpers"
} ,
"; }"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.user" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "user" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false
}
]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.ListPluginSetup.getListClient" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "getListClient" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
2021-06-07 23:55:35 +02:00
"(esClient: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.ElasticsearchClient" ,
"text" : "ElasticsearchClient"
} ,
", spaceId: string, user: string) => " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.ListClient" ,
"text" : "ListClient"
}
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "lists" ,
"id" : "def-server.esClient" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "esClient" ,
"description" : [ ] ,
"signature" : [
"Pick<" ,
"KibanaClient" ,
2021-07-30 21:26:29 +02:00
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"helpers\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: " ,
2021-06-07 23:55:35 +02:00
"TransportRequestParams" ,
", options?: " ,
"TransportRequestOptions" ,
" | undefined): " ,
"TransportRequestPromise" ,
"<" ,
"ApiResponse" ,
"<Record<string, any>, unknown>>; }; }"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.spaceId" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "spaceId" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.user" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "user" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false
}
]
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.ListsApiRequestHandlerContext" ,
2021-03-30 14:27:28 +02:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "ListsApiRequestHandlerContext" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-30 14:27:28 +02:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.ListsApiRequestHandlerContext.getListClient" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "getListClient" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-05-20 19:22:41 +02:00
"() => " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.ListClient" ,
"text" : "ListClient"
}
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
2021-08-03 17:58:03 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.ListsApiRequestHandlerContext.getExceptionListClient" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "getExceptionListClient" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-05-20 19:22:41 +02:00
"() => " ,
{
"pluginId" : "lists" ,
"scope" : "server" ,
"docId" : "kibListsPluginApi" ,
"section" : "def-server.ExceptionListClient" ,
"text" : "ExceptionListClient"
}
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/types.ts" ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
2021-08-03 17:58:03 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-05-20 19:22:41 +02:00
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "lists" ,
"id" : "def-server.UpdateExceptionListItemOptions" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "UpdateExceptionListItemOptions" ,
"description" : [ ] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-20 19:22:41 +02:00
"deprecated" : false ,
"children" : [
2021-03-30 14:27:28 +02:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions._version" ,
2021-06-07 23:55:35 +02:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "_version" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"string | undefined"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions.comments" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "comments" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-05-20 19:22:41 +02:00
"({ comment: string; } & { id?: string | undefined; })[]"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions.entries" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "entries" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-07-30 21:26:29 +02: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\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"ip\" | \"date_nanos\" | \"ip_range\" | \"date_range\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"short\" | \"shape\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ 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; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions.id" ,
2021-03-30 14:27:28 +02:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "id" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions.itemId" ,
2021-03-30 14:27:28 +02:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "itemId" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions.namespaceType" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "namespaceType" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-05-20 19:22:41 +02:00
"\"single\" | \"agnostic\""
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions.name" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "name" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-05-20 19:22:41 +02:00
"string | undefined"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-30 14:27:28 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "lists" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.UpdateExceptionListItemOptions.osTypes" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-20 19:22:41 +02:00
"label" : "osTypes" ,
2021-03-30 14:27:28 +02:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-05-20 19:22:41 +02:00
"(\"windows\" | \"linux\" | \"macos\")[]"
2021-05-06 21:29:47 +02:00
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-20 19:22:41 +02:00
"deprecated" : false
2021-05-06 21:29:47 +02:00
} ,
{
2021-05-20 19:22:41 +02:00
"parentPluginId" : "lists" ,
"id" : "def-server.UpdateExceptionListItemOptions.description" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "description" ,
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-20 19:22:41 +02:00
"deprecated" : false
2021-05-06 21:29:47 +02:00
} ,
{
2021-05-20 19:22:41 +02:00
"parentPluginId" : "lists" ,
"id" : "def-server.UpdateExceptionListItemOptions.meta" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "meta" ,
"description" : [ ] ,
"signature" : [
"object | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-20 19:22:41 +02:00
"deprecated" : false
2021-05-06 21:29:47 +02:00
} ,
{
2021-05-20 19:22:41 +02:00
"parentPluginId" : "lists" ,
"id" : "def-server.UpdateExceptionListItemOptions.tags" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "tags" ,
"description" : [ ] ,
"signature" : [
"string[] | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-20 19:22:41 +02:00
"deprecated" : false
2021-05-06 21:29:47 +02:00
} ,
{
2021-05-20 19:22:41 +02:00
"parentPluginId" : "lists" ,
"id" : "def-server.UpdateExceptionListItemOptions.type" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "type" ,
"description" : [ ] ,
"signature" : [
"\"simple\" | undefined"
] ,
2021-08-02 18:57:22 +02:00
"path" : "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts" ,
2021-05-20 19:22:41 +02:00
"deprecated" : false
2021-05-06 21:29:47 +02:00
}
] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
2021-05-20 19:22:41 +02:00
}
] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
2021-05-27 11:30:15 +02:00
"functions" : [ ] ,
2021-05-20 19:22:41 +02:00
"interfaces" : [ ] ,
"enums" : [ ] ,
2021-05-27 11:30:15 +02:00
"misc" : [ ] ,
2021-05-20 19:22:41 +02:00
"objects" : [ ]
2021-03-03 04:02:17 +01:00
}
}