kibana/api_docs/metrics_entities.devdocs.json
Stacey Gammon 2d982c0070
Update api docs (#123839)
* Support the docs scripts knowing which json files are specifically for dev docs.

* Update jest snapshot docs

* Update api docs
2022-01-27 09:48:49 -05:00

102 lines
No EOL
2.9 KiB
JSON

{
"id": "metricsEntities",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginSetup",
"type": "Interface",
"tags": [],
"label": "MetricsEntitiesPluginSetup",
"description": [],
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient",
"type": "Function",
"tags": [],
"label": "getMetricsEntitiesClient",
"description": [],
"signature": [
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
") => ",
"MetricsEntitiesClient"
],
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient.$1",
"type": "CompoundType",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"Omit<",
"KibanaClient",
", \"extend\" | \"connectionPool\" | \"transport\" | \"serializer\" | \"child\" | \"close\" | \"diagnostic\"> & { transport: { request<TResponse = unknown>(params: ",
"TransportRequestParams",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"TransportResult",
"<TResponse, unknown>>; }; }"
],
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"deprecated": false
}
]
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginStart",
"type": "Type",
"tags": [],
"label": "MetricsEntitiesPluginStart",
"description": [],
"signature": [
"void"
],
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}