mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
1795 lines
No EOL
62 KiB
JSON
1795 lines
No EOL
62 KiB
JSON
{
|
|
"id": "taskManager",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"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": "@kbn/core-plugins-server",
|
|
"scope": "common",
|
|
"docId": "kibKbnCorePluginsServerPluginApi",
|
|
"section": "def-common.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>"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-plugins-server",
|
|
"scope": "common",
|
|
"docId": "kibKbnCorePluginsServerPluginApi",
|
|
"section": "def-common.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<unknown>"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.isNodeBackgroundTasksOnly",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isNodeBackgroundTasksOnly",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "@kbn/core-lifecycle-server",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreLifecycleServerPluginApi",
|
|
"section": "def-common.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, plugins: { usageCollection?: ",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCollectionSetup",
|
|
"text": "UsageCollectionSetup"
|
|
},
|
|
" | undefined; }) => ",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskManagerSetupContract",
|
|
"text": "TaskManagerSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-lifecycle-server",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreLifecycleServerPluginApi",
|
|
"section": "def-common.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.setup.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.setup.$2.usageCollection",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usageCollection",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCollectionSetup",
|
|
"text": "UsageCollectionSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"({ savedObjects, elasticsearch, executionContext, docLinks, }: ",
|
|
{
|
|
"pluginId": "@kbn/core-lifecycle-server",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreLifecycleServerPluginApi",
|
|
"section": "def-common.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskManagerStartContract",
|
|
"text": "TaskManagerStartContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerPlugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n savedObjects,\n elasticsearch,\n executionContext,\n docLinks,\n }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-lifecycle-server",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreLifecycleServerPluginApi",
|
|
"section": "def-common.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.aggregateTaskOverduePercentilesForType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggregateTaskOverduePercentilesForType",
|
|
"description": [],
|
|
"signature": [
|
|
"(type: string) => { aggs: Record<string, ",
|
|
"AggregationsAggregationContainer",
|
|
">; query: ",
|
|
"QueryDslQueryContainer",
|
|
"; runtime_mappings: ",
|
|
"MappingRuntimeFields",
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/queries/aggregate_task_overdue_percentiles_for_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.aggregateTaskOverduePercentilesForType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/queries/aggregate_task_overdue_percentiles_for_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.asInterval",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"(ms: number) => string"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/lib/intervals.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.asInterval.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "ms",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/lib/intervals.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.createSkipError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createSkipError",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: Error) => ",
|
|
"DecoratedError"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.createSkipError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.isEphemeralTaskRejectedDueToCapacityError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isEphemeralTaskRejectedDueToCapacityError",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: Error | ",
|
|
"EphemeralTaskRejectedDueToCapacityError",
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.isEphemeralTaskRejectedDueToCapacityError.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | ",
|
|
"EphemeralTaskRejectedDueToCapacityError"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.isSkipError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isSkipError",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: Error | ",
|
|
"DecoratedError",
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.isSkipError.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | ",
|
|
"DecoratedError"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.isUnrecoverableError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isUnrecoverableError",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: Error | ",
|
|
"DecoratedError",
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.isUnrecoverableError.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | ",
|
|
"DecoratedError"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.throwRetryableError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "throwRetryableError",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: Error, shouldRetry: boolean | Date) => void"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.throwRetryableError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.throwRetryableError.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "shouldRetry",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | Date"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.throwUnrecoverableError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "throwUnrecoverableError",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: Error) => void"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.throwUnrecoverableError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_running/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.BulkUpdateTaskResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkUpdateTaskResult",
|
|
"description": [
|
|
"\nreturn type of TaskScheduling.bulkUpdateSchedules method"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_scheduling.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.BulkUpdateTaskResult.tasks",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "tasks",
|
|
"description": [
|
|
"\nlist of successfully updated tasks"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.ConcreteTaskInstance",
|
|
"text": "ConcreteTaskInstance"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_scheduling.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.BulkUpdateTaskResult.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [
|
|
"\nlist of failed tasks and errors caused failure"
|
|
],
|
|
"signature": [
|
|
"{ type: string; id: string; error: ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectError",
|
|
"text": "SavedObjectError"
|
|
},
|
|
"; }[]"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_scheduling.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ConcreteTaskInstance",
|
|
"description": [
|
|
"\nA task instance that has an id and is ready for storage."
|
|
],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.interval",
|
|
"type": "string",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": []
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nThe saved object version from the Elasticsearch document."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.scheduledAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.attempts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "attempts",
|
|
"description": [
|
|
"\nThe number of unsuccessful attempts since the last successful run. This\nwill be zeroed out after a successful run."
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.status",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nIndicates whether or not the task is currently running."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskStatus",
|
|
"text": "TaskStatus"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.runAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.startedAt",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"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\"."
|
|
],
|
|
"signature": [
|
|
"Date | null"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.retryAt",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"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\"."
|
|
],
|
|
"signature": [
|
|
"Date | null"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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: {}"
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.ConcreteTaskInstance.ownerId",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ownerId",
|
|
"description": [
|
|
"\nThe random uuid of the Kibana instance which claimed ownership of the task last"
|
|
],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.IntervalSchedule",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IntervalSchedule",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.IntervalSchedule.interval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [
|
|
"\nAn interval in minutes (e.g. '5m'). If specified, this is a recurring task."
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RunContext",
|
|
"description": [
|
|
"\nThe run context is passed into a task's run function as its sole argument."
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunContext.taskInstance",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "taskInstance",
|
|
"description": [
|
|
"\nThe document describing the task instance, its params, state, id, etc."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.ConcreteTaskInstance",
|
|
"text": "ConcreteTaskInstance"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunNowResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RunNowResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/task_scheduling.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunNowResult.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/task_scheduling.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunNowResult.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_scheduling.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TaskInstance",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"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"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.taskType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "taskType",
|
|
"description": [
|
|
"\nThe task definition type whose run function will execute this instance."
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.scheduledAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"Date | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.startedAt",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"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\"."
|
|
],
|
|
"signature": [
|
|
"Date | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.retryAt",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"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\"."
|
|
],
|
|
"signature": [
|
|
"Date | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.runAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"Date | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.schedule",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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')."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.IntervalSchedule",
|
|
"text": "IntervalSchedule"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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' }."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"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: {}"
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.stateVersion",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "stateVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"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"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.user",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "user",
|
|
"description": [
|
|
"\nThe id of the user who scheduled this task."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.scope",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.ownerId",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ownerId",
|
|
"description": [
|
|
"\nThe random uuid of the Kibana instance which claimed ownership of the task last"
|
|
],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.enabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [
|
|
"\nIndicates whether the task is currently enabled. Disabled tasks will not be claimed."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskInstance.numSkippedRuns",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "numSkippedRuns",
|
|
"description": [
|
|
"\nIndicates the number of skipped executions."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TaskRegisterDefinition",
|
|
"description": [
|
|
"\nDefines a task which can be scheduled and run by the Kibana\ntask manager."
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [
|
|
"\nA brief, human-friendly title for this task."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.timeout",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeout",
|
|
"description": [
|
|
"\nHow long, in minutes or seconds, the system should wait for the task to complete\nbefore it is considered to be timed out. (e.g. '5m', the default). If\nthe task takes longer than this, Kibana will send it a kill command and\nthe task will be re-attempted."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nAn optional more detailed description of what this task does."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.createTaskRunner",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createTaskRunner",
|
|
"description": [
|
|
"\nCreates an object that has a run function which performs the task's work,\nand an optional cancel function which cancels the task."
|
|
],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.RunContext",
|
|
"text": "RunContext"
|
|
},
|
|
") => ",
|
|
"CancellableTask",
|
|
"<",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.ConcreteTaskInstance",
|
|
"text": "ConcreteTaskInstance"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.createTaskRunner.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.RunContext",
|
|
"text": "RunContext"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.maxAttempts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxAttempts",
|
|
"description": [
|
|
"\nUp to how many times the task should retry when it fails to run. This will\ndefault to the global variable. The default value, if not specified, is 1."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.maxConcurrency",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxConcurrency",
|
|
"description": [
|
|
"\nThe maximum number tasks of this type that can be run concurrently per Kibana instance.\nSetting this value will force Task Manager to poll for this task type separately from other task types\nwhich can add significant load to the ES cluster, so please use this configuration only when absolutely necessary.\nThe default value, if not given, is 0."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.stateSchemaByVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "stateSchemaByVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<number, { schema: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<any>; up: (state: Record<string, unknown>) => Record<string, unknown>; }> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.paramsSchema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "paramsSchema",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRegisterDefinition.indirectParamsSchema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indirectParamsSchema",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskStatus",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "TaskStatus",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.EphemeralTask",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EphemeralTask",
|
|
"description": [
|
|
"\nA task instance that has an id and is ready for storage."
|
|
],
|
|
"signature": [
|
|
"{ scope?: string[] | undefined; params: Record<string, any>; enabled?: boolean | undefined; state: Record<string, any>; taskType: string; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.LoadIndirectParamsResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LoadIndirectParamsResult",
|
|
"description": [],
|
|
"signature": [
|
|
"{ data: T; error?: undefined; } | { data?: undefined; error: Error; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskDefinitionRegistry",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TaskDefinitionRegistry",
|
|
"description": [
|
|
"\nA mapping of task type id to the task definition."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: ",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskRegisterDefinition",
|
|
"text": "TaskRegisterDefinition"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRunCreatorFunction",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TaskRunCreatorFunction",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.RunContext",
|
|
"text": "RunContext"
|
|
},
|
|
") => ",
|
|
"CancellableTask",
|
|
"<",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.ConcreteTaskInstance",
|
|
"text": "ConcreteTaskInstance"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskRunCreatorFunction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.RunContext",
|
|
"text": "RunContext"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/task.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.IdleTaskWithExpiredRunAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "IdleTaskWithExpiredRunAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.IdleTaskWithExpiredRunAt.bool",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bool",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.IdleTaskWithExpiredRunAt.bool.must",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "must",
|
|
"description": [],
|
|
"signature": [
|
|
"({ term: { 'task.status': string; }; } | { range: { 'task.runAt': { lte: string; }; }; })[]"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunningOrClaimingTaskWithExpiredRetryAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "RunningOrClaimingTaskWithExpiredRetryAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunningOrClaimingTaskWithExpiredRetryAt.bool",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bool",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.RunningOrClaimingTaskWithExpiredRetryAt.bool.must",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "must",
|
|
"description": [],
|
|
"signature": [
|
|
"({ bool: { should: { term: { 'task.status': string; }; }[]; }; } | { range: { 'task.retryAt': { lte: string; }; }; })[]"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerSetupContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TaskManagerSetupContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerSetupContract.index",
|
|
"type": "string",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "index",
|
|
"description": [],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "actions",
|
|
"path": "x-pack/plugins/actions/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "alerting",
|
|
"path": "x-pack/plugins/alerting/server/usage/task.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerSetupContract.addMiddleware",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addMiddleware",
|
|
"description": [],
|
|
"signature": [
|
|
"(middleware: ",
|
|
"Middleware",
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerSetupContract.addMiddleware.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "middleware",
|
|
"description": [],
|
|
"signature": [
|
|
"Middleware"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerSetupContract.registerTaskDefinitions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerTaskDefinitions",
|
|
"description": [
|
|
"\nMethod for allowing consumers to register task definitions into the system."
|
|
],
|
|
"signature": [
|
|
"(taskDefinitions: ",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskDefinitionRegistry",
|
|
"text": "TaskDefinitionRegistry"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerSetupContract.registerTaskDefinitions.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "taskDefinitions",
|
|
"description": [
|
|
"- The Kibana task definitions dictionary"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskDefinitionRegistry",
|
|
"text": "TaskDefinitionRegistry"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "taskManager",
|
|
"id": "def-server.TaskManagerStartContract",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TaskManagerStartContract",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"TaskScheduling",
|
|
", \"schedule\" | \"runSoon\" | \"ephemeralRunNow\" | \"ensureScheduled\" | \"bulkUpdateSchedules\" | \"bulkEnable\" | \"bulkDisable\" | \"bulkSchedule\"> & Pick<",
|
|
"TaskStore",
|
|
", \"get\" | \"aggregate\" | \"fetch\" | \"remove\" | \"bulkRemove\"> & { removeIfExists: (id: string) => Promise<void>; } & { supportsEphemeralTasks: () => boolean; getRegisteredTypes: () => string[]; }"
|
|
],
|
|
"path": "x-pack/plugins/task_manager/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |