kibana/api_docs/kbn_search_errors.devdocs.json

389 lines
No EOL
12 KiB
JSON

{
"id": "@kbn/search-errors",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError",
"type": "Class",
"tags": [],
"label": "EsError",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-errors",
"scope": "common",
"docId": "kibKbnSearchErrorsPluginApi",
"section": "def-common.EsError",
"text": "EsError"
},
" extends Error"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError.attributes",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-types",
"scope": "common",
"docId": "kibKbnSearchTypesPluginApi",
"section": "def-common.IEsErrorAttributes",
"text": "IEsErrorAttributes"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "err",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-errors",
"scope": "common",
"docId": "kibKbnSearchErrorsPluginApi",
"section": "def-common.IEsError",
"text": "IEsError"
}
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError.Unnamed.$2",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError.Unnamed.$3",
"type": "Function",
"tags": [],
"label": "openInInspector",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError.getErrorMessage",
"type": "Function",
"tags": [],
"label": "getErrorMessage",
"description": [],
"signature": [
"() => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.EsError.getActions",
"type": "Function",
"tags": [],
"label": "getActions",
"description": [],
"signature": [
"() => React.JSX.Element[]"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.createEsError",
"type": "Function",
"tags": [],
"label": "createEsError",
"description": [],
"signature": [
"(err: ",
{
"pluginId": "@kbn/search-errors",
"scope": "common",
"docId": "kibKbnSearchErrorsPluginApi",
"section": "def-common.IEsError",
"text": "IEsError"
},
", openInInspector: () => void, services: ",
"Services",
", dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.AbstractDataView",
"text": "AbstractDataView"
},
" | undefined) => ",
{
"pluginId": "@kbn/search-errors",
"scope": "common",
"docId": "kibKbnSearchErrorsPluginApi",
"section": "def-common.EsError",
"text": "EsError"
}
],
"path": "src/platform/packages/shared/kbn-search-errors/src/create_es_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.createEsError.$1",
"type": "Object",
"tags": [],
"label": "err",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-errors",
"scope": "common",
"docId": "kibKbnSearchErrorsPluginApi",
"section": "def-common.IEsError",
"text": "IEsError"
}
],
"path": "src/platform/packages/shared/kbn-search-errors/src/create_es_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.createEsError.$2",
"type": "Function",
"tags": [],
"label": "openInInspector",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/create_es_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.createEsError.$3",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"Services"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/create_es_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.createEsError.$4",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.AbstractDataView",
"text": "AbstractDataView"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/create_es_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.isEsError",
"type": "Function",
"tags": [],
"label": "isEsError",
"description": [
"\nChecks if a given errors originated from Elasticsearch.\nThose params are assigned to the attributes property of an error.\n"
],
"signature": [
"(e: any) => boolean"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.isEsError.$1",
"type": "Any",
"tags": [],
"label": "e",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/es_error.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.renderSearchError",
"type": "Function",
"tags": [],
"label": "renderSearchError",
"description": [],
"signature": [
"(error: Error) => { title: string; body: React.ReactNode; actions?: React.ReactNode[] | undefined; } | undefined"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/render_search_error.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.renderSearchError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/render_search_error.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/search-errors",
"id": "def-common.IEsError",
"type": "Type",
"tags": [],
"label": "IEsError",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.KibanaServerError",
"text": "KibanaServerError"
},
"<",
{
"pluginId": "@kbn/search-types",
"scope": "common",
"docId": "kibKbnSearchTypesPluginApi",
"section": "def-common.IEsErrorAttributes",
"text": "IEsErrorAttributes"
},
">"
],
"path": "src/platform/packages/shared/kbn-search-errors/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}