2344 lines
86 KiB
JSON
2344 lines
86 KiB
JSON
|
{
|
||
|
|
"id": "reporting",
|
||
|
|
"client": {
|
||
|
|
"classes": [
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient",
|
||
|
|
"type": "Class",
|
||
|
|
"tags": [],
|
||
|
|
"label": "ReportingAPIClient",
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.Unnamed",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "Constructor",
|
||
|
|
"signature": [
|
||
|
|
"any"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "http",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibCoreHttpPluginApi",
|
||
|
|
"section": "def-public.HttpSetup",
|
||
|
|
"text": "HttpSetup"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 50,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L50"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 50,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L50"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.getReportURL",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getReportURL",
|
||
|
|
"signature": [
|
||
|
|
"(jobId: string) => string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "jobId",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 54,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L54"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 54,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L54"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.downloadReport",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "downloadReport",
|
||
|
|
"signature": [
|
||
|
|
"(jobId: string) => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "jobId",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 61,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L61"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 61,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L61"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.deleteReport",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "deleteReport",
|
||
|
|
"signature": [
|
||
|
|
"(jobId: string) => Promise<any>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "jobId",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 67,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L67"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 67,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L67"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.list",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "number",
|
||
|
|
"label": "page",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"number"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 73,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L73"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Array",
|
||
|
|
"label": "jobIds",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string[]"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 73,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L73"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"signature": [
|
||
|
|
"(page?: number, jobIds?: string[]) => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.JobQueueEntry",
|
||
|
|
"text": "JobQueueEntry"
|
||
|
|
},
|
||
|
|
"[]>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "list",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 73,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L73"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.total",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "total",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<number>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 86,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L86"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.getContent",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getContent",
|
||
|
|
"signature": [
|
||
|
|
"(jobId: string) => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.JobContent",
|
||
|
|
"text": "JobContent"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "jobId",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 92,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L92"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 92,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L92"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.getInfo",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getInfo",
|
||
|
|
"signature": [
|
||
|
|
"(jobId: string) => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "common",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-common.ReportApiJSON",
|
||
|
|
"text": "ReportApiJSON"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "jobId",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 98,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L98"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 98,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L98"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.findForJobIds",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Array",
|
||
|
|
"label": "jobIds",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string[]"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 104,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L104"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"signature": [
|
||
|
|
"(jobIds: string[]) => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "common",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-common.ReportDocument",
|
||
|
|
"text": "ReportDocument"
|
||
|
|
},
|
||
|
|
"[]>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "findForJobIds",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 104,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L104"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.getReportingJobPath",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "exportType",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 114,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L114"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "jobParams",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"JobParams"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 114,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L114"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"signature": [
|
||
|
|
"(exportType: string, jobParams: JobParams) => string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "getReportingJobPath",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 114,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L114"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.createReportingJob",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "exportType",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 122,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L122"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Any",
|
||
|
|
"label": "jobParams",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"any"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 122,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L122"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"signature": [
|
||
|
|
"(exportType: string, jobParams: any) => Promise<any>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "createReportingJob",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 122,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L122"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.getManagementLink",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "getManagementLink",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 136,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L136"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.getDownloadLink",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "jobId",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 139,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L139"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"signature": [
|
||
|
|
"(jobId: string) => string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "getDownloadLink",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 139,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L139"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.getServerBasePath",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => string"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "getServerBasePath",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 145,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L145"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.verifyConfig",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.DiagnoseResponse",
|
||
|
|
"text": "DiagnoseResponse"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "verifyConfig",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 150,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L150"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.verifyBrowser",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.DiagnoseResponse",
|
||
|
|
"text": "DiagnoseResponse"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "verifyBrowser",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 158,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L158"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingAPIClient.verifyScreenCapture",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.DiagnoseResponse",
|
||
|
|
"text": "DiagnoseResponse"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "verifyScreenCapture",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 166,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L166"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts",
|
||
|
|
"lineNumber": 47,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/lib/reporting_api_client.ts#L47"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"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"
|
||
|
|
],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingPublicPlugin.Unnamed",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "Constructor",
|
||
|
|
"signature": [
|
||
|
|
"any"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "initializerContext",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-public.PluginInitializerContext",
|
||
|
|
"text": "PluginInitializerContext"
|
||
|
|
},
|
||
|
|
"<object>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 107,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L107"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 107,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L107"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingPublicPlugin.setup",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "setup",
|
||
|
|
"signature": [
|
||
|
|
"(core: ",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-public.CoreSetup",
|
||
|
|
"text": "CoreSetup"
|
||
|
|
},
|
||
|
|
"<object, unknown>, { home, management, licensing, uiActions, share }: ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.ReportingPublicPluginSetupDendencies",
|
||
|
|
"text": "ReportingPublicPluginSetupDendencies"
|
||
|
|
},
|
||
|
|
") => ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.ReportingSetup",
|
||
|
|
"text": "ReportingSetup"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "core",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-public.CoreSetup",
|
||
|
|
"text": "CoreSetup"
|
||
|
|
},
|
||
|
|
"<object, unknown>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 112,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L112"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "{ home, management, licensing, uiActions, share }",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-public.ReportingPublicPluginSetupDendencies",
|
||
|
|
"text": "ReportingPublicPluginSetupDendencies"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 113,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L113"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 111,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L111"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingPublicPlugin.start",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "start",
|
||
|
|
"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"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "core",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "public",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-public.CoreStart",
|
||
|
|
"text": "CoreStart"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 175,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L175"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 175,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L175"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-public.ReportingPublicPlugin.stop",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "stop",
|
||
|
|
"signature": [
|
||
|
|
"() => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 194,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L194"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts",
|
||
|
|
"lineNumber": 85,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/plugin.ts#L85"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"functions": [
|
||
|
|
{
|
||
|
|
"id": "def-public.getDefaultLayoutSelectors",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => ",
|
||
|
|
"LayoutSelectorDictionary"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "getDefaultLayoutSelectors",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/index.ts",
|
||
|
|
"lineNumber": 14,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/index.ts#L14"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"initialIsOpen": false
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"interfaces": [],
|
||
|
|
"enums": [],
|
||
|
|
"misc": [],
|
||
|
|
"objects": [],
|
||
|
|
"start": {
|
||
|
|
"id": "def-public.ReportingStart",
|
||
|
|
"type": "Type",
|
||
|
|
"label": "ReportingStart",
|
||
|
|
"tags": [],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/public/index.ts",
|
||
|
|
"lineNumber": 23,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/public/index.ts#L23"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
"ReportingSetup"
|
||
|
|
],
|
||
|
|
"lifecycle": "start",
|
||
|
|
"initialIsOpen": true
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"server": {
|
||
|
|
"classes": [
|
||
|
|
{
|
||
|
|
"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"
|
||
|
|
},
|
||
|
|
"<object, object, ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingSetupDeps",
|
||
|
|
"text": "ReportingSetupDeps"
|
||
|
|
},
|
||
|
|
", ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingStartDeps",
|
||
|
|
"text": "ReportingStartDeps"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingPlugin.Unnamed",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "Constructor",
|
||
|
|
"signature": [
|
||
|
|
"any"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "context",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-server.PluginInitializerContext",
|
||
|
|
"text": "PluginInitializerContext"
|
||
|
|
},
|
||
|
|
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; 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; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
|
||
|
|
"ByteSizeValue",
|
||
|
|
"; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 30,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L30"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 30,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L30"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingPlugin.setup",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "setup",
|
||
|
|
"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"
|
||
|
|
},
|
||
|
|
") => {}"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "core",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-server.CoreSetup",
|
||
|
|
"text": "CoreSetup"
|
||
|
|
},
|
||
|
|
"<object, unknown>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 36,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L36"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "plugins",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingSetupDeps",
|
||
|
|
"text": "ReportingSetupDeps"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 36,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L36"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 36,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L36"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingPlugin.start",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "start",
|
||
|
|
"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"
|
||
|
|
},
|
||
|
|
") => {}"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "core",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-server.CoreStart",
|
||
|
|
"text": "CoreStart"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 105,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L105"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "plugins",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingStartDeps",
|
||
|
|
"text": "ReportingStartDeps"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 105,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L105"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 105,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L105"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
||
|
|
"lineNumber": 24,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/plugin.ts#L24"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore",
|
||
|
|
"type": "Class",
|
||
|
|
"tags": [],
|
||
|
|
"label": "ReportingCore",
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.Unnamed",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "Constructor",
|
||
|
|
"signature": [
|
||
|
|
"any"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "logger",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LevelLogger",
|
||
|
|
"text": "LevelLogger"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 58,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L58"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 58,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L58"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.pluginSetup",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "pluginSetup",
|
||
|
|
"signature": [
|
||
|
|
"(setupDeps: ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingInternalSetup",
|
||
|
|
"text": "ReportingInternalSetup"
|
||
|
|
},
|
||
|
|
") => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "setupDeps",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingInternalSetup",
|
||
|
|
"text": "ReportingInternalSetup"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 63,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L63"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 63,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L63"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.pluginStart",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "pluginStart",
|
||
|
|
"signature": [
|
||
|
|
"(startDeps: ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingInternalStart",
|
||
|
|
"text": "ReportingInternalStart"
|
||
|
|
},
|
||
|
|
") => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "startDeps",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingInternalStart",
|
||
|
|
"text": "ReportingInternalStart"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 71,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L71"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 71,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L71"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.pluginSetsUp",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "pluginSetsUp",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<boolean>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 79,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L79"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.pluginStartsUp",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "pluginStartsUp",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<boolean>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 90,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L90"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.pluginIsStarted",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "pluginIsStarted",
|
||
|
|
"signature": [
|
||
|
|
"() => boolean"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 97,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L97"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.setConfig",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "setConfig",
|
||
|
|
"signature": [
|
||
|
|
"(config: ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingConfig",
|
||
|
|
"text": "ReportingConfig"
|
||
|
|
},
|
||
|
|
") => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "config",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingConfig",
|
||
|
|
"text": "ReportingConfig"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 104,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L104"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 104,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L104"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.registerFeature",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "registerFeature",
|
||
|
|
"signature": [
|
||
|
|
"() => void"
|
||
|
|
],
|
||
|
|
"description": [
|
||
|
|
"\nRegisters reporting as an Elasticsearch feature for the purpose of toggling visibility based on roles."
|
||
|
|
],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 112,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L112"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getConfig",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getConfig",
|
||
|
|
"signature": [
|
||
|
|
"() => ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingConfig",
|
||
|
|
"text": "ReportingConfig"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 132,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L132"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getPluginStartDeps",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getPluginStartDeps",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingInternalStart",
|
||
|
|
"text": "ReportingInternalStart"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 142,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L142"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getExportTypesRegistry",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getExportTypesRegistry",
|
||
|
|
"signature": [
|
||
|
|
"() => ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ExportTypesRegistry",
|
||
|
|
"text": "ExportTypesRegistry"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 150,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L150"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getEsqueue",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getEsqueue",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ESQueueInstance",
|
||
|
|
"text": "ESQueueInstance"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 154,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L154"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getLicenseInfo",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getLicenseInfo",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<Record<string, ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LicenseCheckResult",
|
||
|
|
"text": "LicenseCheckResult"
|
||
|
|
},
|
||
|
|
">>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 158,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L158"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getScreenshotsObservable",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getScreenshotsObservable",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ScreenshotsObservableFn",
|
||
|
|
"text": "ScreenshotsObservableFn"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 168,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L168"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getPluginSetupDeps",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getPluginSetupDeps",
|
||
|
|
"signature": [
|
||
|
|
"() => ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingInternalSetup",
|
||
|
|
"text": "ReportingInternalSetup"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 177,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L177"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getElasticsearchService",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getElasticsearchService",
|
||
|
|
"signature": [
|
||
|
|
"() => ",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-server.ElasticsearchServiceSetup",
|
||
|
|
"text": "ElasticsearchServiceSetup"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 184,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L184"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getUiSettingsServiceFactory",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getUiSettingsServiceFactory",
|
||
|
|
"signature": [
|
||
|
|
"(savedObjectsClient: Pick<",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
||
|
|
"section": "def-server.SavedObjectsClient",
|
||
|
|
"text": "SavedObjectsClient"
|
||
|
|
},
|
||
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-server.IUiSettingsClient",
|
||
|
|
"text": "IUiSettingsClient"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "savedObjectsClient",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"Pick<",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
||
|
|
"section": "def-server.SavedObjectsClient",
|
||
|
|
"text": "SavedObjectsClient"
|
||
|
|
},
|
||
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 193,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L193"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 193,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L193"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getSpaceId",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getSpaceId",
|
||
|
|
"signature": [
|
||
|
|
"(request: ",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCoreHttpPluginApi",
|
||
|
|
"section": "def-server.KibanaRequest",
|
||
|
|
"text": "KibanaRequest"
|
||
|
|
},
|
||
|
|
"<unknown, unknown, unknown, any>, logger?: ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LevelLogger",
|
||
|
|
"text": "LevelLogger"
|
||
|
|
},
|
||
|
|
") => string | undefined"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "request",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCoreHttpPluginApi",
|
||
|
|
"section": "def-server.KibanaRequest",
|
||
|
|
"text": "KibanaRequest"
|
||
|
|
},
|
||
|
|
"<unknown, unknown, unknown, any>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 199,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L199"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "logger",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LevelLogger",
|
||
|
|
"text": "LevelLogger"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 199,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L199"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 199,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L199"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getFakeRequest",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getFakeRequest",
|
||
|
|
"signature": [
|
||
|
|
"(baseRequest: object, spaceId: string | undefined, logger?: ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LevelLogger",
|
||
|
|
"text": "LevelLogger"
|
||
|
|
},
|
||
|
|
") => ",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCoreHttpPluginApi",
|
||
|
|
"section": "def-server.KibanaRequest",
|
||
|
|
"text": "KibanaRequest"
|
||
|
|
},
|
||
|
|
"<unknown, unknown, unknown, any>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Uncategorized",
|
||
|
|
"label": "baseRequest",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"object"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 213,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L213"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "string",
|
||
|
|
"label": "spaceId",
|
||
|
|
"isRequired": false,
|
||
|
|
"signature": [
|
||
|
|
"string | undefined"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 213,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L213"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "logger",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LevelLogger",
|
||
|
|
"text": "LevelLogger"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 213,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L213"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 213,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L213"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingCore.getUiSettingsClient",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getUiSettingsClient",
|
||
|
|
"signature": [
|
||
|
|
"(request: ",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCoreHttpPluginApi",
|
||
|
|
"section": "def-server.KibanaRequest",
|
||
|
|
"text": "KibanaRequest"
|
||
|
|
},
|
||
|
|
"<unknown, unknown, unknown, any>, logger?: ",
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LevelLogger",
|
||
|
|
"text": "LevelLogger"
|
||
|
|
},
|
||
|
|
") => Promise<",
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCorePluginApi",
|
||
|
|
"section": "def-server.IUiSettingsClient",
|
||
|
|
"text": "IUiSettingsClient"
|
||
|
|
},
|
||
|
|
">"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "request",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "core",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibCoreHttpPluginApi",
|
||
|
|
"section": "def-server.KibanaRequest",
|
||
|
|
"text": "KibanaRequest"
|
||
|
|
},
|
||
|
|
"<unknown, unknown, unknown, any>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 233,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L233"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "logger",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.LevelLogger",
|
||
|
|
"text": "LevelLogger"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 233,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L233"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 233,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L233"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/core.ts",
|
||
|
|
"lineNumber": 50,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/core.ts#L50"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"functions": [],
|
||
|
|
"interfaces": [
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingSetupDeps",
|
||
|
|
"type": "Interface",
|
||
|
|
"label": "ReportingSetupDeps",
|
||
|
|
"description": [],
|
||
|
|
"tags": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"tags": [],
|
||
|
|
"id": "def-server.ReportingSetupDeps.licensing",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "licensing",
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 28,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L28"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "licensing",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibLicensingPluginApi",
|
||
|
|
"section": "def-server.LicensingPluginSetup",
|
||
|
|
"text": "LicensingPluginSetup"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"tags": [],
|
||
|
|
"id": "def-server.ReportingSetupDeps.features",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "features",
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 29,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L29"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "features",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibFeaturesPluginApi",
|
||
|
|
"section": "def-server.PluginSetupContract",
|
||
|
|
"text": "PluginSetupContract"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"tags": [],
|
||
|
|
"id": "def-server.ReportingSetupDeps.security",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "security",
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 30,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L30"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "security",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibSecurityPluginApi",
|
||
|
|
"section": "def-server.SecurityPluginSetup",
|
||
|
|
"text": "SecurityPluginSetup"
|
||
|
|
},
|
||
|
|
" | undefined"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"tags": [],
|
||
|
|
"id": "def-server.ReportingSetupDeps.spaces",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "spaces",
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 31,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L31"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "spaces",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibSpacesPluginApi",
|
||
|
|
"section": "def-server.SpacesPluginSetup",
|
||
|
|
"text": "SpacesPluginSetup"
|
||
|
|
},
|
||
|
|
" | undefined"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"tags": [],
|
||
|
|
"id": "def-server.ReportingSetupDeps.usageCollection",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "usageCollection",
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 32,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L32"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
"Pick<",
|
||
|
|
{
|
||
|
|
"pluginId": "usageCollection",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibUsageCollectionPluginApi",
|
||
|
|
"section": "def-server.CollectorSet",
|
||
|
|
"text": "CollectorSet"
|
||
|
|
},
|
||
|
|
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 27,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L27"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingStartDeps",
|
||
|
|
"type": "Interface",
|
||
|
|
"label": "ReportingStartDeps",
|
||
|
|
"description": [],
|
||
|
|
"tags": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"tags": [],
|
||
|
|
"id": "def-server.ReportingStartDeps.data",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "data",
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 36,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L36"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "data",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibDataPluginApi",
|
||
|
|
"section": "def-server.DataPluginStart",
|
||
|
|
"text": "DataPluginStart"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
||
|
|
"lineNumber": 35,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/types.ts#L35"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-server.ReportingConfig",
|
||
|
|
"type": "Interface",
|
||
|
|
"label": "ReportingConfig",
|
||
|
|
"signature": [
|
||
|
|
{
|
||
|
|
"pluginId": "reporting",
|
||
|
|
"scope": "server",
|
||
|
|
"docId": "kibReportingPluginApi",
|
||
|
|
"section": "def-server.ReportingConfig",
|
||
|
|
"text": "ReportingConfig"
|
||
|
|
},
|
||
|
|
" extends Config<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; 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; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
|
||
|
|
"ByteSizeValue",
|
||
|
|
"; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"tags": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"tags": [],
|
||
|
|
"id": "def-server.ReportingConfig.kbnConfig",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "kbnConfig",
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/config/config.ts",
|
||
|
|
"lineNumber": 58,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/config/config.ts#L58"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
"Config<KbnServerConfigType>"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/server/config/config.ts",
|
||
|
|
"lineNumber": 57,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/server/config/config.ts#L57"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"enums": [],
|
||
|
|
"misc": [],
|
||
|
|
"objects": []
|
||
|
|
},
|
||
|
|
"common": {
|
||
|
|
"classes": [
|
||
|
|
{
|
||
|
|
"id": "def-common.CancellationToken",
|
||
|
|
"type": "Class",
|
||
|
|
"tags": [],
|
||
|
|
"label": "CancellationToken",
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"id": "def-common.CancellationToken.Unnamed",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "Constructor",
|
||
|
|
"signature": [
|
||
|
|
"any"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
||
|
|
"lineNumber": 14,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/cancellation_token.ts#L14"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.CancellationToken.on",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "callback",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"Function"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
||
|
|
"lineNumber": 19,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/cancellation_token.ts#L19"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"signature": [
|
||
|
|
"(callback: Function) => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "on",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
||
|
|
"lineNumber": 19,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/cancellation_token.ts#L19"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.CancellationToken.cancel",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "cancel",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
||
|
|
"lineNumber": 32,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/cancellation_token.ts#L32"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.CancellationToken.isCancelled",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "isCancelled",
|
||
|
|
"signature": [
|
||
|
|
"() => boolean"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
||
|
|
"lineNumber": 37,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/cancellation_token.ts#L37"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
|
||
|
|
"lineNumber": 10,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/cancellation_token.ts#L10"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.Poller",
|
||
|
|
"type": "Class",
|
||
|
|
"tags": [],
|
||
|
|
"label": "Poller",
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"id": "def-common.Poller.Unnamed",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "Constructor",
|
||
|
|
"signature": [
|
||
|
|
"any"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [
|
||
|
|
{
|
||
|
|
"type": "Object",
|
||
|
|
"label": "options",
|
||
|
|
"isRequired": true,
|
||
|
|
"signature": [
|
||
|
|
"PollerOptions"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 32,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L32"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 32,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L32"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.Poller.getPollFrequency",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "getPollFrequency",
|
||
|
|
"signature": [
|
||
|
|
"() => number"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 45,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L45"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.Poller._poll",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "_poll",
|
||
|
|
"signature": [
|
||
|
|
"() => Promise<void>"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 49,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L49"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.Poller.start",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "start",
|
||
|
|
"signature": [
|
||
|
|
"() => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 76,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L76"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.Poller.stop",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "stop",
|
||
|
|
"signature": [
|
||
|
|
"() => void"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 89,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L89"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"id": "def-common.Poller.isRunning",
|
||
|
|
"type": "Function",
|
||
|
|
"label": "isRunning",
|
||
|
|
"signature": [
|
||
|
|
"() => boolean"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"children": [],
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 103,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L103"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/poller.ts",
|
||
|
|
"lineNumber": 21,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/poller.ts#L21"
|
||
|
|
},
|
||
|
|
"initialIsOpen": false
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"functions": [
|
||
|
|
{
|
||
|
|
"id": "def-common.getDefaultLayoutSelectors",
|
||
|
|
"type": "Function",
|
||
|
|
"children": [],
|
||
|
|
"signature": [
|
||
|
|
"() => ",
|
||
|
|
"LayoutSelectorDictionary"
|
||
|
|
],
|
||
|
|
"description": [],
|
||
|
|
"label": "getDefaultLayoutSelectors",
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/index.ts",
|
||
|
|
"lineNumber": 14,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/index.ts#L14"
|
||
|
|
},
|
||
|
|
"tags": [],
|
||
|
|
"returnComment": [],
|
||
|
|
"initialIsOpen": false
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"interfaces": [],
|
||
|
|
"enums": [],
|
||
|
|
"misc": [],
|
||
|
|
"objects": [
|
||
|
|
{
|
||
|
|
"id": "def-common.constants",
|
||
|
|
"type": "Object",
|
||
|
|
"label": "constants",
|
||
|
|
"tags": [],
|
||
|
|
"description": [],
|
||
|
|
"source": {
|
||
|
|
"path": "x-pack/plugins/reporting/common/index.ts",
|
||
|
|
"lineNumber": 10,
|
||
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/reporting/common/index.ts#L10"
|
||
|
|
},
|
||
|
|
"signature": [
|
||
|
|
"typeof ",
|
||
|
|
"x-pack/plugins/reporting/common/constants"
|
||
|
|
],
|
||
|
|
"initialIsOpen": false
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|