kibana/api_docs/metrics_entities.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": [
                "Pick<",
                "KibanaClient",
                ", \"monitoring\" | \"security\" | \"create\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"emit\" | \"on\" | \"once\" | \"off\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
                "TransportRequestParams",
                ", options?: ",
                "TransportRequestOptions",
                " | undefined): ",
                "TransportRequestPromise",
                "<",
                "ApiResponse",
                "<Record<string, any>, 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": [
      {
        "parentPluginId": "metricsEntities",
        "id": "def-common.ELASTIC_NAME",
        "type": "string",
        "tags": [],
        "label": "ELASTIC_NAME",
        "description": [
          "\nGlobal prefix for all the transform jobs"
        ],
        "signature": [
          "\"estc\""
        ],
        "path": "x-pack/plugins/metrics_entities/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "metricsEntities",
        "id": "def-common.METRICS_ENTITIES_TRANSFORMS",
        "type": "string",
        "tags": [],
        "label": "METRICS_ENTITIES_TRANSFORMS",
        "description": [
          "\nTransforms route"
        ],
        "path": "x-pack/plugins/metrics_entities/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "metricsEntities",
        "id": "def-common.METRICS_ENTITIES_URL",
        "type": "string",
        "tags": [],
        "label": "METRICS_ENTITIES_URL",
        "description": [
          "\nBase route"
        ],
        "signature": [
          "\"/api/metrics_entities\""
        ],
        "path": "x-pack/plugins/metrics_entities/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "metricsEntities",
        "id": "def-common.PLUGIN_ID",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_ID",
        "description": [],
        "signature": [
          "\"metricsEntities\""
        ],
        "path": "x-pack/plugins/metrics_entities/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "metricsEntities",
        "id": "def-common.PLUGIN_NAME",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_NAME",
        "description": [],
        "signature": [
          "\"metrics_entities\""
        ],
        "path": "x-pack/plugins/metrics_entities/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}