kibana/api_docs/aiops.devdocs.json

1506 lines
No EOL
53 KiB
JSON

{
"id": "aiops",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetection",
"type": "Function",
"tags": [],
"label": "ChangePointDetection",
"description": [
"\nLazy-wrapped ChangePointDetectionAppStateProps React component"
],
"signature": [
"(props: ",
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.ChangePointDetectionAppStateProps",
"text": "ChangePointDetectionAppStateProps"
},
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetection.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [
"- properties specifying the data on which to run the analysis."
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.ChangePointDetectionAppStateProps",
"text": "ChangePointDetectionAppStateProps"
}
],
"path": "x-pack/platform/plugins/shared/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: ",
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogCategorizationAppStateProps",
"text": "LogCategorizationAppStateProps"
},
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogCategorization.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [
"- properties specifying the data on which to run the analysis."
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogCategorizationAppStateProps",
"text": "LogCategorizationAppStateProps"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysis",
"type": "Function",
"tags": [],
"label": "LogRateAnalysis",
"description": [
"\nLazy-wrapped LogRateAnalysisAppState React component"
],
"signature": [
"(props: ",
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogRateAnalysisAppStateProps",
"text": "LogRateAnalysisAppStateProps"
},
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysis.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [
"- properties specifying the data on which to run the analysis."
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogRateAnalysisAppStateProps",
"text": "LogRateAnalysisAppStateProps"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContent",
"type": "Function",
"tags": [],
"label": "LogRateAnalysisContent",
"description": [
"\nLazy-wrapped LogRateAnalysisContentWrapperReact component"
],
"signature": [
"(props: ",
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogRateAnalysisContentWrapperProps",
"text": "LogRateAnalysisContentWrapperProps"
},
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContent.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [
"- properties specifying the data on which to run the analysis."
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogRateAnalysisContentWrapperProps",
"text": "LogRateAnalysisContentWrapperProps"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/shared_lazy_components.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue",
"type": "Interface",
"tags": [],
"label": "AiopsAppContextValue",
"description": [
"\nAIOps app context value to be provided via React context."
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.analytics",
"type": "Object",
"tags": [],
"label": "analytics",
"description": [
"\nUsed for telemetry/performance metrics."
],
"signature": [
"{ optIn: (optInConfig: ",
"OptInConfig",
") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
"Observable",
"<",
"TelemetryCounter",
">; }"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.application",
"type": "Object",
"tags": [],
"label": "application",
"description": [
"\nUsed to check capabilities for links to other plugins.\n`application.currentAppId$` is used to close the log pattern analysis flyout\nwhen user navigates out of the current plugin."
],
"signature": [
"ApplicationStart"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [
"\nUsed for data fetching."
],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.executionContext",
"type": "Object",
"tags": [],
"label": "executionContext",
"description": [
"\nProvides execution context for data fetching."
],
"signature": [
"ExecutionContextSetup"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.charts",
"type": "CompoundType",
"tags": [],
"label": "charts",
"description": [
"\nRequired as a dependency for the fields stats service."
],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
},
" & { activeCursor: ",
"ActiveCursor",
"; }"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.fieldFormats",
"type": "CompoundType",
"tags": [],
"label": "fieldFormats",
"description": [
"\nRequired as a dependency for the fields stats service and\nused for date formatting in change point detection."
],
"signature": [
"Omit<",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
},
", \"init\" | \"register\"> & { deserialize: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FormatFactory",
"text": "FormatFactory"
},
"; }"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [
"\nUsed for data fetching."
],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.notifications",
"type": "Object",
"tags": [],
"label": "notifications",
"description": [
"\nUsed for toast notifications."
],
"signature": [
"NotificationsSetup"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.storage",
"type": "Object",
"tags": [],
"label": "storage",
"description": [
"\nUsed to store user settings in local storage."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorageWrapper",
"text": "IStorageWrapper"
},
"<any, void>"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.theme",
"type": "Object",
"tags": [],
"label": "theme",
"description": [
"\nTheme service."
],
"signature": [
"ThemeServiceSetup"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.uiSettings",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [
"\nUI settings."
],
"signature": [
"IUiSettingsClient"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.unifiedSearch",
"type": "Object",
"tags": [],
"label": "unifiedSearch",
"description": [
"\nUnified search."
],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.usageCollection",
"type": "Object",
"tags": [],
"label": "usageCollection",
"description": [
"\nUsage collection."
],
"signature": [
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.UsageCollectionSetup",
"text": "UsageCollectionSetup"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.userProfile",
"type": "Object",
"tags": [],
"label": "userProfile",
"description": [
"\nUser profile service."
],
"signature": [
"UserProfileService"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.share",
"type": "CompoundType",
"tags": [],
"label": "share",
"description": [
"\nUsed to create deep links to other plugins."
],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePublicStart",
"text": "SharePublicStart"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.lens",
"type": "Object",
"tags": [],
"label": "lens",
"description": [
"\nUsed to create lens embeddables."
],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensPublicStart",
"text": "LensPublicStart"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [
"\nUI actions."
],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsPublicStart",
"text": "UiActionsPublicStart"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.i18n",
"type": "Object",
"tags": [],
"label": "i18n",
"description": [
"\nInternationalisation service"
],
"signature": [
"I18nStart"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.fieldStats",
"type": "Object",
"tags": [],
"label": "fieldStats",
"description": [
"\nDeps for unified fields stats."
],
"signature": [
"{ useFieldStatsTrigger: <T = ",
{
"pluginId": "@kbn/ml-field-stats-flyout",
"scope": "public",
"docId": "kibKbnMlFieldStatsFlyoutPluginApi",
"section": "def-public.DropDownLabel",
"text": "DropDownLabel"
},
"<string>>() => { renderOption: (option: T) => React.ReactNode; setIsFlyoutVisible: (v: boolean) => void; setFieldName: (v: string | undefined) => void; handleFieldStatsButtonClick: (field: ",
{
"pluginId": "@kbn/ml-field-stats-flyout",
"scope": "public",
"docId": "kibKbnMlFieldStatsFlyoutPluginApi",
"section": "def-public.FieldForStats",
"text": "FieldForStats"
},
") => void; closeFlyout: () => void; optionCss: ",
"SerializedStyles",
"; populatedFields: Set<string> | undefined; }; FieldStatsFlyoutProvider: React.FC<",
{
"pluginId": "@kbn/ml-field-stats-flyout",
"scope": "public",
"docId": "kibKbnMlFieldStatsFlyoutPluginApi",
"section": "def-public.FieldStatsFlyoutProviderProps",
"text": "FieldStatsFlyoutProviderProps"
},
">; } | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.cases",
"type": "Object",
"tags": [],
"label": "cases",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CasesPublicStart",
"text": "CasesPublicStart"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.isServerless",
"type": "CompoundType",
"tags": [],
"label": "isServerless",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.embeddingOrigin",
"type": "string",
"tags": [],
"label": "embeddingOrigin",
"description": [
"Identifier to indicate the plugin utilizing the component"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsAppContextValue.observabilityAIAssistant",
"type": "Object",
"tags": [],
"label": "observabilityAIAssistant",
"description": [
"Observability AI Assistant"
],
"signature": [
{
"pluginId": "observabilityAIAssistant",
"scope": "public",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-public.ObservabilityAIAssistantPublicStart",
"text": "ObservabilityAIAssistantPublicStart"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/hooks/use_aiops_app_context.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetectionAppStateProps",
"type": "Interface",
"tags": [],
"label": "ChangePointDetectionAppStateProps",
"description": [
"\nProps for the ChangePointDetectionAppState component."
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/change_point_detection/change_point_detection_root.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetectionAppStateProps.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [
"The data view to analyze."
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/change_point_detection/change_point_detection_root.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetectionAppStateProps.savedSearch",
"type": "CompoundType",
"tags": [],
"label": "savedSearch",
"description": [
"The saved search to analyze."
],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
},
" | null"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/change_point_detection/change_point_detection_root.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetectionAppStateProps.appContextValue",
"type": "Object",
"tags": [],
"label": "appContextValue",
"description": [
"App context value"
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.AiopsAppContextValue",
"text": "AiopsAppContextValue"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/change_point_detection/change_point_detection_root.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.ChangePointDetectionAppStateProps.showFrozenDataTierChoice",
"type": "CompoundType",
"tags": [],
"label": "showFrozenDataTierChoice",
"description": [
"Optional flag to indicate whether kibana is running in serverless"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/change_point_detection/change_point_detection_root.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogCategorizationAppStateProps",
"type": "Interface",
"tags": [],
"label": "LogCategorizationAppStateProps",
"description": [
"\nProps for the LogCategorizationAppState component."
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_app_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogCategorizationAppStateProps.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [
"The data view to analyze."
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_app_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogCategorizationAppStateProps.savedSearch",
"type": "CompoundType",
"tags": [],
"label": "savedSearch",
"description": [
"The saved search to analyze."
],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
},
" | null"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_app_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogCategorizationAppStateProps.appContextValue",
"type": "Object",
"tags": [],
"label": "appContextValue",
"description": [
"App context value"
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.AiopsAppContextValue",
"text": "AiopsAppContextValue"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_app_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogCategorizationAppStateProps.showFrozenDataTierChoice",
"type": "CompoundType",
"tags": [],
"label": "showFrozenDataTierChoice",
"description": [
"Optional flag to indicate whether kibana is running in serverless"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_categorization/log_categorization_app_state.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisAppStateProps",
"type": "Interface",
"tags": [],
"label": "LogRateAnalysisAppStateProps",
"description": [
"\nProps for the LogRateAnalysisAppState component."
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisAppStateProps.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [
"The data view to analyze."
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisAppStateProps.savedSearch",
"type": "CompoundType",
"tags": [],
"label": "savedSearch",
"description": [
"The saved search to analyze."
],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
},
" | null"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisAppStateProps.appContextValue",
"type": "Object",
"tags": [],
"label": "appContextValue",
"description": [
"App context value"
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.AiopsAppContextValue",
"text": "AiopsAppContextValue"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisAppStateProps.showContextualInsights",
"type": "CompoundType",
"tags": [],
"label": "showContextualInsights",
"description": [
"Optional flag to indicate whether to show contextual insights"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisAppStateProps.showFrozenDataTierChoice",
"type": "CompoundType",
"tags": [],
"label": "showFrozenDataTierChoice",
"description": [
"Optional flag to indicate whether kibana is running in serverless"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps",
"type": "Interface",
"tags": [],
"label": "LogRateAnalysisContentWrapperProps",
"description": [
"\nProps for the LogRateAnalysisContentWrapper component."
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [
"The data view to analyze."
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.appContextValue",
"type": "Object",
"tags": [],
"label": "appContextValue",
"description": [
"App dependencies"
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.AiopsAppContextValue",
"text": "AiopsAppContextValue"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.initialAnalysisStart",
"type": "CompoundType",
"tags": [],
"label": "initialAnalysisStart",
"description": [
"Timestamp for start of initial analysis"
],
"signature": [
"number | ",
{
"pluginId": "@kbn/aiops-log-rate-analysis",
"scope": "common",
"docId": "kibKbnAiopsLogRateAnalysisPluginApi",
"section": "def-common.WindowParameters",
"text": "WindowParameters"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [
"Optional time range"
],
"signature": [
"{ min: moment.Moment; max: moment.Moment; } | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.esSearchQuery",
"type": "Object",
"tags": [],
"label": "esSearchQuery",
"description": [
"Elasticsearch query to pass to analysis endpoint"
],
"signature": [
"QueryDslQueryContainer",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.barColorOverride",
"type": "string",
"tags": [],
"label": "barColorOverride",
"description": [
"Optional color override for the default bar color for charts"
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.barHighlightColorOverride",
"type": "string",
"tags": [],
"label": "barHighlightColorOverride",
"description": [
"Optional color override for the highlighted bar color for charts"
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.onAnalysisCompleted",
"type": "Function",
"tags": [],
"label": "onAnalysisCompleted",
"description": [
"\nOptional callback that exposes data of the completed analysis"
],
"signature": [
"((d: ",
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogRateAnalysisResultsData",
"text": "LogRateAnalysisResultsData"
},
") => void) | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.onAnalysisCompleted.$1",
"type": "Object",
"tags": [],
"label": "d",
"description": [
"Log rate analysis results data"
],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.LogRateAnalysisResultsData",
"text": "LogRateAnalysisResultsData"
}
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisContentWrapperProps.showFrozenDataTierChoice",
"type": "CompoundType",
"tags": [],
"label": "showFrozenDataTierChoice",
"description": [
"Optional flag to indicate whether kibana is running in serverless"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisResultsData",
"type": "Interface",
"tags": [],
"label": "LogRateAnalysisResultsData",
"description": [
"\nInterface for log rate analysis results data."
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisResultsData.analysisType",
"type": "CompoundType",
"tags": [],
"label": "analysisType",
"description": [
"The type of analysis, whether it's a spike or dip"
],
"signature": [
"\"spike\" | \"dip\""
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisResultsData.significantItems",
"type": "Array",
"tags": [],
"label": "significantItems",
"description": [
"Statistically significant field/value items."
],
"signature": [
{
"pluginId": "@kbn/ml-agg-utils",
"scope": "common",
"docId": "kibKbnMlAggUtilsPluginApi",
"section": "def-common.SignificantItem",
"text": "SignificantItem"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.LogRateAnalysisResultsData.significantItemsGroups",
"type": "Array",
"tags": [],
"label": "significantItemsGroups",
"description": [
"Statistically significant groups of field/value items."
],
"signature": [
{
"pluginId": "@kbn/ml-agg-utils",
"scope": "common",
"docId": "kibKbnMlAggUtilsPluginApi",
"section": "def-common.SignificantItemGroup",
"text": "SignificantItemGroup"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "aiops",
"id": "def-public.AiopsPluginStart",
"type": "Interface",
"tags": [],
"label": "AiopsPluginStart",
"description": [],
"path": "x-pack/platform/plugins/shared/aiops/public/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.AiopsPluginStart.getPatternAnalysisAvailable",
"type": "Function",
"tags": [],
"label": "getPatternAnalysisAvailable",
"description": [],
"signature": [
"() => Promise<(dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
") => Promise<boolean>>"
],
"path": "x-pack/platform/plugins/shared/aiops/public/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsPluginStart.PatternAnalysisComponent",
"type": "CompoundType",
"tags": [],
"label": "PatternAnalysisComponent",
"description": [],
"signature": [
"React.ComponentClass<",
"LogCategorizationEmbeddableWrapperProps",
", any> | React.FunctionComponent<",
"LogCategorizationEmbeddableWrapperProps",
">"
],
"path": "x-pack/platform/plugins/shared/aiops/public/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsPluginStart.ChangePointDetectionComponent",
"type": "Function",
"tags": [],
"label": "ChangePointDetectionComponent",
"description": [],
"signature": [
"React.FunctionComponent<",
"ChangePointDetectionProps",
">"
],
"path": "x-pack/platform/plugins/shared/aiops/public/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "aiops",
"id": "def-public.AiopsPluginStart.ChangePointDetectionComponent.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "aiops",
"id": "def-public.AiopsPluginStart.ChangePointDetectionComponent.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "aiops",
"id": "def-public.AiopsPluginSetup",
"type": "Type",
"tags": [],
"label": "AiopsPluginSetup",
"description": [],
"signature": [
"void"
],
"path": "x-pack/platform/plugins/shared/aiops/public/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "setup",
"initialIsOpen": true
}
},
"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/platform/plugins/shared/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/platform/plugins/shared/aiops/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}