diff --git a/api_docs/reporting.json b/api_docs/reporting.json index 1296fb8926178..e07e3493a9d85 100644 --- a/api_docs/reporting.json +++ b/api_docs/reporting.json @@ -851,7 +851,29 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 58 + "lineNumber": 65 + } + }, + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", + "ByteSizeValue", + "; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" + ], + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 65 } } ], @@ -859,7 +881,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 58 + "lineNumber": 65 } }, { @@ -895,7 +917,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 63 + "lineNumber": 75 } } ], @@ -903,7 +925,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 63 + "lineNumber": 75 } }, { @@ -919,7 +941,7 @@ "section": "def-server.ReportingInternalStart", "text": "ReportingInternalStart" }, - ") => void" + ") => Promise" ], "description": [], "children": [ @@ -939,7 +961,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 71 + "lineNumber": 89 } } ], @@ -947,7 +969,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 71 + "lineNumber": 89 } }, { @@ -963,7 +985,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 79 + "lineNumber": 102 } }, { @@ -979,7 +1001,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 90 + "lineNumber": 113 } }, { @@ -995,7 +1017,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 97 + "lineNumber": 120 } }, { @@ -1031,7 +1053,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 104 + "lineNumber": 127 } } ], @@ -1039,7 +1061,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 104 + "lineNumber": 127 } }, { @@ -1057,7 +1079,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 112 + "lineNumber": 135 } }, { @@ -1080,7 +1102,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 132 + "lineNumber": 155 } }, { @@ -1104,7 +1126,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 142 + "lineNumber": 165 } }, { @@ -1127,21 +1149,90 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 150 + "lineNumber": 173 + } + }, + { + "id": "def-server.ReportingCore.scheduleTask", + "type": "Function", + "label": "scheduleTask", + "signature": [ + "(report: ", + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.ReportTaskParams", + "text": "ReportTaskParams" + }, + "<", + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.BasePayload", + "text": "BasePayload" + }, + ">) => Promise<", + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.ConcreteTaskInstance", + "text": "ConcreteTaskInstance" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "report", + "isRequired": true, + "signature": [ + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.ReportTaskParams", + "text": "ReportTaskParams" + }, + "<", + { + "pluginId": "reporting", + "scope": "server", + "docId": "kibReportingPluginApi", + "section": "def-server.BasePayload", + "text": "BasePayload" + }, + ">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 177 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 177 } }, { - "id": "def-server.ReportingCore.getEsqueue", + "id": "def-server.ReportingCore.getStore", "type": "Function", - "label": "getEsqueue", + "label": "getStore", "signature": [ "() => Promise<", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", - "section": "def-server.ESQueueInstance", - "text": "ESQueueInstance" + "section": "def-server.ReportingStore", + "text": "ReportingStore" }, ">" ], @@ -1151,7 +1242,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 154 + "lineNumber": 181 } }, { @@ -1175,7 +1266,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 158 + "lineNumber": 185 } }, { @@ -1199,7 +1290,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 168 + "lineNumber": 195 } }, { @@ -1222,7 +1313,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 177 + "lineNumber": 204 } }, { @@ -1245,7 +1336,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 184 + "lineNumber": 211 } }, { @@ -1291,7 +1382,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 193 + "lineNumber": 220 } } ], @@ -1299,7 +1390,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 193 + "lineNumber": 220 } }, { @@ -1344,7 +1435,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 199 + "lineNumber": 226 } }, { @@ -1363,7 +1454,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 199 + "lineNumber": 226 } } ], @@ -1371,7 +1462,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 199 + "lineNumber": 226 } }, { @@ -1409,7 +1500,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 213 + "lineNumber": 240 } }, { @@ -1422,7 +1513,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 213 + "lineNumber": 240 } }, { @@ -1441,7 +1532,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 213 + "lineNumber": 240 } } ], @@ -1449,7 +1540,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 213 + "lineNumber": 240 } }, { @@ -1502,7 +1593,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 233 + "lineNumber": 260 } }, { @@ -1521,7 +1612,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 233 + "lineNumber": 260 } } ], @@ -1529,13 +1620,89 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 233 + "lineNumber": 260 + } + }, + { + "id": "def-server.ReportingCore.trackReport", + "type": "Function", + "label": "trackReport", + "signature": [ + "(reportId: string) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "reportId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 270 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 270 + } + }, + { + "id": "def-server.ReportingCore.untrackReport", + "type": "Function", + "label": "untrackReport", + "signature": [ + "(reportId: string) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "reportId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 274 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 274 + } + }, + { + "id": "def-server.ReportingCore.countConcurrentReports", + "type": "Function", + "label": "countConcurrentReports", + "signature": [ + "() => number" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/reporting/server/core.ts", + "lineNumber": 278 } } ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", - "lineNumber": 50 + "lineNumber": 54 }, "initialIsOpen": false }, @@ -1732,7 +1899,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 105 + "lineNumber": 106 } }, { @@ -1751,7 +1918,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 105 + "lineNumber": 106 } } ], @@ -1759,7 +1926,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", - "lineNumber": 105 + "lineNumber": 106 } } ], @@ -1827,7 +1994,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 28 + "lineNumber": 29 }, "signature": [ { @@ -1847,7 +2014,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 29 + "lineNumber": 30 }, "signature": [ { @@ -1867,7 +2034,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 30 + "lineNumber": 31 }, "signature": [ { @@ -1888,7 +2055,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 31 + "lineNumber": 32 }, "signature": [ { @@ -1901,6 +2068,26 @@ " | undefined" ] }, + { + "tags": [], + "id": "def-server.ReportingSetupDeps.taskManager", + "type": "CompoundType", + "label": "taskManager", + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/types.ts", + "lineNumber": 33 + }, + "signature": [ + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.TaskManagerSetupContract", + "text": "TaskManagerSetupContract" + } + ] + }, { "tags": [], "id": "def-server.ReportingSetupDeps.usageCollection", @@ -1909,7 +2096,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 32 + "lineNumber": 34 }, "signature": [ "Pick<", @@ -1926,7 +2113,7 @@ ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 27 + "lineNumber": 28 }, "initialIsOpen": false }, @@ -1945,7 +2132,7 @@ "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 36 + "lineNumber": 38 }, "signature": [ { @@ -1956,11 +2143,31 @@ "text": "DataPluginStart" } ] + }, + { + "tags": [], + "id": "def-server.ReportingStartDeps.taskManager", + "type": "CompoundType", + "label": "taskManager", + "description": [], + "source": { + "path": "x-pack/plugins/reporting/server/types.ts", + "lineNumber": 39 + }, + "signature": [ + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.TaskManagerStartContract", + "text": "TaskManagerStartContract" + } + ] } ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", - "lineNumber": 35 + "lineNumber": 37 }, "initialIsOpen": false }