github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_alerts_ui_shared.devdocs.json

6566 lines
No EOL
242 KiB
JSON
Raw Blame History

{
"id": "@kbn/alerts-ui-shared",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AddMessageVariables",
"type": "Function",
"tags": [],
"label": "AddMessageVariables",
"description": [],
"signature": [
"({ buttonTitle, messageVariables, paramsProperty, onSelectEventHandler, showButtonTitle, }: React.PropsWithChildren<Props>) => JSX.Element"
],
"path": "packages/kbn-alerts-ui-shared/src/add_message_variables/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AddMessageVariables.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n buttonTitle,\n messageVariables,\n paramsProperty,\n onSelectEventHandler,\n showButtonTitle = false,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<Props>"
],
"path": "packages/kbn-alerts-ui-shared/src/add_message_variables/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertFieldsTable",
"type": "Function",
"tags": [],
"label": "AlertFieldsTable",
"description": [
"\nA paginated, filterable table to show alert object fields"
],
"signature": [
"React.NamedExoticComponent<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.AlertFieldsTableProps",
"text": "AlertFieldsTableProps"
},
"> & { readonly type: ({ alert, fields }: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.AlertFieldsTableProps",
"text": "AlertFieldsTableProps"
},
") => JSX.Element; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertFieldsTable.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertLifecycleStatusBadge",
"type": "Function",
"tags": [],
"label": "AlertLifecycleStatusBadge",
"description": [],
"signature": [
"React.NamedExoticComponent<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.AlertLifecycleStatusBadgeProps",
"text": "AlertLifecycleStatusBadgeProps"
},
"> & { readonly type: (props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.AlertLifecycleStatusBadgeProps",
"text": "AlertLifecycleStatusBadgeProps"
},
") => JSX.Element; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_lifecycle_status_badge/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertLifecycleStatusBadge.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBar",
"type": "Function",
"tags": [],
"label": "AlertsSearchBar",
"description": [],
"signature": [
"({ appName, disableQueryLanguageSwitcher, featureIds, ruleTypeId, query, filters, onQueryChange, onQuerySubmit, onFiltersUpdated, rangeFrom, rangeTo, showFilterBar, showDatePicker, showSubmitButton, placeholder, submitOnBlur, http, toasts, unifiedSearchBar, dataViewsService, }: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.AlertsSearchBarProps",
"text": "AlertsSearchBarProps"
},
") => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBar.$1",
"type": "Object",
"tags": [],
"label": "{\n appName,\n disableQueryLanguageSwitcher = false,\n featureIds = EMPTY_FEATURE_IDS,\n ruleTypeId,\n query,\n filters,\n onQueryChange,\n onQuerySubmit,\n onFiltersUpdated,\n rangeFrom,\n rangeTo,\n showFilterBar = false,\n showDatePicker = true,\n showSubmitButton = true,\n placeholder = SEARCH_BAR_PLACEHOLDER,\n submitOnBlur = false,\n http,\n toasts,\n unifiedSearchBar,\n dataViewsService,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.AlertsSearchBarProps",
"text": "AlertsSearchBarProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.MaintenanceWindowCallout",
"type": "Function",
"tags": [],
"label": "MaintenanceWindowCallout",
"description": [],
"signature": [
"({\n kibanaServices,\n categories,\n}: { kibanaServices: ",
"KibanaServices",
"; categories?: string[] | undefined; }) => JSX.Element | null"
],
"path": "packages/kbn-alerts-ui-shared/src/maintenance_window_callout/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.MaintenanceWindowCallout.$1",
"type": "Object",
"tags": [],
"label": "{\n kibanaServices,\n categories,\n}",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/maintenance_window_callout/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.MaintenanceWindowCallout.$1.kibanaServices",
"type": "Object",
"tags": [],
"label": "kibanaServices",
"description": [],
"signature": [
"KibanaServices"
],
"path": "packages/kbn-alerts-ui-shared/src/maintenance_window_callout/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.MaintenanceWindowCallout.$1.categories",
"type": "Array",
"tags": [],
"label": "categories",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/maintenance_window_callout/index.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ScrollableFlyoutTabbedContent",
"type": "Function",
"tags": [],
"label": "ScrollableFlyoutTabbedContent",
"description": [],
"signature": [
"(props: ",
"EuiTabbedContentProps",
") => JSX.Element"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ScrollableFlyoutTabbedContent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"EuiTabbedContentProps"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useAlertsDataView",
"type": "Function",
"tags": [],
"label": "useAlertsDataView",
"description": [
"\nComputes a {@link DataViewBase} object for alerts indices based on the provided feature ids\n"
],
"signature": [
"({ http, dataViewsService, toasts, featureIds, }: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseAlertsDataViewParams",
"text": "UseAlertsDataViewParams"
},
") => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseAlertsDataViewResult",
"text": "UseAlertsDataViewResult"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useAlertsDataView.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n dataViewsService,\n toasts,\n featureIds,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseAlertsDataViewParams",
"text": "UseAlertsDataViewParams"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"A {@link DataViewBase } object, intentionally not typed as a complete {@link DataView } object\nsince only Security Solution uses an actual in-memory data view (when `featureIds = ['siem']).\nIn all other cases the data view is computed from the index names and fields fetched from the\nalerting APIs."
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useCreateRule",
"type": "Function",
"tags": [],
"label": "useCreateRule",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseCreateRuleProps",
"text": "UseCreateRuleProps"
},
") => ",
"UseMutationResult",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">, ",
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.IHttpFetchError",
"text": "IHttpFetchError"
},
"<{ message: string; }>, { formData: ",
"CreateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">; }, unknown>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useCreateRule.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseCreateRuleProps",
"text": "UseCreateRuleProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useGetAlertsGroupAggregationsQuery",
"type": "Function",
"tags": [],
"label": "useGetAlertsGroupAggregationsQuery",
"description": [
"\nFetches alerts aggregations for a given groupByField.\n\nSome default aggregations are applied:\n- `groupByFields`, to get the buckets based on the provided grouping field,\n - `unitsCount`, to count the number of alerts in each bucket,\n- `unitsCount`, to count the total number of alerts targeted by the query,\n- `groupsCount`, to count the total number of groups.\n\nThe provided `aggregations` are applied within `groupByFields`. Here the `groupByField` runtime\nfield can be used to perform grouping-based aggregations.\n`groupByField` buckets computed over a field with a null/absent value are marked with the\n`isNullGroup` flag set to true and their key is set to the `--` string.\n\nApplies alerting RBAC through featureIds."
],
"signature": [
"<T>({ http, toasts, enabled, params, }: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseGetAlertsGroupAggregationsQueryProps",
"text": "UseGetAlertsGroupAggregationsQueryProps"
},
") => ",
"UseQueryResult",
"<",
"SearchResponseBody",
"<{}, T>, Error>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_get_alerts_group_aggregations_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useGetAlertsGroupAggregationsQuery.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n toasts,\n enabled = true,\n params,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseGetAlertsGroupAggregationsQueryProps",
"text": "UseGetAlertsGroupAggregationsQueryProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_get_alerts_group_aggregations_query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useHealthCheck",
"type": "Function",
"tags": [],
"label": "useHealthCheck",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseHealthCheckProps",
"text": "UseHealthCheckProps"
},
") => { isLoading: boolean; isInitialLoading: boolean; error: \"alertsError\" | \"encryptionError\" | \"apiKeysDisabledError\" | \"apiKeysAndEncryptionError\" | null; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useHealthCheck.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseHealthCheckProps",
"text": "UseHealthCheckProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadAlertingFrameworkHealth",
"type": "Function",
"tags": [],
"label": "useLoadAlertingFrameworkHealth",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseLoadAlertingFrameworkHealthProps",
"text": "UseLoadAlertingFrameworkHealthProps"
},
") => { data: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.AlertingFrameworkHealth",
"text": "AlertingFrameworkHealth"
},
" | undefined; isLoading: boolean; isInitialLoading: boolean; isSuccess: boolean; isError: boolean; error: unknown; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_alerting_framework_health.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadAlertingFrameworkHealth.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseLoadAlertingFrameworkHealthProps",
"text": "UseLoadAlertingFrameworkHealthProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_alerting_framework_health.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadRuleTypesQuery",
"type": "Function",
"tags": [],
"label": "useLoadRuleTypesQuery",
"description": [],
"signature": [
"({ http, toasts, filteredRuleTypes, registeredRuleTypes, enabled, }: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseRuleTypesProps",
"text": "UseRuleTypesProps"
},
") => { ruleTypesState: { isInitialLoad: boolean; isLoading: boolean; data: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeIndexWithDescriptions",
"text": "RuleTypeIndexWithDescriptions"
},
"; error: Error | null; }; hasAnyAuthorizedRuleType: boolean; authorizedRuleTypes: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeWithDescription",
"text": "RuleTypeWithDescription"
},
"[]; authorizedToReadAnyRules: boolean; authorizedToCreateAnyRules: boolean; isSuccess: boolean; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadRuleTypesQuery.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n toasts,\n filteredRuleTypes,\n registeredRuleTypes,\n enabled = true,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseRuleTypesProps",
"text": "UseRuleTypesProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadUiConfig",
"type": "Function",
"tags": [],
"label": "useLoadUiConfig",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseLoadUiConfigProps",
"text": "UseLoadUiConfigProps"
},
") => { data: ",
"UiConfig",
" | undefined; isLoading: boolean; isInitialLoading: boolean; isSuccess: boolean; isError: boolean; error: unknown; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadUiConfig.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseLoadUiConfigProps",
"text": "UseLoadUiConfigProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadUiHealth",
"type": "Function",
"tags": [],
"label": "useLoadUiHealth",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseLoadUiHealthProps",
"text": "UseLoadUiHealthProps"
},
") => { data: ",
"UiHealthCheck",
" | undefined; isLoading: boolean; isInitialLoading: boolean; isSuccess: boolean; isError: boolean; error: unknown; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_health.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useLoadUiHealth.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseLoadUiHealthProps",
"text": "UseLoadUiHealthProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_health.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useResolveRule",
"type": "Function",
"tags": [],
"label": "useResolveRule",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseResolveProps",
"text": "UseResolveProps"
},
") => { data: ",
"RuleFormData",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
"> | null | undefined; isLoading: boolean; isInitialLoading: boolean; isSuccess: boolean; isError: boolean; error: unknown; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_resolve_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useResolveRule.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseResolveProps",
"text": "UseResolveProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_resolve_rule.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useRuleAADFields",
"type": "Function",
"tags": [],
"label": "useRuleAADFields",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseRuleAADFieldsProps",
"text": "UseRuleAADFieldsProps"
},
") => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseRuleAADFieldsResult",
"text": "UseRuleAADFieldsResult"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useRuleAADFields.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseRuleAADFieldsProps",
"text": "UseRuleAADFieldsProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useUpdateRule",
"type": "Function",
"tags": [],
"label": "useUpdateRule",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseUpdateRuleProps",
"text": "UseUpdateRuleProps"
},
") => ",
"UseMutationResult",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">, ",
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.IHttpFetchError",
"text": "IHttpFetchError"
},
"<{ message: string; }>, { id: string; formData: ",
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">; }, unknown>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.useUpdateRule.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UseUpdateRuleProps",
"text": "UseUpdateRuleProps"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorFieldsProps",
"type": "Interface",
"tags": [],
"label": "ActionConnectorFieldsProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorFieldsProps.readOnly",
"type": "boolean",
"tags": [],
"label": "readOnly",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorFieldsProps.isEdit",
"type": "boolean",
"tags": [],
"label": "isEdit",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorFieldsProps.registerPreSubmitValidator",
"type": "Function",
"tags": [],
"label": "registerPreSubmitValidator",
"description": [],
"signature": [
"(validator: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ConnectorValidationFunc",
"text": "ConnectorValidationFunc"
},
") => void"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorFieldsProps.registerPreSubmitValidator.$1",
"type": "Function",
"tags": [],
"label": "validator",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ConnectorValidationFunc",
"text": "ConnectorValidationFunc"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps",
"type": "Interface",
"tags": [],
"label": "ActionConnectorProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnectorProps",
"text": "ActionConnectorProps"
},
"<Config, Secrets>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.secrets",
"type": "Uncategorized",
"tags": [],
"label": "secrets",
"description": [],
"signature": [
"Secrets"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.actionTypeId",
"type": "string",
"tags": [],
"label": "actionTypeId",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.referencedByCount",
"type": "number",
"tags": [],
"label": "referencedByCount",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.config",
"type": "Uncategorized",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Config"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.isPreconfigured",
"type": "boolean",
"tags": [],
"label": "isPreconfigured",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.isDeprecated",
"type": "boolean",
"tags": [],
"label": "isDeprecated",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.isSystemAction",
"type": "boolean",
"tags": [],
"label": "isSystemAction",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorProps.isMissingSecrets",
"type": "CompoundType",
"tags": [],
"label": "isMissingSecrets",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps",
"type": "Interface",
"tags": [],
"label": "ActionParamsProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionParamsProps",
"text": "ActionParamsProps"
},
"<TParams>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.actionParams",
"type": "Object",
"tags": [],
"label": "actionParams",
"description": [],
"signature": [
"{ [P in keyof TParams]?: TParams[P] | undefined; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.index",
"type": "number",
"tags": [],
"label": "index",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.editAction",
"type": "Function",
"tags": [],
"label": "editAction",
"description": [],
"signature": [
"(key: string, value: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttribute",
"text": "SavedObjectAttribute"
},
", index: number) => void"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.editAction.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.editAction.$2",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttribute",
"text": "SavedObjectAttribute"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.editAction.$3",
"type": "number",
"tags": [],
"label": "index",
"description": [],
"signature": [
"number"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormParamsErrors",
"text": "RuleFormParamsErrors"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.messageVariables",
"type": "Array",
"tags": [],
"label": "messageVariables",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.defaultMessage",
"type": "string",
"tags": [],
"label": "defaultMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.useDefaultMessage",
"type": "CompoundType",
"tags": [],
"label": "useDefaultMessage",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.actionConnector",
"type": "CompoundType",
"tags": [],
"label": "actionConnector",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>> | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.isLoading",
"type": "CompoundType",
"tags": [],
"label": "isLoading",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.isDisabled",
"type": "CompoundType",
"tags": [],
"label": "isDisabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.selectedActionGroupId",
"type": "string",
"tags": [],
"label": "selectedActionGroupId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.showEmailSubjectAndMessage",
"type": "CompoundType",
"tags": [],
"label": "showEmailSubjectAndMessage",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.executionMode",
"type": "CompoundType",
"tags": [],
"label": "executionMode",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnectorMode",
"text": "ActionConnectorMode"
},
" | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.onBlur",
"type": "Function",
"tags": [],
"label": "onBlur",
"description": [],
"signature": [
"((field?: string | undefined) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.onBlur.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.producerId",
"type": "string",
"tags": [],
"label": "producerId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionParamsProps.featureId",
"type": "string",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionReadOnlyElementProps",
"type": "Interface",
"tags": [],
"label": "ActionReadOnlyElementProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionReadOnlyElementProps.connectorId",
"type": "string",
"tags": [],
"label": "connectorId",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionReadOnlyElementProps.connectorName",
"type": "string",
"tags": [],
"label": "connectorName",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel",
"type": "Interface",
"tags": [],
"label": "ActionTypeModel",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<ActionConfig, ActionSecrets, ActionParams>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.iconClass",
"type": "CompoundType",
"tags": [],
"label": "iconClass",
"description": [],
"signature": [
"string | React.ComponentType<{}>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.selectMessage",
"type": "string",
"tags": [],
"label": "selectMessage",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.actionTypeTitle",
"type": "string",
"tags": [],
"label": "actionTypeTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.validateParams",
"type": "Function",
"tags": [],
"label": "validateParams",
"description": [],
"signature": [
"(actionParams: ActionParams) => Promise<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.GenericValidationResult",
"text": "GenericValidationResult"
},
"<unknown>>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.validateParams.$1",
"type": "Uncategorized",
"tags": [],
"label": "actionParams",
"description": [],
"signature": [
"ActionParams"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.actionConnectorFields",
"type": "CompoundType",
"tags": [],
"label": "actionConnectorFields",
"description": [],
"signature": [
"React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnectorFieldsProps",
"text": "ActionConnectorFieldsProps"
},
">> | null"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.actionParamsFields",
"type": "Function",
"tags": [],
"label": "actionParamsFields",
"description": [],
"signature": [
"React.ExoticComponent<(",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionParamsProps",
"text": "ActionParamsProps"
},
"<ActionParams> & React.RefAttributes<React.Component<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionParamsProps",
"text": "ActionParamsProps"
},
"<ActionParams>, any, any>>) | (",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionParamsProps",
"text": "ActionParamsProps"
},
"<ActionParams> & { children?: React.ReactNode; })> & { readonly _result: React.ComponentType<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionParamsProps",
"text": "ActionParamsProps"
},
"<ActionParams>>; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.actionParamsFields.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.actionReadOnlyExtraComponent",
"type": "Function",
"tags": [],
"label": "actionReadOnlyExtraComponent",
"description": [],
"signature": [
"React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionReadOnlyElementProps",
"text": "ActionReadOnlyElementProps"
},
">> | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.defaultActionParams",
"type": "Object",
"tags": [],
"label": "defaultActionParams",
"description": [],
"signature": [
"RecursivePartial",
"<ActionParams> | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.defaultRecoveredActionParams",
"type": "Object",
"tags": [],
"label": "defaultRecoveredActionParams",
"description": [],
"signature": [
"RecursivePartial",
"<ActionParams> | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.customConnectorSelectItem",
"type": "Object",
"tags": [],
"label": "customConnectorSelectItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.CustomConnectorSelectionItem",
"text": "CustomConnectorSelectionItem"
},
" | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.isExperimental",
"type": "CompoundType",
"tags": [],
"label": "isExperimental",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.subtype",
"type": "Array",
"tags": [],
"label": "subtype",
"description": [],
"signature": [
"{ id: string; name: string; }[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.convertParamsBetweenGroups",
"type": "Function",
"tags": [],
"label": "convertParamsBetweenGroups",
"description": [],
"signature": [
"((params: ActionParams) => {} | ActionParams) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.convertParamsBetweenGroups.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"ActionParams"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.hideInUi",
"type": "CompoundType",
"tags": [],
"label": "hideInUi",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.modalWidth",
"type": "number",
"tags": [],
"label": "modalWidth",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeModel.isSystemActionType",
"type": "CompoundType",
"tags": [],
"label": "isSystemActionType",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertFieldsTableProps",
"type": "Interface",
"tags": [],
"label": "AlertFieldsTableProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertFieldsTableProps.alert",
"type": "CompoundType",
"tags": [],
"label": "alert",
"description": [
"\nThe raw alert object"
],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.BasicFields",
"text": "BasicFields"
},
" & { \"@timestamp\"?: string[] | undefined; \"event.action\"?: string[] | undefined; tags?: string[] | undefined; kibana?: string[] | undefined; \"kibana.alert.rule.rule_type_id\"?: string[] | undefined; \"kibana.alert.rule.consumer\"?: string[] | undefined; \"kibana.alert.rule.execution.uuid\"?: string[] | undefined; \"kibana.alert.instance.id\"?: string[] | undefined; \"kibana.alert.rule.category\"?: string[] | undefined; \"kibana.alert.rule.name\"?: string[] | undefined; \"kibana.alert.rule.producer\"?: string[] | undefined; \"kibana.alert.rule.uuid\"?: string[] | undefined; \"kibana.alert.status\"?: string[] | undefined; \"kibana.alert.uuid\"?: string[] | undefined; \"kibana.space_ids\"?: string[] | undefined; \"event.kind\"?: string[] | undefined; \"kibana.alert.action_group\"?: string[] | undefined; \"kibana.alert.case_ids\"?: string[] | undefined; \"kibana.alert.duration.us\"?: string[] | undefined; \"kibana.alert.end\"?: string[] | undefined; \"kibana.alert.flapping\"?: string[] | undefined; \"kibana.alert.maintenance_window_ids\"?: string[] | undefined; \"kibana.alert.reason\"?: string[] | undefined; \"kibana.alert.rule.parameters\"?: string[] | undefined; \"kibana.alert.rule.tags\"?: string[] | undefined; \"kibana.alert.start\"?: string[] | undefined; \"kibana.alert.time_range\"?: string[] | undefined; \"kibana.alert.workflow_assignee_ids\"?: string[] | undefined; \"kibana.alert.workflow_status\"?: string[] | undefined; \"kibana.alert.workflow_tags\"?: string[] | undefined; \"kibana.version\"?: string[] | undefined; \"kibana.alert.context\"?: string[] | undefined; \"kibana.alert.evaluation.threshold\"?: string[] | undefined; \"kibana.alert.evaluation.value\"?: string[] | undefined; \"kibana.alert.evaluation.values\"?: string[] | undefined; \"kibana.alert.group\"?: string[] | undefined; \"ecs.version\"?: string[] | undefined; \"kibana.alert.risk_score\"?: string[] | undefined; \"kibana.alert.rule.author\"?: string[] | undefined; \"kibana.alert.rule.created_at\"?: string[] | undefined; \"kibana.alert.rule.created_by\"?: string[] | undefined; \"kibana.alert.rule.description\"?: string[] | undefined; \"kibana.alert.rule.enabled\"?: string[] | undefined; \"kibana.alert.rule.from\"?: string[] | undefined; \"kibana.alert.rule.interval\"?: string[] | undefined; \"kibana.alert.rule.license\"?: string[] | undefined; \"kibana.alert.rule.note\"?: string[] | undefined; \"kibana.alert.rule.references\"?: string[] | undefined; \"kibana.alert.rule.rule_id\"?: string[] | undefined; \"kibana.alert.rule.rule_name_override\"?: string[] | undefined; \"kibana.alert.rule.to\"?: string[] | undefined; \"kibana.alert.rule.type\"?: string[] | undefined; \"kibana.alert.rule.updated_at\"?: string[] | undefined; \"kibana.alert.rule.updated_by\"?: string[] | undefined; \"kibana.alert.rule.version\"?: string[] | undefined; \"kibana.alert.severity\"?: string[] | undefined; \"kibana.alert.suppression.docs_count\"?: string[] | undefined; \"kibana.alert.suppression.end\"?: string[] | undefined; \"kibana.alert.suppression.start\"?: string[] | undefined; \"kibana.alert.suppression.terms.field\"?: string[] | undefined; \"kibana.alert.suppression.terms.value\"?: string[] | undefined; \"kibana.alert.system_status\"?: string[] | undefined; \"kibana.alert.workflow_reason\"?: string[] | undefined; \"kibana.alert.workflow_user\"?: string[] | undefined; \"event.module\"?: string[] | undefined; \"kibana.alert.rule.threat.framework\"?: string[] | undefined; \"kibana.alert.rule.threat.tactic.id\"?: string[] | undefined; \"kibana.alert.rule.threat.tactic.name\"?: string[] | undefined; \"kibana.alert.rule.threat.tactic.reference\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.id\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.name\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.reference\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.subtechnique.id\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.subtechnique.name\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.subtechnique.reference\"?: string[] | undefined; \"kibana.alert.building_block_type\"?: string[] | undefined; \"kibana.alert\"?: string[] | undefined; \"kibana.alert.group.field\"?: string[] | undefined; \"kibana.alert.group.value\"?: string[] | undefined; \"kibana.alert.rule\"?: string[] | undefined; \"kibana.alert.rule.exceptions_list\"?: string[] | undefined; \"kibana.alert.rule.namespace\"?: string[] | undefined; \"kibana.alert.suppression.terms\"?: string[] | undefined; } & { [x: string]: unknown[]; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertFieldsTableProps.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [
"\nA list of alert field keys to be shown in the table.\nWhen not defined, all the fields are shown."
],
"signature": [
"(string | number)[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertLifecycleStatusBadgeProps",
"type": "Interface",
"tags": [],
"label": "AlertLifecycleStatusBadgeProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_lifecycle_status_badge/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertLifecycleStatusBadgeProps.alertStatus",
"type": "CompoundType",
"tags": [],
"label": "alertStatus",
"description": [],
"signature": [
"\"recovered\" | \"active\" | \"untracked\""
],
"path": "packages/kbn-alerts-ui-shared/src/alert_lifecycle_status_badge/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertLifecycleStatusBadgeProps.flapping",
"type": "CompoundType",
"tags": [],
"label": "flapping",
"description": [],
"signature": [
"string | boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_lifecycle_status_badge/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps",
"type": "Interface",
"tags": [],
"label": "AlertsSearchBarProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.appName",
"type": "string",
"tags": [],
"label": "appName",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.disableQueryLanguageSwitcher",
"type": "CompoundType",
"tags": [],
"label": "disableQueryLanguageSwitcher",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.featureIds",
"type": "Array",
"tags": [],
"label": "featureIds",
"description": [],
"signature": [
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.rangeFrom",
"type": "string",
"tags": [],
"label": "rangeFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.rangeTo",
"type": "string",
"tags": [],
"label": "rangeTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.showFilterBar",
"type": "CompoundType",
"tags": [],
"label": "showFilterBar",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.showDatePicker",
"type": "CompoundType",
"tags": [],
"label": "showDatePicker",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.showSubmitButton",
"type": "CompoundType",
"tags": [],
"label": "showSubmitButton",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.placeholder",
"type": "string",
"tags": [],
"label": "placeholder",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.submitOnBlur",
"type": "CompoundType",
"tags": [],
"label": "submitOnBlur",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQueryChange",
"type": "Function",
"tags": [],
"label": "onQueryChange",
"description": [],
"signature": [
"((query: { dateRange: { from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }; query?: string | undefined; }) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQueryChange.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQueryChange.$1.dateRange",
"type": "Object",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQueryChange.$1.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQuerySubmit",
"type": "Function",
"tags": [],
"label": "onQuerySubmit",
"description": [],
"signature": [
"(query: { dateRange: { from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }; query?: string | undefined; }) => void"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQuerySubmit.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQuerySubmit.$1.dateRange",
"type": "Object",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onQuerySubmit.$1.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onFiltersUpdated",
"type": "Function",
"tags": [],
"label": "onFiltersUpdated",
"description": [],
"signature": [
"((filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.onFiltersUpdated.$1",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.toasts",
"type": "Object",
"tags": [],
"label": "toasts",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-notifications-browser",
"scope": "public",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-public.IToasts",
"text": "IToasts"
}
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.unifiedSearchBar",
"type": "Function",
"tags": [],
"label": "unifiedSearchBar",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.StatefulSearchBarProps",
"text": "StatefulSearchBarProps"
},
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
">) => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.unifiedSearchBar.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Omit<",
"SearchBarOwnProps",
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
">, \"showSaveQuery\"> & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; saveQueryMenuVisibility?: ",
"SavedQueryMenuVisibility",
" | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; onFiltersUpdated?: ((filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void) | undefined; }"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.AlertsSearchBarProps.dataViewsService",
"type": "Object",
"tags": [],
"label": "dataViewsService",
"description": [],
"signature": [
"{ create: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", skipFetchFields?: boolean, displayErrors?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; delete: (indexPatternId: string) => Promise<void>; find: (search: string, size?: number) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]>; getCanSave: () => Promise<boolean>; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; findLazy: (search: string, size?: number) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
"[]>; getIdsWithTitle: (refresh?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewListItem",
"text": "DataViewListItem"
},
"[]>; getAllDataViewLazy: (refresh?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
"[]>; clearCache: () => void; clearInstanceCache: (id?: string | undefined) => void; getCache: () => Promise<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSavedObjectAttrs",
"text": "DataViewSavedObjectAttrs"
},
">[] | null | undefined>; getDefault: (displayErrors?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | null>; getDefaultId: () => Promise<string | null>; setDefault: (id: string | null, force?: boolean) => Promise<void>; hasUserDataView: () => Promise<boolean>; getMetaFields: () => Promise<string[] | undefined>; getShortDotsEnable: () => Promise<boolean | undefined>; getFieldsForWildcard: (options: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", options?: Omit<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
", \"allowNoIndex\"> | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
", displayErrors?: boolean, forceRefresh?: boolean) => Promise<void>; fieldArrayToMap: (fields: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[], fieldAttrs?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined) => ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewFieldMap",
"text": "DataViewFieldMap"
},
"; savedObjectToSpec: (savedObject: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewAttributes",
"text": "DataViewAttributes"
},
">) => ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"; getDataViewLazy: (id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; getDataViewLazyFromCache: (id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | undefined>; createDataViewLazy: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; createAndSaveDataViewLazy: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", overwrite?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; createAndSave: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; createSavedObject: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.AbstractDataView",
"text": "AbstractDataView"
},
", overwrite?: boolean) => Promise<void>; updateSavedObject: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.AbstractDataView",
"text": "AbstractDataView"
},
", saveAttempts?: number, ignoreErrors?: boolean, displayErrors?: boolean) => Promise<void>; defaultDataViewExists: () => Promise<boolean>; getDefaultDataViewLazy: () => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | null>; getDefaultDataView: (options?: { displayErrors?: boolean | undefined; refreshFields?: boolean | undefined; }) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | null>; toDataView: (dataViewLazy: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; toDataViewLazy: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ConnectorValidationError",
"type": "Interface",
"tags": [],
"label": "ConnectorValidationError",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ConnectorValidationError.message",
"type": "CompoundType",
"tags": [],
"label": "message",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.CustomConnectorSelectionItem",
"type": "Interface",
"tags": [],
"label": "CustomConnectorSelectionItem",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.CustomConnectorSelectionItem.getText",
"type": "Function",
"tags": [],
"label": "getText",
"description": [],
"signature": [
"(actionConnector: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>) => string"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.CustomConnectorSelectionItem.getText.$1",
"type": "CompoundType",
"tags": [],
"label": "actionConnector",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.CustomConnectorSelectionItem.getComponent",
"type": "Function",
"tags": [],
"label": "getComponent",
"description": [],
"signature": [
"(actionConnector: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>) => React.LazyExoticComponent<React.ComponentType<{ actionConnector: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>; }>> | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.CustomConnectorSelectionItem.getComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "actionConnector",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.EsQuerySnapshot",
"type": "Interface",
"tags": [],
"label": "EsQuerySnapshot",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/alerts_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.EsQuerySnapshot.request",
"type": "Array",
"tags": [],
"label": "request",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/alerts_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.EsQuerySnapshot.response",
"type": "Array",
"tags": [],
"label": "response",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/alerts_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterContextType",
"type": "Interface",
"tags": [],
"label": "FilterContextType",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterContextType.allControls",
"type": "Array",
"tags": [],
"label": "allControls",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterControlConfig",
"text": "FilterControlConfig"
},
"[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterContextType.addControl",
"type": "Function",
"tags": [],
"label": "addControl",
"description": [],
"signature": [
"(controls: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterControlConfig",
"text": "FilterControlConfig"
},
") => void"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterContextType.addControl.$1",
"type": "CompoundType",
"tags": [],
"label": "controls",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterControlConfig",
"text": "FilterControlConfig"
}
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps",
"type": "Interface",
"tags": [],
"label": "FilterGroupProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterGroupProps",
"text": "FilterGroupProps"
},
" extends Pick<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRuntimeState",
"text": "ControlGroupRuntimeState"
},
"<",
"DefaultControlState",
">, \"chainingSystem\">"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.spaceId",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.dataViewId",
"type": "CompoundType",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string | null"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.featureIds",
"type": "Array",
"tags": [],
"label": "featureIds",
"description": [],
"signature": [
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.onFiltersChange",
"type": "Function",
"tags": [],
"label": "onFiltersChange",
"description": [
"\nFilters changed callback"
],
"signature": [
"((newFilters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.onFiltersChange.$1",
"type": "Array",
"tags": [],
"label": "newFilters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.defaultControls",
"type": "Array",
"tags": [],
"label": "defaultControls",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterControlConfig",
"text": "FilterControlConfig"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.controlsUrlState",
"type": "Array",
"tags": [],
"label": "controlsUrlState",
"description": [
"\nThe controls configuration stored in the URL\n(takes precedence over the localStorage configuration)"
],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterControlConfig",
"text": "FilterControlConfig"
},
"[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.setControlsUrlState",
"type": "Function",
"tags": [],
"label": "setControlsUrlState",
"description": [
"\nSetter for the controls url state"
],
"signature": [
"((controls: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterControlConfig",
"text": "FilterControlConfig"
},
"[]) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.setControlsUrlState.$1",
"type": "Array",
"tags": [],
"label": "controls",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.FilterControlConfig",
"text": "FilterControlConfig"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.onInit",
"type": "Function",
"tags": [],
"label": "onInit",
"description": [
"\nInit callback"
],
"signature": [
"((controlGroupHandler: ",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRendererApi",
"text": "ControlGroupRendererApi"
},
" | undefined) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.onInit.$1",
"type": "CompoundType",
"tags": [],
"label": "controlGroupHandler",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRendererApi",
"text": "ControlGroupRendererApi"
},
" | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.maxControls",
"type": "number",
"tags": [],
"label": "maxControls",
"description": [
"\nMaximum number of controls that can be added to the group"
],
"signature": [
"number | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.ControlGroupRenderer",
"type": "Function",
"tags": [],
"label": "ControlGroupRenderer",
"description": [
"\nThe control embeddable renderer"
],
"signature": [
"(props: ",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRendererProps",
"text": "ControlGroupRendererProps"
},
") => JSX.Element"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.ControlGroupRenderer.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRendererProps",
"text": "ControlGroupRendererProps"
}
],
"path": "src/plugins/controls/public/control_group/external_api/control_group_renderer_lazy.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupProps.Storage",
"type": "Object",
"tags": [],
"label": "Storage",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.GenericValidationResult",
"type": "Interface",
"tags": [],
"label": "GenericValidationResult",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.GenericValidationResult",
"text": "GenericValidationResult"
},
"<T>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.GenericValidationResult.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ [P in Extract<keyof T, string>]: unknown; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.HealthStatus",
"type": "Interface",
"tags": [],
"label": "HealthStatus",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.HealthStatus.isRulesAvailable",
"type": "boolean",
"tags": [],
"label": "isRulesAvailable",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.HealthStatus.isSufficientlySecure",
"type": "boolean",
"tags": [],
"label": "isSufficientlySecure",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.HealthStatus.hasPermanentEncryptionKey",
"type": "boolean",
"tags": [],
"label": "hasPermanentEncryptionKey",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.LegacyField",
"type": "Interface",
"tags": [],
"label": "LegacyField",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/alerts_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.LegacyField.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/alerts_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.LegacyField.value",
"type": "Array",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/alerts_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.MinimumScheduleInterval",
"type": "Interface",
"tags": [],
"label": "MinimumScheduleInterval",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.MinimumScheduleInterval.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.MinimumScheduleInterval.enforce",
"type": "boolean",
"tags": [],
"label": "enforce",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors",
"type": "Interface",
"tags": [],
"label": "RuleFormBaseErrors",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors.name",
"type": "Array",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors.interval",
"type": "Array",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors.consumer",
"type": "Array",
"tags": [],
"label": "consumer",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors.ruleTypeId",
"type": "Array",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors.actionConnectors",
"type": "Array",
"tags": [],
"label": "actionConnectors",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors.alertDelay",
"type": "Array",
"tags": [],
"label": "alertDelay",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormBaseErrors.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormParamsErrors",
"type": "Interface",
"tags": [],
"label": "RuleFormParamsErrors",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleFormParamsErrors.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: string | string[] | RuleFormParamsErrors",
"description": [],
"signature": [
"[key: string]: string | string[] | ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormParamsErrors",
"text": "RuleFormParamsErrors"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel",
"type": "Interface",
"tags": [],
"label": "RuleTypeModel",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<Params>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.iconClass",
"type": "string",
"tags": [],
"label": "iconClass",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.documentationUrl",
"type": "CompoundType",
"tags": [],
"label": "documentationUrl",
"description": [],
"signature": [
"string | ((docLinks: ",
{
"pluginId": "@kbn/core-doc-links-browser",
"scope": "public",
"docId": "kibKbnCoreDocLinksBrowserPluginApi",
"section": "def-public.DocLinksStart",
"text": "DocLinksStart"
},
") => string) | null"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"(ruleParams: Params, isServerless?: boolean | undefined) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ValidationResult",
"text": "ValidationResult"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.validate.$1",
"type": "Uncategorized",
"tags": [],
"label": "ruleParams",
"description": [],
"signature": [
"Params"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.validate.$2",
"type": "CompoundType",
"tags": [],
"label": "isServerless",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.ruleParamsExpression",
"type": "Function",
"tags": [],
"label": "ruleParamsExpression",
"description": [],
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParamsExpressionProps",
"text": "RuleTypeParamsExpressionProps"
},
"<Params, Record<string, unknown>, string>>>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.ruleParamsExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.requiresAppContext",
"type": "boolean",
"tags": [],
"label": "requiresAppContext",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.defaultActionMessage",
"type": "string",
"tags": [],
"label": "defaultActionMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.defaultRecoveryMessage",
"type": "string",
"tags": [],
"label": "defaultRecoveryMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.defaultSummaryMessage",
"type": "string",
"tags": [],
"label": "defaultSummaryMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeModel.alertDetailsAppSection",
"type": "CompoundType",
"tags": [],
"label": "alertDetailsAppSection",
"description": [],
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<any>> | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps",
"type": "Interface",
"tags": [],
"label": "RuleTypeParamsExpressionProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParamsExpressionProps",
"text": "RuleTypeParamsExpressionProps"
},
"<Params, MetaData, ActionGroupIds>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.ruleParams",
"type": "Uncategorized",
"tags": [],
"label": "ruleParams",
"description": [],
"signature": [
"Params"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.ruleInterval",
"type": "string",
"tags": [],
"label": "ruleInterval",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.ruleThrottle",
"type": "string",
"tags": [],
"label": "ruleThrottle",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.alertNotifyWhen",
"type": "CompoundType",
"tags": [],
"label": "alertNotifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams",
"type": "Function",
"tags": [],
"label": "setRuleParams",
"description": [],
"signature": [
"<Key extends keyof Params>(property: Key, value: Params[Key] | undefined) => void"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams.$1",
"type": "Uncategorized",
"tags": [],
"label": "property",
"description": [],
"signature": [
"Key"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams.$2",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"Params[Key] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty",
"type": "Function",
"tags": [],
"label": "setRuleProperty",
"description": [],
"signature": [
"<Prop extends \"params\" | \"id\" | \"consumer\" | \"name\" | \"monitoring\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"mapped_params\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"apiKeyCreatedByUser\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\" | \"snoozeSchedule\" | \"activeSnoozes\" | \"isSnoozedUntil\" | \"lastRun\" | \"nextRun\" | \"revision\" | \"running\" | \"viewInAppRelativeUrl\" | \"alertDelay\" | \"flapping\" | \"ruleTypeId\">(key: Prop, value: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>[Prop] | null) => void"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty.$1",
"type": "Uncategorized",
"tags": [],
"label": "key",
"description": [],
"signature": [
"Prop"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty.$2",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>[Prop] | null"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.onChangeMetaData",
"type": "Function",
"tags": [],
"label": "onChangeMetaData",
"description": [],
"signature": [
"(metadata: MetaData) => void"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.onChangeMetaData.$1",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"MetaData"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormParamsErrors",
"text": "RuleFormParamsErrors"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.defaultActionGroupId",
"type": "string",
"tags": [],
"label": "defaultActionGroupId",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.actionGroups",
"type": "Array",
"tags": [],
"label": "actionGroups",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds>[]"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.metadata",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"MetaData | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.charts",
"type": "Object",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParamsExpressionProps.unifiedSearch",
"type": "Object",
"tags": [],
"label": "unifiedSearch",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewParams",
"type": "Interface",
"tags": [],
"label": "UseAlertsDataViewParams",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewParams.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewParams.dataViewsService",
"type": "Object",
"tags": [],
"label": "dataViewsService",
"description": [],
"signature": [
"{ create: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", skipFetchFields?: boolean, displayErrors?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; delete: (indexPatternId: string) => Promise<void>; find: (search: string, size?: number) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]>; getCanSave: () => Promise<boolean>; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; findLazy: (search: string, size?: number) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
"[]>; getIdsWithTitle: (refresh?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewListItem",
"text": "DataViewListItem"
},
"[]>; getAllDataViewLazy: (refresh?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
"[]>; clearCache: () => void; clearInstanceCache: (id?: string | undefined) => void; getCache: () => Promise<",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSavedObjectAttrs",
"text": "DataViewSavedObjectAttrs"
},
">[] | null | undefined>; getDefault: (displayErrors?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | null>; getDefaultId: () => Promise<string | null>; setDefault: (id: string | null, force?: boolean) => Promise<void>; hasUserDataView: () => Promise<boolean>; getMetaFields: () => Promise<string[] | undefined>; getShortDotsEnable: () => Promise<boolean | undefined>; getFieldsForWildcard: (options: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", options?: Omit<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
", \"allowNoIndex\"> | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
", displayErrors?: boolean, forceRefresh?: boolean) => Promise<void>; fieldArrayToMap: (fields: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[], fieldAttrs?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined) => ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewFieldMap",
"text": "DataViewFieldMap"
},
"; savedObjectToSpec: (savedObject: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewAttributes",
"text": "DataViewAttributes"
},
">) => ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"; getDataViewLazy: (id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; getDataViewLazyFromCache: (id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | undefined>; createDataViewLazy: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; createAndSaveDataViewLazy: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", overwrite?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; createAndSave: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; createSavedObject: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.AbstractDataView",
"text": "AbstractDataView"
},
", overwrite?: boolean) => Promise<void>; updateSavedObject: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.AbstractDataView",
"text": "AbstractDataView"
},
", saveAttempts?: number, ignoreErrors?: boolean, displayErrors?: boolean) => Promise<void>; defaultDataViewExists: () => Promise<boolean>; getDefaultDataViewLazy: () => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | null>; getDefaultDataView: (options?: { displayErrors?: boolean | undefined; refreshFields?: boolean | undefined; }) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | null>; toDataView: (dataViewLazy: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; toDataViewLazy: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
">; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewParams.toasts",
"type": "Object",
"tags": [],
"label": "toasts",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-notifications-browser",
"scope": "public",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-public.IToasts",
"text": "IToasts"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewParams.featureIds",
"type": "Array",
"tags": [],
"label": "featureIds",
"description": [
"\nArray of feature ids used for authorization and area-based filtering\n\nSecurity data views must be requested in isolation (i.e. `['siem']`). If mixed with\nother feature ids, the resulting data view will be empty."
],
"signature": [
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewResult",
"type": "Interface",
"tags": [],
"label": "UseAlertsDataViewResult",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewResult.isLoading",
"type": "boolean",
"tags": [],
"label": "isLoading",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseAlertsDataViewResult.dataView",
"type": "CompoundType",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
"(Omit<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
", \"fields\"> & { fields: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]; }) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_alerts_data_view.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseCreateRuleProps",
"type": "Interface",
"tags": [],
"label": "UseCreateRuleProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseCreateRuleProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseCreateRuleProps.onSuccess",
"type": "Function",
"tags": [],
"label": "onSuccess",
"description": [],
"signature": [
"((formData: ",
"CreateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseCreateRuleProps.onSuccess.$1",
"type": "Object",
"tags": [],
"label": "formData",
"description": [],
"signature": [
"CreateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseCreateRuleProps.onError",
"type": "Function",
"tags": [],
"label": "onError",
"description": [],
"signature": [
"((error: ",
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.IHttpFetchError",
"text": "IHttpFetchError"
},
"<{ message: string; }>) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseCreateRuleProps.onError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.IHttpFetchError",
"text": "IHttpFetchError"
},
"<{ message: string; }>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseGetAlertsGroupAggregationsQueryProps",
"type": "Interface",
"tags": [],
"label": "UseGetAlertsGroupAggregationsQueryProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_get_alerts_group_aggregations_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseGetAlertsGroupAggregationsQueryProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_get_alerts_group_aggregations_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseGetAlertsGroupAggregationsQueryProps.toasts",
"type": "Object",
"tags": [],
"label": "toasts",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-notifications-browser",
"scope": "public",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-public.IToasts",
"text": "IToasts"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_get_alerts_group_aggregations_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseGetAlertsGroupAggregationsQueryProps.enabled",
"type": "CompoundType",
"tags": [],
"label": "enabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_get_alerts_group_aggregations_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseGetAlertsGroupAggregationsQueryProps.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ featureIds: ",
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
},
"[]; groupByField: string; aggregations?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; filters?: ",
"QueryDslQueryContainer",
"[] | undefined; sort?: ",
"SortCombinations",
"[] | undefined; pageIndex?: number | undefined; pageSize?: number | undefined; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_get_alerts_group_aggregations_query.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseHealthCheckProps",
"type": "Interface",
"tags": [],
"label": "UseHealthCheckProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseHealthCheckProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseHealthCheckResult",
"type": "Interface",
"tags": [],
"label": "UseHealthCheckResult",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseHealthCheckResult.isLoading",
"type": "boolean",
"tags": [],
"label": "isLoading",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseHealthCheckResult.healthCheckError",
"type": "CompoundType",
"tags": [],
"label": "healthCheckError",
"description": [],
"signature": [
"HealthCheckErrors",
" | null"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_health_check.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseLoadAlertingFrameworkHealthProps",
"type": "Interface",
"tags": [],
"label": "UseLoadAlertingFrameworkHealthProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_alerting_framework_health.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseLoadAlertingFrameworkHealthProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_alerting_framework_health.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseLoadUiConfigProps",
"type": "Interface",
"tags": [],
"label": "UseLoadUiConfigProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseLoadUiConfigProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_config.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseLoadUiHealthProps",
"type": "Interface",
"tags": [],
"label": "UseLoadUiHealthProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_health.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseLoadUiHealthProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_ui_health.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseResolveProps",
"type": "Interface",
"tags": [],
"label": "UseResolveProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_resolve_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseResolveProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_resolve_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseResolveProps.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_resolve_rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleAADFieldsProps",
"type": "Interface",
"tags": [],
"label": "UseRuleAADFieldsProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleAADFieldsProps.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleAADFieldsProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleAADFieldsProps.toasts",
"type": "Object",
"tags": [],
"label": "toasts",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-notifications-browser",
"scope": "public",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-public.IToasts",
"text": "IToasts"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleAADFieldsResult",
"type": "Interface",
"tags": [],
"label": "UseRuleAADFieldsResult",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleAADFieldsResult.aadFields",
"type": "Array",
"tags": [],
"label": "aadFields",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
"[]"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleAADFieldsResult.loading",
"type": "boolean",
"tags": [],
"label": "loading",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_rule_aad_fields.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleTypesProps",
"type": "Interface",
"tags": [],
"label": "UseRuleTypesProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleTypesProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleTypesProps.toasts",
"type": "Object",
"tags": [],
"label": "toasts",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-notifications-browser",
"scope": "public",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-public.IToasts",
"text": "IToasts"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleTypesProps.filteredRuleTypes",
"type": "Array",
"tags": [],
"label": "filteredRuleTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleTypesProps.registeredRuleTypes",
"type": "Array",
"tags": [],
"label": "registeredRuleTypes",
"description": [],
"signature": [
"{ id: string; description: string; }[] | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseRuleTypesProps.enabled",
"type": "CompoundType",
"tags": [],
"label": "enabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_load_rule_types_query.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseUpdateRuleProps",
"type": "Interface",
"tags": [],
"label": "UseUpdateRuleProps",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseUpdateRuleProps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseUpdateRuleProps.onSuccess",
"type": "Function",
"tags": [],
"label": "onSuccess",
"description": [],
"signature": [
"((formData: ",
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseUpdateRuleProps.onSuccess.$1",
"type": "Object",
"tags": [],
"label": "formData",
"description": [],
"signature": [
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseUpdateRuleProps.onError",
"type": "Function",
"tags": [],
"label": "onError",
"description": [],
"signature": [
"((error: ",
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.IHttpFetchError",
"text": "IHttpFetchError"
},
"<{ message: string; }>) => void) | undefined"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UseUpdateRuleProps.onError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "public",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-public.IHttpFetchError",
"text": "IHttpFetchError"
},
"<{ message: string; }>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/hooks/use_update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ValidationResult",
"type": "Interface",
"tags": [],
"label": "ValidationResult",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ValidationResult.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnectorMode",
"type": "Enum",
"tags": [],
"label": "ActionConnectorMode",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionConnector",
"type": "Type",
"tags": [],
"label": "ActionConnector",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.PreConfiguredActionConnector",
"text": "PreConfiguredActionConnector"
},
" | ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.SystemAction",
"text": "SystemAction"
},
" | ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UserConfiguredActionConnector",
"text": "UserConfiguredActionConnector"
},
"<Config, Secrets>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ActionTypeRegistryContract",
"type": "Type",
"tags": [],
"label": "ActionTypeRegistryContract",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<Connector, Params, any>; list: () => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<Connector, Params, any>[]; register: (objectType: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<Connector, Params, any>) => void; has: (id: string) => boolean; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ConnectorValidationFunc",
"type": "Type",
"tags": [],
"label": "ConnectorValidationFunc",
"description": [],
"signature": [
"() => Promise<void | ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ConnectorValidationError",
"text": "ConnectorValidationError"
},
" | undefined>"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterControlConfig",
"type": "Type",
"tags": [],
"label": "FilterControlConfig",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.OptionsListControlState",
"text": "OptionsListControlState"
},
", \"dataViewId\"> & { persist?: boolean | undefined; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterGroupHandler",
"type": "Type",
"tags": [],
"label": "FilterGroupHandler",
"description": [],
"signature": [
{
"pluginId": "@kbn/presentation-containers",
"scope": "public",
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-public.PresentationContainer",
"text": "PresentationContainer"
},
" & ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.DefaultEmbeddableApi",
"text": "DefaultEmbeddableApi"
},
"<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupSerializedState",
"text": "ControlGroupSerializedState"
},
", ",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRuntimeState",
"text": "ControlGroupRuntimeState"
},
"<",
"DefaultControlState",
">> & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesFilters",
"text": "PublishesFilters"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesDataViews",
"text": "PublishesDataViews"
},
" & ",
{
"pluginId": "@kbn/presentation-containers",
"scope": "public",
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-public.HasSerializedChildState",
"text": "HasSerializedChildState"
},
"<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlPanelState",
"text": "ControlPanelState"
},
"<",
"DefaultControlState",
">> & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.HasEditCapabilities",
"text": "HasEditCapabilities"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesDataLoading",
"text": "PublishesDataLoading"
},
" & Pick<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesUnsavedChanges",
"text": "PublishesUnsavedChanges"
},
"<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRuntimeState",
"text": "ControlGroupRuntimeState"
},
"<",
"DefaultControlState",
">>, \"unsavedChanges\"> & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesTimeslice",
"text": "PublishesTimeslice"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesDisabledActionIds",
"text": "PublishesDisabledActionIds"
},
" & Partial<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.HasParentApi",
"text": "HasParentApi"
},
"<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesUnifiedSearch",
"text": "PublishesUnifiedSearch"
},
"> & ",
{
"pluginId": "@kbn/presentation-containers",
"scope": "public",
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-public.HasSaveNotification",
"text": "HasSaveNotification"
},
" & ",
"PublishesReload",
"> & { allowExpensiveQueries$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean>; autoApplySelections$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean>; ignoreParentSettings$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ParentIgnoreSettings",
"text": "ParentIgnoreSettings"
},
" | undefined>; labelPosition: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<",
"ControlStyle",
">; asyncResetUnsavedChanges: () => Promise<void>; controlFetch$: (controlUuid: string) => ",
"Observable",
"<",
"ControlFetchContext",
">; openAddDataControlFlyout: (options?: { controlStateTransform?: ",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlStateTransform",
"text": "ControlStateTransform"
},
"<",
"DefaultControlState",
"> | undefined; onSave?: (() => void) | undefined; } | undefined) => void; untilInitialized: () => Promise<void>; getEditorConfig: () => ",
"ControlGroupEditorConfig",
" | undefined; getLastSavedControlState: (controlUuid: string) => object; setChainingSystem: (chainingSystem: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupChainingSystem",
"text": "ControlGroupChainingSystem"
},
") => void; } & { reload: () => void; updateInput: (input: Partial<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRuntimeState",
"text": "ControlGroupRuntimeState"
},
"<",
"DefaultControlState",
">>) => void; getInput$: () => ",
"BehaviorSubject",
"<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRuntimeState",
"text": "ControlGroupRuntimeState"
},
"<",
"DefaultControlState",
">>; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.FilterUrlFormat",
"type": "Type",
"tags": [],
"label": "FilterUrlFormat",
"description": [],
"signature": [
"{ [x: string]: Pick<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.OptionsListControlState",
"text": "OptionsListControlState"
},
", \"selectedOptions\" | \"title\" | \"fieldName\" | \"existsSelected\" | \"exclude\">; }"
],
"path": "packages/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.PreConfiguredActionConnector",
"type": "Type",
"tags": [],
"label": "PreConfiguredActionConnector",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnectorProps",
"text": "ActionConnectorProps"
},
"<never, never>, \"config\" | \"secrets\"> & { isPreconfigured: true; isSystemAction: false; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.ResolvedRule",
"type": "Type",
"tags": [],
"label": "ResolvedRule",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ResolvedSanitizedRule",
"text": "ResolvedSanitizedRule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">, \"actions\" | \"alertTypeId\" | \"systemActions\"> & { ruleTypeId: string; actions: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.Rule",
"type": "Type",
"tags": [],
"label": "Rule",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>, \"actions\" | \"alertTypeId\" | \"systemActions\"> & { ruleTypeId: string; actions: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeIndexWithDescriptions",
"type": "Type",
"tags": [],
"label": "RuleTypeIndexWithDescriptions",
"description": [],
"signature": [
"Map<string, ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeWithDescription",
"text": "RuleTypeWithDescription"
},
">"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeParams",
"type": "Type",
"tags": [],
"label": "RuleTypeParams",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeRegistryContract",
"type": "Type",
"tags": [],
"label": "RuleTypeRegistryContract",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">; list: () => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">[]; register: (objectType: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void; has: (id: string) => boolean; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleTypeWithDescription",
"type": "Type",
"tags": [],
"label": "RuleTypeWithDescription",
"description": [],
"signature": [
{
"pluginId": "@kbn/triggers-actions-ui-types",
"scope": "common",
"docId": "kibKbnTriggersActionsUiTypesPluginApi",
"section": "def-common.RuleType",
"text": "RuleType"
},
"<string, string> & { description?: string | undefined; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.RuleUiAction",
"type": "Type",
"tags": [],
"label": "RuleUiAction",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedRuleAction",
"text": "SanitizedRuleAction"
},
" | ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleSystemAction",
"text": "RuleSystemAction"
}
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.SanitizedRule",
"type": "Type",
"tags": [],
"label": "SanitizedRule",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>, \"actions\" | \"alertTypeId\" | \"systemActions\"> & { ruleTypeId: string; actions: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.SanitizedRuleAction",
"type": "Type",
"tags": [],
"label": "SanitizedRuleAction",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleAction",
"text": "RuleAction"
},
", \"alertsFilter\"> & { alertsFilter?: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedAlertsFilter",
"text": "SanitizedAlertsFilter"
},
" | undefined; }"
],
"path": "packages/kbn-alerting-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.SystemAction",
"type": "Type",
"tags": [],
"label": "SystemAction",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnectorProps",
"text": "ActionConnectorProps"
},
"<never, never>, \"config\" | \"secrets\"> & { isSystemAction: true; isPreconfigured: false; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.UserConfiguredActionConnector",
"type": "Type",
"tags": [],
"label": "UserConfiguredActionConnector",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnectorProps",
"text": "ActionConnectorProps"
},
"<Config, Secrets> & { isPreconfigured: false; isSystemAction: false; }"
],
"path": "packages/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.search",
"type": "Object",
"tags": [],
"label": "search",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.search.box",
"type": "Object",
"tags": [],
"label": "box",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.search.box.incremental",
"type": "boolean",
"tags": [],
"label": "incremental",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.search.box.placeholder",
"type": "string",
"tags": [],
"label": "placeholder",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/alerts-ui-shared",
"id": "def-public.search.box.schema",
"type": "boolean",
"tags": [],
"label": "schema",
"description": [],
"path": "packages/kbn-alerts-ui-shared/src/alert_fields_table/index.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
]
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink