2021-03-03 04:02:17 +01:00
{
"id" : "taskManager" ,
"client" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"server" : {
"classes" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskManagerPlugin" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "TaskManagerPlugin" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.TaskManagerPlugin" ,
"text" : "TaskManagerPlugin"
} ,
" implements " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.Plugin" ,
"text" : "Plugin"
} ,
"<" ,
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.TaskManagerSetupContract" ,
"text" : "TaskManagerSetupContract"
} ,
", " ,
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.TaskManagerStartContract" ,
"text" : "TaskManagerStartContract"
} ,
", object, object>"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskManagerPlugin.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-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
"lineNumber" : 58
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.TaskManagerPlugin.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" : "initContext" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.PluginInitializerContext" ,
"text" : "PluginInitializerContext"
} ,
"<unknown>"
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
2021-05-06 19:09:09 +02:00
"lineNumber" : 58
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" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskManagerPlugin.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" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<object, unknown>) => " ,
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.TaskManagerSetupContract" ,
"text" : "TaskManagerSetupContract"
}
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
"lineNumber" : 65
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.TaskManagerPlugin.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" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<object, unknown>"
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
2021-05-06 19:09:09 +02:00
"lineNumber" : 65
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" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskManagerPlugin.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" : [
"({ savedObjects, elasticsearch }: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreStart" ,
"text" : "CoreStart"
} ,
") => " ,
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.TaskManagerStartContract" ,
"text" : "TaskManagerStartContract"
}
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
2021-06-29 18:29:58 +02:00
"lineNumber" : 111
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" : "taskManager" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.TaskManagerPlugin.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" : "{ savedObjects, elasticsearch }" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreStart" ,
"text" : "CoreStart"
}
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
2021-06-29 18:29:58 +02:00
"lineNumber" : 111
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
}
] ,
"functions" : [
2021-05-06 19:09:09 +02:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-05-06 19:09:09 +02:00
"id" : "def-server.asInterval" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-06 19:09:09 +02:00
"label" : "asInterval" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-05-06 19:09:09 +02:00
"signature" : [
"(ms: number) => string"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/lib/intervals.ts" ,
"lineNumber" : 41
} ,
"deprecated" : false ,
2021-05-06 19:09:09 +02:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-05-06 19:09:09 +02:00
"id" : "def-server.asInterval.$1" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-06 19:09:09 +02:00
"label" : "ms" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-05-06 19:09:09 +02:00
"signature" : [
"number"
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/lib/intervals.ts" ,
"lineNumber" : 41
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-05-06 19:09:09 +02:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.isUnrecoverableError" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "isUnrecoverableError" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(error: Error | " ,
"DecoratedError" ,
") => boolean"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task_running/errors.ts" ,
"lineNumber" : 21
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.isUnrecoverableError.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "error" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"Error | " ,
2021-04-15 17:36:10 +02:00
"DecoratedError"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task_running/errors.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.throwUnrecoverableError" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "throwUnrecoverableError" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(error: Error) => void"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task_running/errors.ts" ,
"lineNumber" : 25
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.throwUnrecoverableError.$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" : "error" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"Error"
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task_running/errors.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 25
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ConcreteTaskInstance" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nA task instance that has an id and is ready for storage."
] ,
2021-03-06 02:12:28 +01:00
"signature" : [
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.ConcreteTaskInstance" ,
"text" : "ConcreteTaskInstance"
} ,
" extends " ,
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.TaskInstance" ,
"text" : "TaskInstance"
}
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 302
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe id of the Elastic document that stores this instance's data. This can\nbe passed by the caller when scheduling the task."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 307
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.version" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "version" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe saved object version from the Elaticsearch document."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 312
2021-03-06 02:12:28 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.scheduledAt" ,
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" : "scheduledAt" ,
"description" : [
"\nThe date and time that this task was originally scheduled. This is used\nfor convenience to task run functions, and for troubleshooting."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 318
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.attempts" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "attempts" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe number of unsuccessful attempts since the last successful run. This\nwill be zeroed out after a successful run."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 324
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.status" ,
"type" : "Enum" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "status" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nIndicates whether or not the task is currently running."
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.TaskStatus" ,
"text" : "TaskStatus"
}
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 329
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.runAt" ,
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" : "runAt" ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe date and time that this task is scheduled to be run. It is not guaranteed\nto run at this time, but it is guaranteed not to run earlier than this."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 335
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.startedAt" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "startedAt" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe date and time that this task started execution. This is used to determine\nthe \"real\" runAt that ended up running the task. This value is only set\nwhen status is set to \"running\"."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date | null"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 342
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.retryAt" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "retryAt" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe date and time that this task should re-execute if stuck in \"running\" / timeout\nstatus. This value is only set when status is set to \"running\"."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date | null"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 348
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.state" ,
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" : "state" ,
"description" : [
"\nThe state passed into the task's run function, and returned by the previous\nrun. If there was no previous run, or if the previous run did not return\nany state, this will be the empy object: {}"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"{ [x: string]: any; }"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 358
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ConcreteTaskInstance.ownerId" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ownerId" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe random uuid of the Kibana instance which claimed ownership of the task last"
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | null"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 363
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.RunContext" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "RunContext" ,
"description" : [
"\nThe run context is passed into a task's run function as its sole argument."
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
"lineNumber" : 33
} ,
"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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.RunContext.taskInstance" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "taskInstance" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe document describing the task instance, its params, state, id, etc."
2021-03-03 04:02:17 +01:00
] ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.ConcreteTaskInstance" ,
"text" : "ConcreteTaskInstance"
}
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
"lineNumber" : 37
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "TaskInstance" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
"lineNumber" : 195
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nOptional ID that can be passed by the caller. When ID is undefined, ES\nwill auto-generate a unique id. Otherwise, ID will be used to either\ncreate a new document, or update existing document"
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 201
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.taskType" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "taskType" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe task definition type whose run function will execute this instance."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 206
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.scheduledAt" ,
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" : "scheduledAt" ,
"description" : [
"\nThe date and time that this task was originally scheduled. This is used\nfor convenience to task run functions, and for troubleshooting."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 212
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.startedAt" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "startedAt" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe date and time that this task started execution. This is used to determine\nthe \"real\" runAt that ended up running the task. This value is only set\nwhen status is set to \"running\"."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date | null | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 219
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.retryAt" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "retryAt" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe date and time that this task should re-execute if stuck in \"running\" / timeout\nstatus. This value is only set when status is set to \"running\"."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date | null | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 225
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.runAt" ,
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" : "runAt" ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe date and time that this task is scheduled to be run. It is not\nguaranteed to run at this time, but it is guaranteed not to run earlier\nthan this. Defaults to immediately."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Date | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 232
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.schedule" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "schedule" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nA TaskSchedule string, which specifies this as a recurring task.\n\nCurrently, this supports a single format: an interval in minutes or seconds (e.g. '5m', '30s')."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"IntervalSchedule" ,
" | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 239
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.params" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "params" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nA task-specific set of parameters, used by the task's run function to tailor\nits work. This is generally user-input, such as { sms: '333-444-2222' }."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"{ [x: string]: any; }"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 248
2021-03-03 04:02:17 +01:00
} ,
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.state" ,
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" : "state" ,
"description" : [
"\nThe state passed into the task's run function, and returned by the previous\nrun. If there was no previous run, or if the previous run did not return\nany state, this will be the empy object: {}"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"{ [x: string]: any; }"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 258
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
2021-06-07 21:02:57 +02:00
{
"parentPluginId" : "taskManager" ,
"id" : "def-server.TaskInstance.traceparent" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "traceparent" ,
"description" : [
"\nThe serialized traceparent string of the current APM transaction or span."
] ,
"signature" : [
"string | undefined"
] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
"lineNumber" : 263
} ,
"deprecated" : false
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.user" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "user" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe id of the user who scheduled this task."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 268
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
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" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.scope" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "scope" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nUsed to group tasks for querying. So, reporting might schedule tasks with a scope of 'reporting',\nand then query such tasks to provide a glimpse at only reporting tasks, rather than at all tasks."
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string[] | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 274
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.TaskInstance.ownerId" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ownerId" ,
"description" : [
"\nThe random uuid of the Kibana instance which claimed ownership of the task last"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | null | undefined"
] ,
2021-03-06 02:12:28 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 279
2021-03-06 02:12:28 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskStatus" ,
"type" : "Enum" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "TaskStatus" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 171
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
}
] ,
"misc" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskRunCreatorFunction" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "TaskRunCreatorFunction" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
"(context: " ,
{
"pluginId" : "taskManager" ,
"scope" : "server" ,
"docId" : "kibTaskManagerPluginApi" ,
"section" : "def-server.RunContext" ,
"text" : "RunContext"
} ,
") => " ,
"CancellableTask"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/task.ts" ,
"lineNumber" : 96
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskManagerSetupContract" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "TaskManagerSetupContract" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"{ index: string; addMiddleware: (middleware: " ,
"Middleware" ,
") => void; } & Pick<" ,
"TaskTypeDictionary" ,
", \"registerTaskDefinitions\">"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "taskManager" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.TaskManagerStartContract" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "TaskManagerStartContract" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"Pick<" ,
"TaskScheduling" ,
", \"schedule\" | \"runNow\" | \"ensureScheduled\"> & Pick<" ,
"TaskStore" ,
", \"remove\" | \"get\" | \"fetch\"> & { removeIfExists: (id: string) => Promise<void>; }"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/task_manager/server/plugin.ts" ,
2021-05-06 19:09:09 +02:00
"lineNumber" : 39
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}