kibana/api_docs/infra.devdocs.json

{
  "id": "infra",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "start": {
      "parentPluginId": "infra",
      "id": "def-public.InfraClientStartExports",
      "type": "Interface",
      "tags": [],
      "label": "InfraClientStartExports",
      "description": [],
      "path": "x-pack/solutions/observability/plugins/infra/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "infra",
          "id": "def-public.InfraClientStartExports.inventoryViews",
          "type": "Object",
          "tags": [],
          "label": "inventoryViews",
          "description": [],
          "signature": [
            "InventoryViewsServiceStart"
          ],
          "path": "x-pack/solutions/observability/plugins/infra/public/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "infra",
          "id": "def-public.InfraClientStartExports.metricsExplorerViews",
          "type": "Object",
          "tags": [],
          "label": "metricsExplorerViews",
          "description": [],
          "signature": [
            "MetricsExplorerViewsServiceStart",
            " | undefined"
          ],
          "path": "x-pack/solutions/observability/plugins/infra/public/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "infra",
          "id": "def-public.InfraClientStartExports.telemetry",
          "type": "Object",
          "tags": [],
          "label": "telemetry",
          "description": [],
          "signature": [
            "ITelemetryClient"
          ],
          "path": "x-pack/solutions/observability/plugins/infra/public/types.ts",
          "deprecated": false,
          "trackAdoption": false
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "infra",
        "id": "def-server.InfraConfig",
        "type": "Interface",
        "tags": [],
        "label": "InfraConfig",
        "description": [],
        "path": "x-pack/solutions/observability/plugins/infra/common/plugin_config_types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraConfig.alerting",
            "type": "Object",
            "tags": [],
            "label": "alerting",
            "description": [],
            "signature": [
              "{ inventory_threshold: { group_by_page_size: number; }; metric_threshold: { group_by_page_size: number; }; }"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/common/plugin_config_types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraConfig.enabled",
            "type": "boolean",
            "tags": [],
            "label": "enabled",
            "description": [],
            "path": "x-pack/solutions/observability/plugins/infra/common/plugin_config_types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraConfig.inventory",
            "type": "Object",
            "tags": [],
            "label": "inventory",
            "description": [],
            "signature": [
              "{ compositeSize: number; }"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/common/plugin_config_types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraConfig.sources",
            "type": "Object",
            "tags": [],
            "label": "sources",
            "description": [],
            "signature": [
              "{ default?: { fields?: { message?: string[] | undefined; } | undefined; } | undefined; } | undefined"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/common/plugin_config_types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraConfig.featureFlags",
            "type": "Object",
            "tags": [],
            "label": "featureFlags",
            "description": [],
            "signature": [
              "{ customThresholdAlertsEnabled: boolean; logsUIEnabled: boolean; metricsExplorerEnabled: boolean; osqueryEnabled: boolean; inventoryThresholdAlertRuleEnabled: boolean; metricThresholdAlertRuleEnabled: boolean; logThresholdAlertRuleEnabled: boolean; alertsAndRulesDropdownEnabled: boolean; profilingEnabled: boolean; ruleFormV2Enabled: boolean; }"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/common/plugin_config_types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "infra",
        "id": "def-server.InfraRequestHandlerContext",
        "type": "Interface",
        "tags": [],
        "label": "InfraRequestHandlerContext",
        "description": [],
        "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraRequestHandlerContext.mlAnomalyDetectors",
            "type": "Object",
            "tags": [],
            "label": "mlAnomalyDetectors",
            "description": [],
            "signature": [
              "{ jobs(jobId?: string | undefined): Promise<{ count: number; jobs: ",
              "MlJob",
              "[]; }>; jobStats(jobId?: string | undefined): Promise<{ count: number; jobs: ",
              "MlJobStats",
              "[]; }>; datafeeds(datafeedId?: string | undefined): Promise<{ count: number; datafeeds: ",
              "MlDatafeed",
              "[]; }>; datafeedStats(datafeedId?: string | undefined): Promise<{ count: number; datafeeds: ",
              "MlDatafeedStats",
              "[]; }>; } | undefined"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraRequestHandlerContext.mlSystem",
            "type": "Object",
            "tags": [],
            "label": "mlSystem",
            "description": [],
            "signature": [
              "{ mlCapabilities(): Promise<",
              "MlCapabilitiesResponse",
              ">; mlInfo(): Promise<",
              "MlInfoResponse",
              ">; mlAnomalySearch<T>(searchParams: any, jobIds: string[]): Promise<",
              "SearchResponse",
              "<T, Record<string, ",
              "AggregationsAggregate",
              ">>>; } | undefined"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraRequestHandlerContext.spaceId",
            "type": "string",
            "tags": [],
            "label": "spaceId",
            "description": [],
            "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraRequestHandlerContext.savedObjectsClient",
            "type": "Object",
            "tags": [],
            "label": "savedObjectsClient",
            "description": [],
            "signature": [
              "SavedObjectsClientContract"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraRequestHandlerContext.uiSettingsClient",
            "type": "Object",
            "tags": [],
            "label": "uiSettingsClient",
            "description": [],
            "signature": [
              "IUiSettingsClient"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraRequestHandlerContext.getMetricsIndices",
            "type": "Function",
            "tags": [],
            "label": "getMetricsIndices",
            "description": [],
            "signature": [
              "() => Promise<string>"
            ],
            "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "infra",
            "id": "def-server.InfraRequestHandlerContext.entityManager",
            "type": "Object",
            "tags": [],
            "label": "entityManager",
            "description": [],
            "signature": [
              {
                "pluginId": "entityManager",
                "scope": "server",
                "docId": "kibEntityManagerPluginApi",
                "section": "def-server.EntityManagerServerPluginStart",
                "text": "EntityManagerServerPluginStart"
              }
            ],
            "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "infra",
      "id": "def-server.InfraPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "InfraPluginSetup",
      "description": [],
      "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "infra",
          "id": "def-server.InfraPluginSetup.inventoryViews",
          "type": "Uncategorized",
          "tags": [],
          "label": "inventoryViews",
          "description": [],
          "signature": [
            "void"
          ],
          "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "infra",
          "id": "def-server.InfraPluginSetup.metricsExplorerViews",
          "type": "Uncategorized",
          "tags": [],
          "label": "metricsExplorerViews",
          "description": [],
          "signature": [
            "void | undefined"
          ],
          "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
          "deprecated": false,
          "trackAdoption": false
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "infra",
      "id": "def-server.InfraPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "InfraPluginStart",
      "description": [],
      "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "infra",
          "id": "def-server.InfraPluginStart.inventoryViews",
          "type": "Object",
          "tags": [],
          "label": "inventoryViews",
          "description": [],
          "signature": [
            "InventoryViewsServiceStart"
          ],
          "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "infra",
          "id": "def-server.InfraPluginStart.metricsExplorerViews",
          "type": "Object",
          "tags": [],
          "label": "metricsExplorerViews",
          "description": [],
          "signature": [
            "MetricsExplorerViewsServiceStart",
            " | undefined"
          ],
          "path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
          "deprecated": false,
          "trackAdoption": false
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}