kibana/api_docs/aiops.devdocs.json

{
  "id": "aiops",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "aiops",
        "id": "def-public.ChangePointDetection",
        "type": "Function",
        "tags": [],
        "label": "ChangePointDetection",
        "description": [
          "\nLazy-wrapped LogCategorizationAppStateProps React component"
        ],
        "signature": [
          "(props: React.PropsWithChildren<",
          "LogCategorizationAppStateProps",
          ">) => JSX.Element"
        ],
        "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "aiops",
            "id": "def-public.ChangePointDetection.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "props",
            "description": [
              "- properties specifying the data on which to run the analysis."
            ],
            "signature": [
              "React.PropsWithChildren<",
              "LogCategorizationAppStateProps",
              ">"
            ],
            "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "aiops",
        "id": "def-public.ExplainLogRateSpikes",
        "type": "Function",
        "tags": [],
        "label": "ExplainLogRateSpikes",
        "description": [
          "\nLazy-wrapped ExplainLogRateSpikesAppState React component"
        ],
        "signature": [
          "(props: React.PropsWithChildren<",
          "ExplainLogRateSpikesAppStateProps",
          ">) => JSX.Element"
        ],
        "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "aiops",
            "id": "def-public.ExplainLogRateSpikes.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "props",
            "description": [
              "- properties specifying the data on which to run the analysis."
            ],
            "signature": [
              "React.PropsWithChildren<",
              "ExplainLogRateSpikesAppStateProps",
              ">"
            ],
            "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "aiops",
        "id": "def-public.LogCategorization",
        "type": "Function",
        "tags": [],
        "label": "LogCategorization",
        "description": [
          "\nLazy-wrapped LogCategorizationAppStateProps React component"
        ],
        "signature": [
          "(props: React.PropsWithChildren<",
          "LogCategorizationAppStateProps",
          ">) => JSX.Element"
        ],
        "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "aiops",
            "id": "def-public.LogCategorization.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "props",
            "description": [
              "- properties specifying the data on which to run the analysis."
            ],
            "signature": [
              "React.PropsWithChildren<",
              "LogCategorizationAppStateProps",
              ">"
            ],
            "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "aiops",
      "id": "def-server.AiopsPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "AiopsPluginSetup",
      "description": [
        "\naiops plugin server setup contract"
      ],
      "path": "x-pack/plugins/aiops/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "aiops",
      "id": "def-server.AiopsPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "AiopsPluginStart",
      "description": [
        "\naiops plugin server start contract"
      ],
      "path": "x-pack/plugins/aiops/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "aiops",
        "id": "def-common.AIOPS_ENABLED",
        "type": "boolean",
        "tags": [],
        "label": "AIOPS_ENABLED",
        "description": [
          "\nThis is an internal hard coded feature flag so we can easily turn on/off the\n\"Explain log rate spikes UI\" during development until the first release."
        ],
        "signature": [
          "true"
        ],
        "path": "x-pack/plugins/aiops/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "aiops",
        "id": "def-common.CHANGE_POINT_DETECTION_ENABLED",
        "type": "boolean",
        "tags": [],
        "label": "CHANGE_POINT_DETECTION_ENABLED",
        "description": [],
        "signature": [
          "false"
        ],
        "path": "x-pack/plugins/aiops/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "aiops",
        "id": "def-common.PLUGIN_ID",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_ID",
        "description": [
          "\nPLUGIN_ID is used as a unique identifier for the aiops plugin"
        ],
        "signature": [
          "\"aiops\""
        ],
        "path": "x-pack/plugins/aiops/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "aiops",
        "id": "def-common.PLUGIN_NAME",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_NAME",
        "description": [
          "\nPLUGIN_NAME is used as the display name for the aiops plugin"
        ],
        "signature": [
          "\"AIOps\""
        ],
        "path": "x-pack/plugins/aiops/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}