kibana/api_docs/task_manager.json

{
  "id": "taskManager",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [
      {
        "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>"
        ],
        "children": [
          {
            "id": "def-server.TaskManagerPlugin.Unnamed",
            "type": "Function",
            "label": "Constructor",
            "signature": [
              "any"
            ],
            "description": [],
            "children": [
              {
                "id": "def-server.TaskManagerPlugin.Unnamed.$1",
                "type": "Object",
                "label": "initContext",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.PluginInitializerContext",
                    "text": "PluginInitializerContext"
                  },
                  "<unknown>"
                ],
                "description": [],
                "source": {
                  "path": "x-pack/plugins/task_manager/server/plugin.ts",
                  "lineNumber": 58
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/task_manager/server/plugin.ts",
              "lineNumber": 58
            }
          },
          {
            "id": "def-server.TaskManagerPlugin.setup",
            "type": "Function",
            "label": "setup",
            "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"
              }
            ],
            "description": [],
            "children": [
              {
                "id": "def-server.TaskManagerPlugin.setup.$1",
                "type": "Object",
                "label": "core",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.CoreSetup",
                    "text": "CoreSetup"
                  },
                  "<object, unknown>"
                ],
                "description": [],
                "source": {
                  "path": "x-pack/plugins/task_manager/server/plugin.ts",
                  "lineNumber": 65
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/task_manager/server/plugin.ts",
              "lineNumber": 65
            }
          },
          {
            "id": "def-server.TaskManagerPlugin.start",
            "type": "Function",
            "label": "start",
            "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"
              }
            ],
            "description": [],
            "children": [
              {
                "id": "def-server.TaskManagerPlugin.start.$1",
                "type": "Object",
                "label": "{ savedObjects, elasticsearch }",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.CoreStart",
                    "text": "CoreStart"
                  }
                ],
                "description": [],
                "source": {
                  "path": "x-pack/plugins/task_manager/server/plugin.ts",
                  "lineNumber": 113
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/task_manager/server/plugin.ts",
              "lineNumber": 113
            }
          }
        ],
        "source": {
          "path": "x-pack/plugins/task_manager/server/plugin.ts",
          "lineNumber": 47
        },
        "initialIsOpen": false
      }
    ],
    "functions": [
      {
        "id": "def-server.asInterval",
        "type": "Function",
        "label": "asInterval",
        "signature": [
          "(ms: number) => string"
        ],
        "description": [],
        "children": [
          {
            "id": "def-server.asInterval.$1",
            "type": "number",
            "label": "ms",
            "isRequired": true,
            "signature": [
              "number"
            ],
            "description": [],
            "source": {
              "path": "x-pack/plugins/task_manager/server/lib/intervals.ts",
              "lineNumber": 41
            }
          }
        ],
        "tags": [],
        "returnComment": [],
        "source": {
          "path": "x-pack/plugins/task_manager/server/lib/intervals.ts",
          "lineNumber": 41
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.isUnrecoverableError",
        "type": "Function",
        "label": "isUnrecoverableError",
        "signature": [
          "(error: Error | ",
          "DecoratedError",
          ") => boolean"
        ],
        "description": [],
        "children": [
          {
            "id": "def-server.isUnrecoverableError.$1",
            "type": "CompoundType",
            "label": "error",
            "isRequired": true,
            "signature": [
              "Error | ",
              "DecoratedError"
            ],
            "description": [],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
              "lineNumber": 21
            }
          }
        ],
        "tags": [],
        "returnComment": [],
        "source": {
          "path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
          "lineNumber": 21
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.throwUnrecoverableError",
        "type": "Function",
        "label": "throwUnrecoverableError",
        "signature": [
          "(error: Error) => void"
        ],
        "description": [],
        "children": [
          {
            "id": "def-server.throwUnrecoverableError.$1",
            "type": "Object",
            "label": "error",
            "isRequired": true,
            "signature": [
              "Error"
            ],
            "description": [],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
              "lineNumber": 25
            }
          }
        ],
        "tags": [],
        "returnComment": [],
        "source": {
          "path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
          "lineNumber": 25
        },
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "id": "def-server.ConcreteTaskInstance",
        "type": "Interface",
        "label": "ConcreteTaskInstance",
        "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"
          }
        ],
        "description": [
          "\nA task instance that has an id and is ready for storage."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.id",
            "type": "string",
            "label": "id",
            "description": [
              "\nThe id of the Elastic document that stores this instance's data. This can\nbe passed by the caller when scheduling the task."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 302
            }
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.version",
            "type": "string",
            "label": "version",
            "description": [
              "\nThe saved object version from the Elaticsearch document."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 307
            },
            "signature": [
              "string | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.scheduledAt",
            "type": "Object",
            "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."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 313
            },
            "signature": [
              "Date"
            ]
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.attempts",
            "type": "number",
            "label": "attempts",
            "description": [
              "\nThe number of unsuccessful attempts since the last successful run. This\nwill be zeroed out after a successful run."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 319
            }
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.status",
            "type": "Enum",
            "label": "status",
            "description": [
              "\nIndicates whether or not the task is currently running."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 324
            },
            "signature": [
              {
                "pluginId": "taskManager",
                "scope": "server",
                "docId": "kibTaskManagerPluginApi",
                "section": "def-server.TaskStatus",
                "text": "TaskStatus"
              }
            ]
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.runAt",
            "type": "Object",
            "label": "runAt",
            "description": [
              "\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."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 330
            },
            "signature": [
              "Date"
            ]
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.startedAt",
            "type": "CompoundType",
            "label": "startedAt",
            "description": [
              "\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\"."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 337
            },
            "signature": [
              "Date | null"
            ]
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.retryAt",
            "type": "CompoundType",
            "label": "retryAt",
            "description": [
              "\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\"."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 343
            },
            "signature": [
              "Date | null"
            ]
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.state",
            "type": "Object",
            "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: {}"
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 353
            },
            "signature": [
              "Record<string, any>"
            ]
          },
          {
            "tags": [],
            "id": "def-server.ConcreteTaskInstance.ownerId",
            "type": "CompoundType",
            "label": "ownerId",
            "description": [
              "\nThe random uuid of the Kibana instance which claimed ownership of the task last"
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 358
            },
            "signature": [
              "string | null"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/task_manager/server/task.ts",
          "lineNumber": 297
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.RunContext",
        "type": "Interface",
        "label": "RunContext",
        "description": [
          "\nThe run context is passed into a task's run function as its sole argument."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.RunContext.taskInstance",
            "type": "Object",
            "label": "taskInstance",
            "description": [
              "\nThe document describing the task instance, its params, state, id, etc."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 37
            },
            "signature": [
              {
                "pluginId": "taskManager",
                "scope": "server",
                "docId": "kibTaskManagerPluginApi",
                "section": "def-server.ConcreteTaskInstance",
                "text": "ConcreteTaskInstance"
              }
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/task_manager/server/task.ts",
          "lineNumber": 33
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.TaskInstance",
        "type": "Interface",
        "label": "TaskInstance",
        "description": [],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.TaskInstance.id",
            "type": "string",
            "label": "id",
            "description": [
              "\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"
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 201
            },
            "signature": [
              "string | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.taskType",
            "type": "string",
            "label": "taskType",
            "description": [
              "\nThe task definition type whose run function will execute this instance."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 206
            }
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.scheduledAt",
            "type": "Object",
            "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."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 212
            },
            "signature": [
              "Date | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.startedAt",
            "type": "CompoundType",
            "label": "startedAt",
            "description": [
              "\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\"."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 219
            },
            "signature": [
              "Date | null | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.retryAt",
            "type": "CompoundType",
            "label": "retryAt",
            "description": [
              "\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\"."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 225
            },
            "signature": [
              "Date | null | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.runAt",
            "type": "Object",
            "label": "runAt",
            "description": [
              "\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."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 232
            },
            "signature": [
              "Date | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.schedule",
            "type": "Object",
            "label": "schedule",
            "description": [
              "\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')."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 239
            },
            "signature": [
              "IntervalSchedule",
              " | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.params",
            "type": "Object",
            "label": "params",
            "description": [
              "\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' }."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 248
            },
            "signature": [
              "Record<string, any>"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.state",
            "type": "Object",
            "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: {}"
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 258
            },
            "signature": [
              "Record<string, any>"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.user",
            "type": "string",
            "label": "user",
            "description": [
              "\nThe id of the user who scheduled this task."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 263
            },
            "signature": [
              "string | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.scope",
            "type": "Array",
            "label": "scope",
            "description": [
              "\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."
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 269
            },
            "signature": [
              "string[] | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.TaskInstance.ownerId",
            "type": "CompoundType",
            "label": "ownerId",
            "description": [
              "\nThe random uuid of the Kibana instance which claimed ownership of the task last"
            ],
            "source": {
              "path": "x-pack/plugins/task_manager/server/task.ts",
              "lineNumber": 274
            },
            "signature": [
              "string | null | undefined"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/task_manager/server/task.ts",
          "lineNumber": 195
        },
        "initialIsOpen": false
      }
    ],
    "enums": [
      {
        "id": "def-server.TaskStatus",
        "type": "Enum",
        "label": "TaskStatus",
        "tags": [],
        "description": [],
        "source": {
          "path": "x-pack/plugins/task_manager/server/task.ts",
          "lineNumber": 171
        },
        "initialIsOpen": false
      }
    ],
    "misc": [
      {
        "id": "def-server.TaskRunCreatorFunction",
        "type": "Type",
        "label": "TaskRunCreatorFunction",
        "tags": [],
        "description": [],
        "source": {
          "path": "x-pack/plugins/task_manager/server/task.ts",
          "lineNumber": 96
        },
        "signature": [
          "(context: ",
          {
            "pluginId": "taskManager",
            "scope": "server",
            "docId": "kibTaskManagerPluginApi",
            "section": "def-server.RunContext",
            "text": "RunContext"
          },
          ") => ",
          "CancellableTask"
        ],
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "id": "def-server.TaskManagerSetupContract",
      "type": "Type",
      "label": "TaskManagerSetupContract",
      "tags": [],
      "description": [],
      "source": {
        "path": "x-pack/plugins/task_manager/server/plugin.ts",
        "lineNumber": 31
      },
      "signature": [
        "{ index: string; addMiddleware: (middleware: Middleware) => void; } & Pick<TaskTypeDictionary, \"registerTaskDefinitions\">"
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "id": "def-server.TaskManagerStartContract",
      "type": "Type",
      "label": "TaskManagerStartContract",
      "tags": [],
      "description": [],
      "source": {
        "path": "x-pack/plugins/task_manager/server/plugin.ts",
        "lineNumber": 39
      },
      "signature": [
        "Pick<TaskScheduling, \"schedule\" | \"runNow\" | \"ensureScheduled\"> & Pick<TaskStore, \"remove\" | \"get\" | \"fetch\"> & { removeIfExists: TaskStore['remove']; }"
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}