kibana/api_docs/kbn_reporting_common.devdocs.json

1647 lines
No EOL
55 KiB
JSON

{
"id": "@kbn/reporting-common",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.AuthenticationExpiredError",
"type": "Class",
"tags": [],
"label": "AuthenticationExpiredError",
"description": [
"\nWhile performing some reporting action, like fetching data from ES, our\naccess token expired."
],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.AuthenticationExpiredError",
"text": "AuthenticationExpiredError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.AuthenticationExpiredError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"authentication_expired_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.AuthenticationExpiredError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserCouldNotLaunchError",
"type": "Class",
"tags": [],
"label": "BrowserCouldNotLaunchError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.BrowserCouldNotLaunchError",
"text": "BrowserCouldNotLaunchError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserCouldNotLaunchError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"browser_could_not_launch_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserCouldNotLaunchError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserCouldNotLaunchError.humanFriendlyMessage",
"type": "Function",
"tags": [],
"label": "humanFriendlyMessage",
"description": [],
"signature": [
"() => string"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserScreenshotError",
"type": "Class",
"tags": [],
"label": "BrowserScreenshotError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.BrowserScreenshotError",
"text": "BrowserScreenshotError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserScreenshotError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"browser_screenshot_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserScreenshotError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserUnexpectedlyClosedError",
"type": "Class",
"tags": [],
"label": "BrowserUnexpectedlyClosedError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.BrowserUnexpectedlyClosedError",
"text": "BrowserUnexpectedlyClosedError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserUnexpectedlyClosedError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"browser_unexpectedly_closed_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.BrowserUnexpectedlyClosedError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.CancellationToken",
"type": "Class",
"tags": [],
"label": "CancellationToken",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/cancellation_token.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.CancellationToken.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/private/kbn-reporting/common/cancellation_token.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.CancellationToken.on",
"type": "Function",
"tags": [],
"label": "on",
"description": [],
"signature": [
"(callback: Function) => void"
],
"path": "src/platform/packages/private/kbn-reporting/common/cancellation_token.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.CancellationToken.on.$1",
"type": "Object",
"tags": [],
"label": "callback",
"description": [],
"signature": [
"Function"
],
"path": "src/platform/packages/private/kbn-reporting/common/cancellation_token.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.CancellationToken.cancel",
"type": "Function",
"tags": [],
"label": "cancel",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/packages/private/kbn-reporting/common/cancellation_token.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.CancellationToken.isCancelled",
"type": "Function",
"tags": [],
"label": "isCancelled",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/platform/packages/private/kbn-reporting/common/cancellation_token.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.DisallowedOutgoingUrl",
"type": "Class",
"tags": [],
"label": "DisallowedOutgoingUrl",
"description": [
"\nWhile loading requests in the Kibana app, a URL was encountered that the network policy did not allow."
],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.DisallowedOutgoingUrl",
"text": "DisallowedOutgoingUrl"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.DisallowedOutgoingUrl.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"disallowed_outgoing_url_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.DisallowedOutgoingUrl.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"disallowed_outgoing_url_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.InvalidLayoutParametersError",
"type": "Class",
"tags": [],
"label": "InvalidLayoutParametersError",
"description": [
"\nWhile validating the page layout parameters for a screenshot type report job"
],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.InvalidLayoutParametersError",
"text": "InvalidLayoutParametersError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.InvalidLayoutParametersError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"invalid_layout_parameters_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.InvalidLayoutParametersError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"invalid_layout_parameters_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.KibanaShuttingDownError",
"type": "Class",
"tags": [],
"label": "KibanaShuttingDownError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.KibanaShuttingDownError",
"text": "KibanaShuttingDownError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.KibanaShuttingDownError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"kibana_shutting_down_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.KibanaShuttingDownError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PdfWorkerOutOfMemoryError",
"type": "Class",
"tags": [],
"label": "PdfWorkerOutOfMemoryError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.PdfWorkerOutOfMemoryError",
"text": "PdfWorkerOutOfMemoryError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PdfWorkerOutOfMemoryError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"pdf_worker_out_of_memory_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PdfWorkerOutOfMemoryError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PdfWorkerOutOfMemoryError.humanFriendlyMessage",
"type": "Function",
"tags": [],
"label": "humanFriendlyMessage",
"description": [],
"signature": [
"() => string"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.QueueTimeoutError",
"type": "Class",
"tags": [],
"label": "QueueTimeoutError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.QueueTimeoutError",
"text": "QueueTimeoutError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.QueueTimeoutError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"queue_timeout_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.QueueTimeoutError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError",
"type": "Class",
"tags": [],
"label": "ReportingError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
},
" extends Error"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError.code",
"type": "string",
"tags": [
"note"
],
"label": "code",
"description": [
"\nA string that uniquely brands an error type. This is used to power telemetry\nabout reporting failures.\n"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "details",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError.toString",
"type": "Function",
"tags": [],
"label": "toString",
"description": [],
"signature": [
"() => string"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingSavedObjectNotFoundError",
"type": "Class",
"tags": [],
"label": "ReportingSavedObjectNotFoundError",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingSavedObjectNotFoundError",
"text": "ReportingSavedObjectNotFoundError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingSavedObjectNotFoundError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"reporting_saved_object_not_found_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingSavedObjectNotFoundError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.UnknownError",
"type": "Class",
"tags": [],
"label": "UnknownError",
"description": [
"\nAn unknown error has occurred. See details."
],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.UnknownError",
"text": "UnknownError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.UnknownError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"unknown_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.UnknownError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.VisualReportingSoftDisabledError",
"type": "Class",
"tags": [],
"label": "VisualReportingSoftDisabledError",
"description": [
"\nSpecial error case that should only occur on Cloud when trying to generate\na report on a Kibana instance that is too small to be running Chromium."
],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.VisualReportingSoftDisabledError",
"text": "VisualReportingSoftDisabledError"
},
" extends ",
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.ReportingError",
"text": "ReportingError"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.VisualReportingSoftDisabledError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"\"visual_reporting_soft_disabled_error\""
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.VisualReportingSoftDisabledError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.VisualReportingSoftDisabledError.humanFriendlyMessage",
"type": "Function",
"tags": [],
"label": "humanFriendlyMessage",
"description": [],
"signature": [
"() => string"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.buildKibanaPath",
"type": "Function",
"tags": [],
"label": "buildKibanaPath",
"description": [],
"signature": [
"({ basePath, appPath, spaceId }: Args) => string"
],
"path": "src/platform/packages/private/kbn-reporting/common/build_kibana_path.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.buildKibanaPath.$1",
"type": "Object",
"tags": [],
"label": "{ basePath, appPath, spaceId }",
"description": [],
"signature": [
"Args"
],
"path": "src/platform/packages/private/kbn-reporting/common/build_kibana_path.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.byteSizeValueToNumber",
"type": "Function",
"tags": [],
"label": "byteSizeValueToNumber",
"description": [],
"signature": [
"(value: number | ",
{
"pluginId": "@kbn/config-schema",
"scope": "common",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-common.ByteSizeValue",
"text": "ByteSizeValue"
},
") => number"
],
"path": "src/platform/packages/private/kbn-reporting/common/schema_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.byteSizeValueToNumber.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"number | ",
{
"pluginId": "@kbn/config-schema",
"scope": "common",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-common.ByteSizeValue",
"text": "ByteSizeValue"
}
],
"path": "src/platform/packages/private/kbn-reporting/common/schema_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.durationToNumber",
"type": "Function",
"tags": [],
"label": "durationToNumber",
"description": [],
"signature": [
"(value: number | moment.Duration) => number"
],
"path": "src/platform/packages/private/kbn-reporting/common/schema_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.durationToNumber.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"number | moment.Duration"
],
"path": "src/platform/packages/private/kbn-reporting/common/schema_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.numberToDuration",
"type": "Function",
"tags": [],
"label": "numberToDuration",
"description": [],
"signature": [
"(value: number | moment.Duration) => moment.Duration"
],
"path": "src/platform/packages/private/kbn-reporting/common/schema_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.numberToDuration.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"number | moment.Duration"
],
"path": "src/platform/packages/private/kbn-reporting/common/schema_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError",
"type": "Interface",
"tags": [],
"label": "ReportingError",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ReportingError.humanFriendlyMessage",
"type": "Function",
"tags": [],
"label": "humanFriendlyMessage",
"description": [
"\nReturn a message describing the error that is human friendly"
],
"signature": [
"(() => string) | undefined"
],
"path": "src/platform/packages/private/kbn-reporting/common/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.JOB_STATUS",
"type": "Enum",
"tags": [],
"label": "JOB_STATUS",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ALLOWED_JOB_CONTENT_TYPES",
"type": "Array",
"tags": [],
"label": "ALLOWED_JOB_CONTENT_TYPES",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.ILM_POLICY_NAME",
"type": "string",
"tags": [],
"label": "ILM_POLICY_NAME",
"description": [],
"signature": [
"\"kibana-reporting\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.JOB_COMPLETION_NOTIFICATIONS_SESSION_KEY",
"type": "string",
"tags": [],
"label": "JOB_COMPLETION_NOTIFICATIONS_SESSION_KEY",
"description": [],
"signature": [
"\"xpack.reporting.jobCompletionNotifications\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.LICENSE_TYPE_BASIC",
"type": "string",
"tags": [],
"label": "LICENSE_TYPE_BASIC",
"description": [],
"signature": [
"\"basic\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.LICENSE_TYPE_CLOUD_STANDARD",
"type": "string",
"tags": [],
"label": "LICENSE_TYPE_CLOUD_STANDARD",
"description": [],
"signature": [
"\"standard\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.LICENSE_TYPE_ENTERPRISE",
"type": "string",
"tags": [],
"label": "LICENSE_TYPE_ENTERPRISE",
"description": [],
"signature": [
"\"enterprise\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.LICENSE_TYPE_GOLD",
"type": "string",
"tags": [],
"label": "LICENSE_TYPE_GOLD",
"description": [],
"signature": [
"\"gold\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.LICENSE_TYPE_PLATINUM",
"type": "string",
"tags": [],
"label": "LICENSE_TYPE_PLATINUM",
"description": [],
"signature": [
"\"platinum\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.LICENSE_TYPE_TRIAL",
"type": "string",
"tags": [],
"label": "LICENSE_TYPE_TRIAL",
"description": [],
"signature": [
"\"trial\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.REPORT_TABLE_ID",
"type": "string",
"tags": [],
"label": "REPORT_TABLE_ID",
"description": [],
"signature": [
"\"reportJobListing\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.REPORT_TABLE_ROW_ID",
"type": "string",
"tags": [],
"label": "REPORT_TABLE_ROW_ID",
"description": [],
"signature": [
"\"reportJobRow\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.REPORTING_MANAGEMENT_HOME",
"type": "string",
"tags": [],
"label": "REPORTING_MANAGEMENT_HOME",
"description": [],
"signature": [
"\"/app/management/insightsAndAlerting/reporting\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.REPORTING_REDIRECT_APP",
"type": "string",
"tags": [],
"label": "REPORTING_REDIRECT_APP",
"description": [],
"signature": [
"\"/app/reportingRedirect\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.REPORTING_REDIRECT_LOCATOR_STORE_KEY",
"type": "string",
"tags": [],
"label": "REPORTING_REDIRECT_LOCATOR_STORE_KEY",
"description": [],
"signature": [
"\"__REPORTING_REDIRECT_LOCATOR_STORE_KEY__\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.UI_SETTINGS_CUSTOM_PDF_LOGO",
"type": "string",
"tags": [],
"label": "UI_SETTINGS_CUSTOM_PDF_LOGO",
"description": [],
"signature": [
"\"xpackReporting:customPdfLogo\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.UI_SETTINGS_DATEFORMAT_TZ",
"type": "string",
"tags": [],
"label": "UI_SETTINGS_DATEFORMAT_TZ",
"description": [],
"signature": [
"\"dateFormat:tz\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.UI_SETTINGS_SEARCH_INCLUDE_FROZEN",
"type": "string",
"tags": [],
"label": "UI_SETTINGS_SEARCH_INCLUDE_FROZEN",
"description": [],
"signature": [
"\"search:includeFrozen\""
],
"path": "src/platform/packages/private/kbn-reporting/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES",
"type": "Object",
"tags": [],
"label": "INTERNAL_ROUTES",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.MIGRATE",
"type": "Object",
"tags": [],
"label": "MIGRATE",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.MIGRATE.MIGRATE_ILM_POLICY",
"type": "string",
"tags": [],
"label": "MIGRATE_ILM_POLICY",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.MIGRATE.GET_ILM_POLICY_STATUS",
"type": "string",
"tags": [],
"label": "GET_ILM_POLICY_STATUS",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.DIAGNOSE",
"type": "Object",
"tags": [],
"label": "DIAGNOSE",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.DIAGNOSE.BROWSER",
"type": "string",
"tags": [],
"label": "BROWSER",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.DIAGNOSE.SCREENSHOT",
"type": "string",
"tags": [],
"label": "SCREENSHOT",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.JOBS",
"type": "Object",
"tags": [],
"label": "JOBS",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.JOBS.COUNT",
"type": "string",
"tags": [],
"label": "COUNT",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.JOBS.LIST",
"type": "string",
"tags": [],
"label": "LIST",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.JOBS.INFO_PREFIX",
"type": "string",
"tags": [],
"label": "INFO_PREFIX",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.JOBS.DELETE_PREFIX",
"type": "string",
"tags": [],
"label": "DELETE_PREFIX",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.JOBS.DOWNLOAD_PREFIX",
"type": "string",
"tags": [],
"label": "DOWNLOAD_PREFIX",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.HEALTH",
"type": "string",
"tags": [],
"label": "HEALTH",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.INTERNAL_ROUTES.GENERATE_PREFIX",
"type": "string",
"tags": [],
"label": "GENERATE_PREFIX",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PUBLIC_ROUTES",
"type": "Object",
"tags": [],
"label": "PUBLIC_ROUTES",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PUBLIC_ROUTES.GENERATE_PREFIX",
"type": "string",
"tags": [],
"label": "GENERATE_PREFIX",
"description": [
"/**\n * Public endpoint for POST URL strings and automated report generation\n * exportTypeId is added to the final path\n */"
],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PUBLIC_ROUTES.JOBS",
"type": "Object",
"tags": [],
"label": "JOBS",
"description": [],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PUBLIC_ROUTES.JOBS.DOWNLOAD_PREFIX",
"type": "string",
"tags": [],
"label": "DOWNLOAD_PREFIX",
"description": [
"/**\n * Public endpoint used by Watcher and automated report downloads\n * jobId is added to the final path\n */"
],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/reporting-common",
"id": "def-common.PUBLIC_ROUTES.JOBS.DELETE_PREFIX",
"type": "string",
"tags": [],
"label": "DELETE_PREFIX",
"description": [
"/**\n * Public endpoint potentially used to delete a report after download in automation\n * jobId is added to the final path\n */"
],
"path": "src/platform/packages/private/kbn-reporting/common/routes.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
]
}
}