2523 lines
90 KiB
JSON
2523 lines
90 KiB
JSON
{
|
|
"id": "reporting",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ReportingAPIClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingAPIClient",
|
|
"text": "ReportingAPIClient"
|
|
},
|
|
" implements IReportingAPI"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-public.HttpSetup",
|
|
"text": "HttpSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.Unnamed.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getReportURL",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getReportURL",
|
|
"description": [],
|
|
"signature": [
|
|
"(jobId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getReportURL.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "jobId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.downloadReport",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "downloadReport",
|
|
"description": [],
|
|
"signature": [
|
|
"(jobId: string) => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.downloadReport.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "jobId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.deleteReport",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deleteReport",
|
|
"description": [],
|
|
"signature": [
|
|
"(jobId: string) => Promise<any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.deleteReport.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "jobId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.list",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "list",
|
|
"description": [],
|
|
"signature": [
|
|
"(page?: number, jobIds?: string[]) => Promise<",
|
|
"Job",
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.list.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.list.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "jobIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.total",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getError",
|
|
"description": [],
|
|
"signature": [
|
|
"(jobId: string) => Promise<string>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getError.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "jobId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"(jobId: string) => Promise<",
|
|
"Job",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getInfo.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "jobId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.findForJobIds",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "findForJobIds",
|
|
"description": [],
|
|
"signature": [
|
|
"(jobIds: string[]) => Promise<",
|
|
"Job",
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.findForJobIds.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "jobIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getReportingJobPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getReportingJobPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(exportType: string, jobParams: { layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }) => string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getReportingJobPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "exportType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getReportingJobPath.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "jobParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.createReportingJob",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createReportingJob",
|
|
"description": [],
|
|
"signature": [
|
|
"(exportType: string, jobParams: { layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }) => Promise<",
|
|
"Job",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.createReportingJob.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "exportType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.createReportingJob.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "jobParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.createImmediateReport",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createImmediateReport",
|
|
"description": [],
|
|
"signature": [
|
|
"(baseParams: { layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }) => Promise<any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.createImmediateReport.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "baseParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getDecoratedJobParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDecoratedJobParams",
|
|
"description": [],
|
|
"signature": [
|
|
"<T extends Pick<{ layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }, \"title\" | \"layout\" | \"objectType\">>(baseParams: T) => { layout?: { id: string; dimensions?: { width: number; height: number; } | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getDecoratedJobParams.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "baseParams",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getManagementLink",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getManagementLink",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getDownloadLink",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDownloadLink",
|
|
"description": [],
|
|
"signature": [
|
|
"(jobId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getDownloadLink.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "jobId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.getServerBasePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getServerBasePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.verifyBrowser",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "verifyBrowser",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.verifyScreenCapture",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "verifyScreenCapture",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingAPIClient.migrateReportingIndicesIlmPolicy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "migrateReportingIndicesIlmPolicy",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ReportingPublicPlugin",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingPublicPlugin",
|
|
"text": "ReportingPublicPlugin"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
},
|
|
", ",
|
|
"ReportingPublicPluginSetupDendencies",
|
|
", ",
|
|
"ReportingPublicPluginStartDendencies",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initializerContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<object>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
"ReportingPublicPluginStartDendencies",
|
|
", unknown>, setupDeps: ",
|
|
"ReportingPublicPluginSetupDendencies",
|
|
") => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
"ReportingPublicPluginStartDendencies",
|
|
", unknown>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.setup.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "setupDeps",
|
|
"description": [],
|
|
"signature": [
|
|
"ReportingPublicPluginSetupDendencies"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingPublicPlugin.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ReportingStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/index.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ReportingCore",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getContract",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getContract",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
"LevelLogger"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; zoom: number; 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; }>[]; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; 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 | ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.ByteSizeValue",
|
|
"text": "ByteSizeValue"
|
|
},
|
|
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getKibanaPackageInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getKibanaPackageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/config",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigPluginApi",
|
|
"section": "def-server.PackageInfo",
|
|
"text": "PackageInfo"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.pluginSetup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pluginSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"(setupDeps: ",
|
|
"ReportingInternalSetup",
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.pluginSetup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "setupDeps",
|
|
"description": [],
|
|
"signature": [
|
|
"ReportingInternalSetup"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.pluginStart",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pluginStart",
|
|
"description": [],
|
|
"signature": [
|
|
"(startDeps: ",
|
|
"ReportingInternalStart",
|
|
") => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.pluginStart.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "startDeps",
|
|
"description": [],
|
|
"signature": [
|
|
"ReportingInternalStart"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.pluginSetsUp",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pluginSetsUp",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.pluginStartsUp",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pluginStartsUp",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.pluginIsStarted",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pluginIsStarted",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.setConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingConfig",
|
|
"text": "ReportingConfig"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.setConfig.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingConfig",
|
|
"text": "ReportingConfig"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.registerFeature",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerFeature",
|
|
"description": [
|
|
"\nIf xpack.reporting.roles.enabled === true, register Reporting as a feature\nthat is controlled by user role names"
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingConfig",
|
|
"text": "ReportingConfig"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getDeprecatedAllowedRoles",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDeprecatedAllowedRoles",
|
|
"description": [],
|
|
"signature": [
|
|
"() => false | string[]"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getPluginStartDeps",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPluginStartDeps",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"ReportingInternalStart",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getExportTypesRegistry",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExportTypesRegistry",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"ExportTypesRegistry"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.scheduleTask",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "scheduleTask",
|
|
"description": [],
|
|
"signature": [
|
|
"(report: ",
|
|
"ReportTaskParams",
|
|
"<",
|
|
"BasePayload",
|
|
">) => Promise<",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.ConcreteTaskInstance",
|
|
"text": "ConcreteTaskInstance"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.scheduleTask.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "report",
|
|
"description": [],
|
|
"signature": [
|
|
"ReportTaskParams",
|
|
"<",
|
|
"BasePayload",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getStore",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStore",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"ReportingStore",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getLicenseInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLicenseInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<Record<string, ",
|
|
"LicenseCheckResult",
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getEnableScreenshotMode",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEnableScreenshotMode",
|
|
"description": [],
|
|
"signature": [
|
|
"() => () => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getPluginSetupDeps",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPluginSetupDeps",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"ReportingInternalSetup"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getUiSettingsServiceFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUiSettingsServiceFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"(savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getUiSettingsServiceFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getSpaceId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceId",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>, logger?: ",
|
|
"LevelLogger",
|
|
") => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getSpaceId.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getSpaceId.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
"LevelLogger"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getFakeRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFakeRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(baseRequest: object, spaceId: string | undefined, logger?: ",
|
|
"LevelLogger",
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getFakeRequest.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "baseRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"object"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getFakeRequest.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getFakeRequest.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
"LevelLogger"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getUiSettingsClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUiSettingsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>, logger?: ",
|
|
"LevelLogger",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getUiSettingsClient.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getUiSettingsClient.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
"LevelLogger"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getDataViewsService",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDataViewsService",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewsService",
|
|
"text": "DataViewsService"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getDataViewsService.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getDataService",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDataService",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStart",
|
|
"text": "DataPluginStart"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.getEsClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IClusterClient",
|
|
"text": "IClusterClient"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.trackReport",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "trackReport",
|
|
"description": [],
|
|
"signature": [
|
|
"(reportId: string) => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.trackReport.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "reportId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.untrackReport",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "untrackReport",
|
|
"description": [],
|
|
"signature": [
|
|
"(reportId: string) => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.untrackReport.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "reportId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingCore.countConcurrentReports",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "countConcurrentReports",
|
|
"description": [],
|
|
"signature": [
|
|
"() => number"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ReportingPlugin",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingPlugin",
|
|
"text": "ReportingPlugin"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetupDeps",
|
|
"text": "ReportingSetupDeps"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingStartDeps",
|
|
"text": "ReportingStartDeps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; zoom: number; 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; }>[]; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; 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 | ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.ByteSizeValue",
|
|
"text": "ByteSizeValue"
|
|
},
|
|
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, plugins: ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetupDeps",
|
|
"text": "ReportingSetupDeps"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.setup.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetupDeps",
|
|
"text": "ReportingSetupDeps"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", plugins: ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingStartDeps",
|
|
"text": "ReportingStartDeps"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.start.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingStartDeps",
|
|
"text": "ReportingStartDeps"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReportingConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingConfig",
|
|
"text": "ReportingConfig"
|
|
},
|
|
" extends Config<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; zoom: number; 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; }>[]; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; 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 | ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.ByteSizeValue",
|
|
"text": "ByteSizeValue"
|
|
},
|
|
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/config/config.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingConfig.kbnConfig",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kbnConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"Config<KbnServerConfigType>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/config/config.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReportingSetupDeps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.licensing",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "licensing",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.LicensingPluginSetup",
|
|
"text": "LicensingPluginSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.features",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "features",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "features",
|
|
"scope": "server",
|
|
"docId": "kibFeaturesPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.screenshotMode",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "screenshotMode",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotMode",
|
|
"scope": "server",
|
|
"docId": "kibScreenshotModePluginApi",
|
|
"section": "def-server.ScreenshotModePluginSetup",
|
|
"text": "ScreenshotModePluginSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.security",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "security",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "security",
|
|
"scope": "server",
|
|
"docId": "kibSecurityPluginApi",
|
|
"section": "def-server.SecurityPluginSetup",
|
|
"text": "SecurityPluginSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.spaces",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "spaces",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesPluginSetup",
|
|
"text": "SpacesPluginSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.taskManager",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "taskManager",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskManagerSetupContract",
|
|
"text": "TaskManagerSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.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/reporting/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReportingStartDeps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStart",
|
|
"text": "DataPluginStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.taskManager",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "taskManager",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"TaskScheduling",
|
|
", \"schedule\" | \"runNow\" | \"ephemeralRunNow\" | \"ensureScheduled\"> & Pick<",
|
|
"TaskStore",
|
|
", \"remove\" | \"fetch\" | \"get\"> & { removeIfExists: (id: string) => Promise<void>; } & { supportsEphemeralTasks: () => boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReportingSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetup.usesUiCapabilities",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "usesUiCapabilities",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.CancellationToken",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "CancellationToken",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.CancellationToken.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.CancellationToken.on",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "on",
|
|
"description": [],
|
|
"signature": [
|
|
"(callback: Function) => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.CancellationToken.on.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "callback",
|
|
"description": [],
|
|
"signature": [
|
|
"Function"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.CancellationToken.cancel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "cancel",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.CancellationToken.isCancelled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCancelled",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "Poller",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"PollerOptions"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller.getPollFrequency",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPollFrequency",
|
|
"description": [],
|
|
"signature": [
|
|
"() => number"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller._poll",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "_poll",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.Poller.isRunning",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isRunning",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-common.constants",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "constants",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
"x-pack/plugins/reporting/common/constants"
|
|
],
|
|
"path": "x-pack/plugins/reporting/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |