{ "id": "infra", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [ { "parentPluginId": "infra", "id": "def-public.InfraFormatterType", "type": "Enum", "tags": [], "label": "InfraFormatterType", "description": [], "path": "x-pack/plugins/infra/public/lib/lib.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "infra", "id": "def-public.InfraAppId", "type": "Type", "tags": [], "label": "InfraAppId", "description": [], "signature": [ "\"metrics\" | \"logs\"" ], "path": "x-pack/plugins/infra/public/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS", "type": "Object", "tags": [], "label": "FORMATTERS", "description": [], "path": "x-pack/plugins/infra/common/formatters/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS.number", "type": "Function", "tags": [], "label": "number", "description": [], "signature": [ "(val: number) => string" ], "path": "x-pack/plugins/infra/common/formatters/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS.number.$1", "type": "number", "tags": [], "label": "val", "description": [], "path": "x-pack/plugins/infra/common/formatters/number.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "infra", "id": "def-public.FORMATTERS.abbreviatedNumber", "type": "Function", "tags": [], "label": "abbreviatedNumber", "description": [ "// Because the implimentation for formatting large numbers is the same as formatting\n// bytes we are re-using the same code, we just format the number using the abbreviated number format." ], "signature": [ "(bytes: number) => string" ], "path": "x-pack/plugins/infra/common/formatters/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS.abbreviatedNumber.$1", "type": "number", "tags": [], "label": "bytes", "description": [], "path": "x-pack/plugins/infra/common/formatters/bytes.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "infra", "id": "def-public.FORMATTERS.bytes", "type": "Function", "tags": [], "label": "bytes", "description": [ "// bytes in bytes formatted string out" ], "signature": [ "(bytes: number) => string" ], "path": "x-pack/plugins/infra/common/formatters/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS.bytes.$1", "type": "number", "tags": [], "label": "bytes", "description": [], "path": "x-pack/plugins/infra/common/formatters/bytes.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "infra", "id": "def-public.FORMATTERS.bits", "type": "Function", "tags": [], "label": "bits", "description": [ "// bytes in bits formatted string out" ], "signature": [ "(bytes: number) => string" ], "path": "x-pack/plugins/infra/common/formatters/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS.bits.$1", "type": "number", "tags": [], "label": "bytes", "description": [], "path": "x-pack/plugins/infra/common/formatters/bytes.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "infra", "id": "def-public.FORMATTERS.percent", "type": "Function", "tags": [], "label": "percent", "description": [], "signature": [ "(val: number) => string" ], "path": "x-pack/plugins/infra/common/formatters/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS.percent.$1", "type": "number", "tags": [], "label": "val", "description": [], "path": "x-pack/plugins/infra/common/formatters/percent.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "infra", "id": "def-public.FORMATTERS.highPrecision", "type": "Function", "tags": [], "label": "highPrecision", "description": [], "signature": [ "(val: number) => string" ], "path": "x-pack/plugins/infra/common/formatters/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "infra", "id": "def-public.FORMATTERS.highPrecision.$1", "type": "number", "tags": [], "label": "val", "description": [], "path": "x-pack/plugins/infra/common/formatters/high_precision.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false } ], "start": { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports", "type": "Interface", "tags": [], "label": "InfraClientStartExports", "description": [], "path": "x-pack/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/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/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/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.locators", "type": "Object", "tags": [], "label": "locators", "description": [], "signature": [ "InfraLocators" ], "path": "x-pack/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.ContainerMetricsTable", "type": "Function", "tags": [], "label": "ContainerMetricsTable", "description": [], "signature": [ "(props: ", "UseNodeMetricsTableOptions", " & Partial<", "SourceProviderProps", ">) => JSX.Element" ], "path": "x-pack/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.ContainerMetricsTable.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "UseNodeMetricsTableOptions", " & Partial<", "SourceProviderProps", ">" ], "path": "x-pack/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.HostMetricsTable", "type": "Function", "tags": [], "label": "HostMetricsTable", "description": [], "signature": [ "(props: ", "UseNodeMetricsTableOptions", " & Partial<", "SourceProviderProps", ">) => JSX.Element" ], "path": "x-pack/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.HostMetricsTable.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "UseNodeMetricsTableOptions", " & Partial<", "SourceProviderProps", ">" ], "path": "x-pack/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.PodMetricsTable", "type": "Function", "tags": [], "label": "PodMetricsTable", "description": [], "signature": [ "(props: ", "UseNodeMetricsTableOptions", " & Partial<", "SourceProviderProps", ">) => JSX.Element" ], "path": "x-pack/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.PodMetricsTable.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "UseNodeMetricsTableOptions", " & Partial<", "SourceProviderProps", ">" ], "path": "x-pack/plugins/infra/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "infra", "id": "def-server.InfraConfig", "type": "Interface", "tags": [], "label": "InfraConfig", "description": [], "path": "x-pack/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/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/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/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/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": [ "{ metricsExplorerEnabled: boolean; }" ], "path": "x-pack/plugins/infra/common/plugin_config_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "infra", "id": "def-server.InfraRequestHandlerContext", "type": "Type", "tags": [], "label": "InfraRequestHandlerContext", "description": [], "signature": [ "InfraMlRequestHandlerContext", " & ", "InfraSpacesRequestHandlerContext" ], "path": "x-pack/plugins/infra/server/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "infra", "id": "def-server.InfraPluginSetup", "type": "Interface", "tags": [], "label": "InfraPluginSetup", "description": [], "path": "x-pack/plugins/infra/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "infra", "id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration", "type": "Function", "tags": [], "label": "defineInternalSourceConfiguration", "description": [], "signature": [ "(sourceId: string, sourceProperties: ", "InfraStaticSourceConfiguration", ") => void" ], "path": "x-pack/plugins/infra/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "infra", "id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration.$1", "type": "string", "tags": [], "label": "sourceId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/infra/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "infra", "id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration.$2", "type": "Object", "tags": [], "label": "sourceProperties", "description": [], "signature": [ "InfraStaticSourceConfiguration" ], "path": "x-pack/plugins/infra/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "infra", "id": "def-server.InfraPluginSetup.inventoryViews", "type": "Uncategorized", "tags": [], "label": "inventoryViews", "description": [], "signature": [ "void" ], "path": "x-pack/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/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/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/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/plugins/infra/server/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }