github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/triggers_actions_ui.devdocs.json

8845 lines
No EOL
322 KiB
JSON
Raw Permalink Blame History

{
"id": "triggersActionsUi",
"client": {
"classes": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin",
"type": "Class",
"tags": [],
"label": "Plugin",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
" implements ",
"Plugin",
"<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginSetup",
"text": "TriggersAndActionsUIPublicPluginSetup"
},
", ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginStart",
"text": "TriggersAndActionsUIPublicPluginStart"
},
", PluginsSetup, PluginsStart>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.experimentalFeatures",
"type": "Object",
"tags": [],
"label": "experimentalFeatures",
"description": [],
"signature": [
"{ readonly rulesListDatagrid: boolean; readonly stackAlertsPage: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; readonly ruleKqlBar: boolean; readonly isMustacheAutocompleteOn: boolean; readonly showMustacheAutocompleteSwitch: boolean; readonly alertDeletionSettingsEnabled: boolean; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
"PluginInitializerContext",
"<object>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
"CoreSetup",
"<{}, unknown>, plugins: PluginsSetup) => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginSetup",
"text": "TriggersAndActionsUIPublicPluginSetup"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"CoreSetup",
"<{}, unknown>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.setup.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"PluginsSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
"CoreStart",
", plugins: PluginsStart) => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginStart",
"text": "TriggersAndActionsUIPublicPluginStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"CoreStart"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.start.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"PluginsStart"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionForm",
"type": "Function",
"tags": [],
"label": "ActionForm",
"description": [],
"signature": [
"(props: ",
"ActionAccordionFormProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/action_connector_form/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionForm.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.bulkDeleteRules",
"type": "Function",
"tags": [],
"label": "bulkDeleteRules",
"description": [],
"signature": [
"({ filter, ids, http, }: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.BulkOperationAttributes",
"text": "BulkOperationAttributes"
},
") => Promise<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.BulkOperationResponse",
"text": "BulkOperationResponse"
},
">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/bulk_delete.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.bulkDeleteRules.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n filter,\n ids,\n http,\n}",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.BulkOperationAttributes",
"text": "BulkOperationAttributes"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/bulk_delete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.CreateConnectorFlyout",
"type": "Function",
"tags": [],
"label": "CreateConnectorFlyout",
"description": [],
"signature": [
"(props: ",
"CreateConnectorFlyoutProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/action_connector_form/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.CreateConnectorFlyout.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.EditConnectorFlyout",
"type": "Function",
"tags": [],
"label": "EditConnectorFlyout",
"description": [],
"signature": [
"(props: ",
"EditConnectorFlyoutProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/action_connector_form/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.EditConnectorFlyout.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.executeAction",
"type": "Function",
"tags": [],
"label": "executeAction",
"description": [],
"signature": [
"({\n id,\n params,\n http,\n signal,\n}: { id: string; http: ",
"HttpSetup",
"; params: Record<string, unknown>; signal?: AbortSignal | undefined; }) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionTypeExecutorResult",
"text": "ActionTypeExecutorResult"
},
"<R>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/execute.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.executeAction.$1",
"type": "Object",
"tags": [],
"label": "{\n id,\n params,\n http,\n signal,\n}",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/execute.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.executeAction.$1.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/execute.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.executeAction.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/execute.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.executeAction.$1.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/execute.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.executeAction.$1.signal",
"type": "Object",
"tags": [],
"label": "signal",
"description": [],
"signature": [
"AbortSignal | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/execute.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.fetchConnectorTypes",
"type": "Function",
"tags": [],
"label": "fetchConnectorTypes",
"description": [],
"signature": [
"({ http, featureId, includeSystemActions, }: { http: ",
"HttpSetup",
"; featureId?: string | undefined; includeSystemActions?: boolean | undefined; }) => Promise<",
{
"pluginId": "@kbn/actions-types",
"scope": "common",
"docId": "kibKbnActionsTypesPluginApi",
"section": "def-common.ActionType",
"text": "ActionType"
},
"[]>"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/apis/fetch_connector_types/fetch_connector_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.fetchConnectorTypes.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n featureId,\n includeSystemActions = false,\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/apis/fetch_connector_types/fetch_connector_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.fetchConnectorTypes.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/apis/fetch_connector_types/fetch_connector_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.fetchConnectorTypes.$1.featureId",
"type": "string",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/apis/fetch_connector_types/fetch_connector_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.fetchConnectorTypes.$1.includeSystemActions",
"type": "CompoundType",
"tags": [],
"label": "includeSystemActions",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/apis/fetch_connector_types/fetch_connector_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ForLastExpression",
"type": "Function",
"tags": [],
"label": "ForLastExpression",
"description": [],
"signature": [
"(props: ",
"ForLastExpressionProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/expression_items/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ForLastExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getFields",
"type": "Function",
"tags": [],
"label": "getFields",
"description": [],
"signature": [
"(http: ",
"HttpSetup",
", indexes: string[]) => Promise<",
"FieldOption",
"[]>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getFields.$1",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getFields.$2",
"type": "Array",
"tags": [],
"label": "indexes",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexOptions",
"type": "Function",
"tags": [],
"label": "getIndexOptions",
"description": [],
"signature": [
"(http: ",
"HttpSetup",
", pattern: string) => Promise<",
"IOption",
"[]>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexOptions.$1",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexOptions.$2",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeFieldOptions",
"type": "Function",
"tags": [],
"label": "getTimeFieldOptions",
"description": [],
"signature": [
"(fields: { type: string; name: string; }[]) => TimeFieldOptions[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/get_time_options.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeFieldOptions.$1",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"{ type: string; name: string; }[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/get_time_options.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeOptions",
"type": "Function",
"tags": [],
"label": "getTimeOptions",
"description": [],
"signature": [
"(unitSize: number) => { text: string; value: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TIME_UNITS",
"text": "TIME_UNITS"
},
"; }[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/get_time_options.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeOptions.$1",
"type": "number",
"tags": [],
"label": "unitSize",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/get_time_options.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeUnitLabel",
"type": "Function",
"tags": [],
"label": "getTimeUnitLabel",
"description": [],
"signature": [
"(timeUnit: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TIME_UNITS",
"text": "TIME_UNITS"
},
", timeValue: string) => string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/get_time_unit_label.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeUnitLabel.$1",
"type": "Enum",
"tags": [],
"label": "timeUnit",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TIME_UNITS",
"text": "TIME_UNITS"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/get_time_unit_label.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeUnitLabel.$2",
"type": "string",
"tags": [],
"label": "timeValue",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/get_time_unit_label.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByExpression",
"type": "Function",
"tags": [],
"label": "GroupByExpression",
"description": [],
"signature": [
"(props: ",
"GroupByExpressionProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/expression_items/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.hasMustacheTokens",
"type": "Function",
"tags": [],
"label": "hasMustacheTokens",
"description": [],
"signature": [
"(str: string) => boolean"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/has_mustache_tokens.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.hasMustacheTokens.$1",
"type": "string",
"tags": [],
"label": "str",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/has_mustache_tokens.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.JsonEditorWithMessageVariables",
"type": "Function",
"tags": [],
"label": "JsonEditorWithMessageVariables",
"description": [],
"signature": [
"({ buttonTitle, messageVariables, paramsProperty, inputTargetValue, label, errors, ariaLabel, onDocumentsChange, helpText, onBlur, showButtonTitle, dataTestSubj, euiCodeEditorProps, isOptionalField, }: Props) => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/json_editor_with_message_variables.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.JsonEditorWithMessageVariables.$1",
"type": "Object",
"tags": [],
"label": "{\n buttonTitle,\n messageVariables,\n paramsProperty,\n inputTargetValue,\n label,\n errors,\n ariaLabel,\n onDocumentsChange,\n helpText,\n onBlur,\n showButtonTitle,\n dataTestSubj,\n euiCodeEditorProps = {},\n isOptionalField = false,\n}",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/json_editor_with_message_variables.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.JsonFieldWrapper",
"type": "Function",
"tags": [],
"label": "JsonFieldWrapper",
"description": [],
"signature": [
"({ field, ...rest }: Props) => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/json_field_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.JsonFieldWrapper.$1",
"type": "Object",
"tags": [],
"label": "{ field, ...rest }",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/json_field_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRule",
"type": "Function",
"tags": [],
"label": "loadRule",
"description": [],
"signature": [
"({\n http,\n ruleId,\n}: { http: ",
"HttpSetup",
"; ruleId: string; }) => Promise<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRule.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n ruleId,\n}",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRule.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRule.$1.ruleId",
"type": "string",
"tags": [],
"label": "ruleId",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRuleAggregations",
"type": "Function",
"tags": [],
"label": "loadRuleAggregations",
"description": [],
"signature": [
"({\n http,\n searchText,\n actionTypesFilter,\n ruleExecutionStatusesFilter,\n ruleStatusesFilter,\n tagsFilter,\n ruleTypeIds,\n consumers,\n}: ",
"LoadRuleAggregationsProps",
") => Promise<",
"AggregateRulesResponse",
">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRuleAggregations.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n searchText,\n actionTypesFilter,\n ruleExecutionStatusesFilter,\n ruleStatusesFilter,\n tagsFilter,\n ruleTypeIds,\n consumers,\n}",
"description": [],
"signature": [
"LoadRuleAggregationsProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRuleSummary",
"type": "Function",
"tags": [],
"label": "loadRuleSummary",
"description": [],
"signature": [
"({\n http,\n ruleId,\n numberOfExecutions,\n}: { http: ",
"HttpSetup",
"; ruleId: string; numberOfExecutions?: number | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.AlertSummary",
"text": "AlertSummary"
},
">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRuleSummary.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n ruleId,\n numberOfExecutions,\n}",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRuleSummary.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRuleSummary.$1.ruleId",
"type": "string",
"tags": [],
"label": "ruleId",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadRuleSummary.$1.numberOfExecutions",
"type": "number",
"tags": [],
"label": "numberOfExecutions",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.MustacheTextFieldWrapper",
"type": "Function",
"tags": [],
"label": "MustacheTextFieldWrapper",
"description": [],
"signature": [
"({ field, euiFieldProps, idAria, ...rest }: Props) => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/mustache_text_field_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.MustacheTextFieldWrapper.$1",
"type": "Object",
"tags": [],
"label": "{ field, euiFieldProps, idAria, ...rest }",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/mustache_text_field_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.OfExpression",
"type": "Function",
"tags": [],
"label": "OfExpression",
"description": [],
"signature": [
"(props: ",
"OfExpressionProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/expression_items/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.OfExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.SectionLoading",
"type": "Function",
"tags": [],
"label": "SectionLoading",
"description": [],
"signature": [
"({ children }: Props) => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/section_loading.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.SectionLoading.$1",
"type": "Object",
"tags": [],
"label": "{ children }",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/section_loading.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.SimpleConnectorForm",
"type": "Function",
"tags": [],
"label": "SimpleConnectorForm",
"description": [],
"signature": [
"React.NamedExoticComponent<SimpleConnectorFormProps>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/simple_connector_form.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.SimpleConnectorForm.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.suspendedComponentWithProps",
"type": "Function",
"tags": [],
"label": "suspendedComponentWithProps",
"description": [],
"signature": [
"(ComponentToSuspend: React.ComponentType<T>, size: \"m\" | \"s\" | \"l\" | \"xl\" | \"xxl\" | undefined) => (props: T) => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.suspendedComponentWithProps.$1",
"type": "CompoundType",
"tags": [],
"label": "ComponentToSuspend",
"description": [],
"signature": [
"React.ComponentType<T>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.suspendedComponentWithProps.$2",
"type": "CompoundType",
"tags": [],
"label": "size",
"description": [],
"signature": [
"\"m\" | \"s\" | \"l\" | \"xl\" | \"xxl\" | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.templateActionVariable",
"type": "Function",
"tags": [],
"label": "templateActionVariable",
"description": [],
"signature": [
"(variable: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
") => string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/template_action_variable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.templateActionVariable.$1",
"type": "Object",
"tags": [],
"label": "variable",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/template_action_variable.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TextAreaWithMessageVariables",
"type": "Function",
"tags": [],
"label": "TextAreaWithMessageVariables",
"description": [],
"signature": [
"(props: Props) => React.ReactElement<any, any> | null"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/text_area_with_message_variables.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TextAreaWithMessageVariables.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/text_area_with_message_variables.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TextFieldWithMessageVariables",
"type": "Function",
"tags": [],
"label": "TextFieldWithMessageVariables",
"description": [],
"signature": [
"({ buttonTitle, messageVariables, paramsProperty, index, inputTargetValue, editAction, errors, formRowProps, defaultValue, wrapField, showButtonTitle, }: Props) => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/text_field_with_message_variables.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TextFieldWithMessageVariables.$1",
"type": "Object",
"tags": [],
"label": "{\n buttonTitle,\n messageVariables,\n paramsProperty,\n index,\n inputTargetValue,\n editAction,\n errors,\n formRowProps,\n defaultValue,\n wrapField = false,\n showButtonTitle,\n}",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/text_field_with_message_variables.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ThresholdExpression",
"type": "Function",
"tags": [],
"label": "ThresholdExpression",
"description": [],
"signature": [
"(props: ",
"ThresholdExpressionProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/expression_items/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ThresholdExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.transformRule",
"type": "Function",
"tags": [],
"label": "transformRule",
"description": [],
"signature": [
"({ rule_type_id: ruleTypeId, created_by: createdBy, updated_by: updatedBy, created_at: createdAt, updated_at: updatedAt, api_key_owner: apiKeyOwner, api_key_created_by_user: apiKeyCreatedByUser, notify_when: notifyWhen, mute_all: muteAll, muted_alert_ids: mutedInstanceIds, scheduled_task_id: scheduledTaskId, execution_status: executionStatus, actions: actions, snooze_schedule: snoozeSchedule, is_snoozed_until: isSnoozedUntil, active_snoozes: activeSnoozes, last_run: lastRun, next_run: nextRun, alert_delay: alertDelay, flapping, ...rest }: any) => any"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/common_transformations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.transformRule.$1",
"type": "Any",
"tags": [],
"label": "{\n rule_type_id: ruleTypeId,\n created_by: createdBy,\n updated_by: updatedBy,\n created_at: createdAt,\n updated_at: updatedAt,\n api_key_owner: apiKeyOwner,\n api_key_created_by_user: apiKeyCreatedByUser,\n notify_when: notifyWhen,\n mute_all: muteAll,\n muted_alert_ids: mutedInstanceIds,\n scheduled_task_id: scheduledTaskId,\n execution_status: executionStatus,\n actions: actions,\n snooze_schedule: snoozeSchedule,\n is_snoozed_until: isSnoozedUntil,\n active_snoozes: activeSnoozes,\n last_run: lastRun,\n next_run: nextRun,\n alert_delay: alertDelay,\n flapping,\n ...rest\n}",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/rule_api/common_transformations.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.updateActionConnector",
"type": "Function",
"tags": [],
"label": "updateActionConnector",
"description": [],
"signature": [
"({\n http,\n connector,\n id,\n}: { http: ",
"HttpSetup",
"; connector: Pick<",
"ActionConnectorWithoutId",
"<Record<string, unknown>, Record<string, unknown>>, \"config\" | \"secrets\" | \"name\">; id: string; }) => Promise<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/update.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.updateActionConnector.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n connector,\n id,\n}",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/update.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.updateActionConnector.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/update.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.updateActionConnector.$1.connector",
"type": "Object",
"tags": [],
"label": "connector",
"description": [],
"signature": [
"{ config: Record<string, unknown>; secrets: Record<string, unknown>; name: string; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/update.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.updateActionConnector.$1.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/action_connector_api/update.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.useConnectorContext",
"type": "Function",
"tags": [],
"label": "useConnectorContext",
"description": [],
"signature": [
"() => ",
"ConnectorContextValue"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/context/use_connector_context.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.useSubAction",
"type": "Function",
"tags": [],
"label": "useSubAction",
"description": [],
"signature": [
"<P, R>({ connectorId, subAction, subActionParams, disabled, }: ",
"UseSubActionParams",
"<P>) => { isLoading: boolean; response: R | undefined; error: Error | null; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/hooks/use_sub_action.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.useSubAction.$1",
"type": "Object",
"tags": [],
"label": "{\n connectorId,\n subAction,\n subActionParams,\n disabled = false,\n}",
"description": [],
"signature": [
"UseSubActionParams",
"<P>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/hooks/use_sub_action.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.useTypedKibana",
"type": "Function",
"tags": [],
"label": "useTypedKibana",
"description": [],
"signature": [
"() => ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContextValue",
"text": "KibanaReactContextValue"
},
"<Partial<",
"CoreStart",
"> & ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUiServices",
"text": "TriggersAndActionsUiServices"
},
">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/lib/kibana/kibana_react.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.validateActionFilterQuery",
"type": "Function",
"tags": [],
"label": "validateActionFilterQuery",
"description": [],
"signature": [
"(actionItem: ",
"RuleUiAction",
") => string | null"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/value_validators.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.validateActionFilterQuery.$1",
"type": "CompoundType",
"tags": [],
"label": "actionItem",
"description": [],
"signature": [
"RuleUiAction"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/value_validators.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValueExpression",
"type": "Function",
"tags": [],
"label": "ValueExpression",
"description": [],
"signature": [
"(props: ",
"ValueExpressionProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/expression_items/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValueExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.WhenExpression",
"type": "Function",
"tags": [],
"label": "WhenExpression",
"description": [],
"signature": [
"(props: ",
"WhenExpressionProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/expression_items/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.WhenExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionConnectorFieldsProps",
"type": "Interface",
"tags": [],
"label": "ActionConnectorFieldsProps",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionConnectorFieldsProps.readOnly",
"type": "boolean",
"tags": [],
"label": "readOnly",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionConnectorFieldsProps.isEdit",
"type": "boolean",
"tags": [],
"label": "isEdit",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.actionParams",
"type": "Object",
"tags": [],
"label": "actionParams",
"description": [],
"signature": [
"{ [P in keyof TParams]?: TParams[P] | undefined; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.index",
"type": "number",
"tags": [],
"label": "index",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.editAction",
"type": "Function",
"tags": [],
"label": "editAction",
"description": [],
"signature": [
"(key: string, value: ",
"SavedObjectAttribute",
", index: number) => void"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.editAction.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.editAction.$2",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"SavedObjectAttribute"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.editAction.$3",
"type": "number",
"tags": [],
"label": "index",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.defaultMessage",
"type": "string",
"tags": [],
"label": "defaultMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.useDefaultMessage",
"type": "CompoundType",
"tags": [],
"label": "useDefaultMessage",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.isLoading",
"type": "CompoundType",
"tags": [],
"label": "isLoading",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.isDisabled",
"type": "CompoundType",
"tags": [],
"label": "isDisabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.selectedActionGroupId",
"type": "string",
"tags": [],
"label": "selectedActionGroupId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.showEmailSubjectAndMessage",
"type": "CompoundType",
"tags": [],
"label": "showEmailSubjectAndMessage",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.onBlur",
"type": "Function",
"tags": [],
"label": "onBlur",
"description": [],
"signature": [
"((field?: string | undefined) => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.onBlur.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.producerId",
"type": "string",
"tags": [],
"label": "producerId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionParamsProps.featureId",
"type": "string",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType",
"type": "Interface",
"tags": [],
"label": "ActionType",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.enabledInConfig",
"type": "boolean",
"tags": [],
"label": "enabledInConfig",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.enabledInLicense",
"type": "boolean",
"tags": [],
"label": "enabledInLicense",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.minimumLicenseRequired",
"type": "CompoundType",
"tags": [],
"label": "minimumLicenseRequired",
"description": [],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.supportedFeatureIds",
"type": "Array",
"tags": [],
"label": "supportedFeatureIds",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.isSystemActionType",
"type": "boolean",
"tags": [],
"label": "isSystemActionType",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.subFeature",
"type": "string",
"tags": [],
"label": "subFeature",
"description": [],
"signature": [
"\"endpointSecurity\" | undefined"
],
"path": "x-pack/platform/plugins/shared/actions/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.iconClass",
"type": "CompoundType",
"tags": [],
"label": "iconClass",
"description": [],
"signature": [
"string | React.ComponentType<{}>"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.selectMessage",
"type": "string",
"tags": [],
"label": "selectMessage",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.actionTypeTitle",
"type": "string",
"tags": [],
"label": "actionTypeTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.validateParams.$1",
"type": "Uncategorized",
"tags": [],
"label": "actionParams",
"description": [],
"signature": [
"ActionParams"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.actionParamsFields",
"type": "Function",
"tags": [],
"label": "actionParamsFields",
"description": [],
"signature": [
"React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionParamsProps",
"text": "ActionParamsProps"
},
"<ActionParams>>>"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.actionParamsFields.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.defaultActionParams",
"type": "Object",
"tags": [],
"label": "defaultActionParams",
"description": [],
"signature": [
"RecursivePartial",
"<ActionParams> | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.defaultRecoveredActionParams",
"type": "Object",
"tags": [],
"label": "defaultRecoveredActionParams",
"description": [],
"signature": [
"RecursivePartial",
"<ActionParams> | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.isExperimental",
"type": "CompoundType",
"tags": [],
"label": "isExperimental",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.subtype",
"type": "Array",
"tags": [],
"label": "subtype",
"description": [],
"signature": [
"{ id: string; name: string; }[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.convertParamsBetweenGroups",
"type": "Function",
"tags": [],
"label": "convertParamsBetweenGroups",
"description": [],
"signature": [
"((params: ActionParams) => {} | ActionParams) | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.convertParamsBetweenGroups.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"ActionParams"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.hideInUi",
"type": "CompoundType",
"tags": [],
"label": "hideInUi",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.modalWidth",
"type": "number",
"tags": [],
"label": "modalWidth",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.isSystemActionType",
"type": "CompoundType",
"tags": [],
"label": "isSystemActionType",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeModel.subFeature",
"type": "string",
"tags": [],
"label": "subFeature",
"description": [],
"signature": [
"\"endpointSecurity\" | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType",
"type": "Interface",
"tags": [],
"label": "AggregationType",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"(\"string\" | \"number\" | \"boolean\" | \"object\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"date_range\" | \"ip_range\" | \"histogram\" | \"number_range\")[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus",
"type": "Interface",
"tags": [],
"label": "AlertStatus",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.uuid",
"type": "string",
"tags": [],
"label": "uuid",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"OK\" | \"Active\""
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.muted",
"type": "boolean",
"tags": [],
"label": "muted",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.actionGroupId",
"type": "string",
"tags": [],
"label": "actionGroupId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.activeStartDate",
"type": "string",
"tags": [],
"label": "activeStartDate",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.flapping",
"type": "boolean",
"tags": [],
"label": "flapping",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.maintenanceWindowIds",
"type": "Array",
"tags": [],
"label": "maintenanceWindowIds",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertStatus.tracked",
"type": "boolean",
"tags": [],
"label": "tracked",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary",
"type": "Interface",
"tags": [],
"label": "AlertSummary",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.consumer",
"type": "string",
"tags": [],
"label": "consumer",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.muteAll",
"type": "boolean",
"tags": [],
"label": "muteAll",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.throttle",
"type": "CompoundType",
"tags": [],
"label": "throttle",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.statusStartDate",
"type": "string",
"tags": [],
"label": "statusStartDate",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.statusEndDate",
"type": "string",
"tags": [],
"label": "statusEndDate",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"OK\" | \"Active\" | \"Error\""
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.lastRun",
"type": "string",
"tags": [],
"label": "lastRun",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.errorMessages",
"type": "Array",
"tags": [],
"label": "errorMessages",
"description": [],
"signature": [
"{ date: string; message: string; }[]"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.alerts",
"type": "Object",
"tags": [],
"label": "alerts",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.AlertStatus",
"text": "AlertStatus"
},
"; }"
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.executionDuration",
"type": "Object",
"tags": [],
"label": "executionDuration",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ExecutionDuration",
"text": "ExecutionDuration"
}
],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummary.revision",
"type": "number",
"tags": [],
"label": "revision",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/alert_summary.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummaryTimeRange",
"type": "Interface",
"tags": [],
"label": "AlertSummaryTimeRange",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/alert_summary_widget/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummaryTimeRange.utcFrom",
"type": "string",
"tags": [],
"label": "utcFrom",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/alert_summary_widget/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummaryTimeRange.utcTo",
"type": "string",
"tags": [],
"label": "utcTo",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/alert_summary_widget/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummaryTimeRange.fixedInterval",
"type": "string",
"tags": [],
"label": "fixedInterval",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/alert_summary_widget/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummaryTimeRange.title",
"type": "CompoundType",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | JSX.Element | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/alert_summary_widget/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertSummaryTimeRange.dateFormat",
"type": "string",
"tags": [],
"label": "dateFormat",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/alert_summary_widget/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.BulkOperationResponse",
"type": "Interface",
"tags": [],
"label": "BulkOperationResponse",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.BulkOperationResponse.rules",
"type": "Array",
"tags": [],
"label": "rules",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.BulkOperationResponse.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkOperationError",
"text": "BulkOperationError"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.BulkOperationResponse.total",
"type": "number",
"tags": [],
"label": "total",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ConfigFieldSchema",
"type": "Interface",
"tags": [],
"label": "ConfigFieldSchema",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.ConfigFieldSchema",
"text": "ConfigFieldSchema"
},
" extends ",
"CommonFieldSchema"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/simple_connector_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ConfigFieldSchema.isUrlField",
"type": "CompoundType",
"tags": [],
"label": "isUrlField",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/simple_connector_form.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ConfigFieldSchema.defaultValue",
"type": "CompoundType",
"tags": [],
"label": "defaultValue",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/simple_connector_form.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GenericValidationResult.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ [P in Extract<keyof T, string>]: unknown; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.IErrorObject",
"type": "Interface",
"tags": [],
"label": "IErrorObject",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.IErrorObject.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: string | string[] | IErrorObject",
"description": [],
"signature": [
"[key: string]: string | string[] | ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.IErrorObject",
"text": "IErrorObject"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.NotifyWhenSelectOptions",
"type": "Interface",
"tags": [],
"label": "NotifyWhenSelectOptions",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.NotifyWhenSelectOptions.isSummaryOption",
"type": "CompoundType",
"tags": [],
"label": "isSummaryOption",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.NotifyWhenSelectOptions.isForEachAlertOption",
"type": "CompoundType",
"tags": [],
"label": "isForEachAlertOption",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.NotifyWhenSelectOptions.value",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"signature": [
"EuiSuperSelectOption",
"<\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleDefinitionProps",
"type": "Interface",
"tags": [],
"label": "RuleDefinitionProps",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleDefinitionProps",
"text": "RuleDefinitionProps"
},
"<Params>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleDefinitionProps.rule",
"type": "CompoundType",
"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: ",
"RuleUiAction",
"[]; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleDefinitionProps.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">; list: () => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">[]; register: (objectType: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void; has: (id: string) => boolean; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleDefinitionProps.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>; list: () => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>[]; register: (objectType: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>) => void; has: (id: string) => boolean; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleDefinitionProps.onEditRule",
"type": "Function",
"tags": [],
"label": "onEditRule",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleDefinitionProps.hideEditButton",
"type": "CompoundType",
"tags": [],
"label": "hideEditButton",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleDefinitionProps.filteredRuleTypes",
"type": "Array",
"tags": [],
"label": "filteredRuleTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps",
"type": "Interface",
"tags": [],
"label": "RuleStatusFilterProps",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.selectedStatuses",
"type": "Array",
"tags": [],
"label": "selectedStatuses",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatus",
"text": "RuleStatus"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.selectDataTestSubj",
"type": "string",
"tags": [],
"label": "selectDataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.buttonDataTestSubj",
"type": "string",
"tags": [],
"label": "buttonDataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.optionDataTestSubj",
"type": "Function",
"tags": [],
"label": "optionDataTestSubj",
"description": [],
"signature": [
"((status: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatus",
"text": "RuleStatus"
},
") => string) | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.optionDataTestSubj.$1",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatus",
"text": "RuleStatus"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"(selectedStatuses: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatus",
"text": "RuleStatus"
},
"[]) => void"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatusFilterProps.onChange.$1",
"type": "Array",
"tags": [],
"label": "selectedStatuses",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatus",
"text": "RuleStatus"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rule_status_filter.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTableItem",
"type": "Interface",
"tags": [],
"label": "RuleTableItem",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTableItem",
"text": "RuleTableItem"
},
" extends ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTableItem.ruleType",
"type": "string",
"tags": [],
"label": "ruleType",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTableItem.index",
"type": "number",
"tags": [],
"label": "index",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTableItem.actionsCount",
"type": "number",
"tags": [],
"label": "actionsCount",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTableItem.isEditable",
"type": "boolean",
"tags": [],
"label": "isEditable",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTableItem.enabledInLicense",
"type": "boolean",
"tags": [],
"label": "enabledInLicense",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTableItem.showIntervalWarning",
"type": "CompoundType",
"tags": [],
"label": "showIntervalWarning",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleType",
"type": "Interface",
"tags": [],
"label": "RuleType",
"description": [],
"signature": [
{
"pluginId": "@kbn/triggers-actions-ui-types",
"scope": "common",
"docId": "kibKbnTriggersActionsUiTypesPluginApi",
"section": "def-common.RuleType",
"text": "RuleType"
},
"<ActionGroupIds, RecoveryActionGroupId> extends Pick<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleType",
"text": "RuleType"
},
"<ActionGroupIds, RecoveryActionGroupId>, \"id\" | \"name\" | \"recoveryActionGroup\" | \"actionGroups\" | \"defaultActionGroupId\" | \"category\" | \"producer\" | \"minimumLicenseRequired\" | \"isExportable\" | \"defaultScheduleInterval\" | \"ruleTaskTimeout\" | \"doesSetRecoveryContext\">"
],
"path": "src/platform/packages/shared/kbn-triggers-actions-ui-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleType.actionVariables",
"type": "CompoundType",
"tags": [],
"label": "actionVariables",
"description": [],
"signature": [
"AsActionVariables<\"params\"> & Partial<AsActionVariables<\"context\" | \"state\">>"
],
"path": "src/platform/packages/shared/kbn-triggers-actions-ui-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleType.authorizedConsumers",
"type": "Object",
"tags": [],
"label": "authorizedConsumers",
"description": [],
"signature": [
"{ [x: string]: { read: boolean; all: boolean; }; }"
],
"path": "src/platform/packages/shared/kbn-triggers-actions-ui-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleType.enabledInLicense",
"type": "boolean",
"tags": [],
"label": "enabledInLicense",
"description": [],
"path": "src/platform/packages/shared/kbn-triggers-actions-ui-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleType.hasAlertsMappings",
"type": "CompoundType",
"tags": [],
"label": "hasAlertsMappings",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-triggers-actions-ui-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel",
"type": "Interface",
"tags": [],
"label": "RuleTypeModel",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<Params>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.iconClass",
"type": "string",
"tags": [],
"label": "iconClass",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.documentationUrl",
"type": "CompoundType",
"tags": [],
"label": "documentationUrl",
"description": [],
"signature": [
"string | ((docLinks: ",
"DocLinksStart",
") => string) | null"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.validate.$1",
"type": "Uncategorized",
"tags": [],
"label": "ruleParams",
"description": [],
"signature": [
"Params"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.validate.$2",
"type": "CompoundType",
"tags": [],
"label": "isServerless",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.ruleParamsExpression",
"type": "Function",
"tags": [],
"label": "ruleParamsExpression",
"description": [],
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeParamsExpressionProps",
"text": "RuleTypeParamsExpressionProps"
},
"<Params, Record<string, unknown>, string>>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.ruleParamsExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.requiresAppContext",
"type": "boolean",
"tags": [],
"label": "requiresAppContext",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.defaultActionMessage",
"type": "string",
"tags": [],
"label": "defaultActionMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.defaultRecoveryMessage",
"type": "string",
"tags": [],
"label": "defaultRecoveryMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.defaultSummaryMessage",
"type": "string",
"tags": [],
"label": "defaultSummaryMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeModel.alertDetailsAppSection",
"type": "CompoundType",
"tags": [],
"label": "alertDetailsAppSection",
"description": [],
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<any>> | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps",
"type": "Interface",
"tags": [],
"label": "RuleTypeParamsExpressionProps",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeParamsExpressionProps",
"text": "RuleTypeParamsExpressionProps"
},
"<Params, MetaData, ActionGroupIds>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.ruleParams",
"type": "Uncategorized",
"tags": [],
"label": "ruleParams",
"description": [],
"signature": [
"Params"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.ruleInterval",
"type": "string",
"tags": [],
"label": "ruleInterval",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.ruleThrottle",
"type": "string",
"tags": [],
"label": "ruleThrottle",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.alertNotifyWhen",
"type": "CompoundType",
"tags": [],
"label": "alertNotifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams",
"type": "Function",
"tags": [],
"label": "setRuleParams",
"description": [],
"signature": [
"<Key extends keyof Params>(property: Key, value: Params[Key] | undefined) => void"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams.$1",
"type": "Uncategorized",
"tags": [],
"label": "property",
"description": [],
"signature": [
"Key"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams.$2",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"Params[Key] | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty",
"type": "Function",
"tags": [],
"label": "setRuleProperty",
"description": [],
"signature": [
"<Prop extends \"params\" | \"id\" | \"consumer\" | \"name\" | \"monitoring\" | \"tags\" | \"actions\" | \"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: ",
"SanitizedRule",
"<Params>[Prop] | null) => void"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty.$1",
"type": "Uncategorized",
"tags": [],
"label": "key",
"description": [],
"signature": [
"Prop"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty.$2",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"SanitizedRule",
"<Params>[Prop] | null"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.onChangeMetaData",
"type": "Function",
"tags": [],
"label": "onChangeMetaData",
"description": [],
"signature": [
"(metadata: MetaData) => void"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.onChangeMetaData.$1",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"MetaData"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.IErrorObject",
"text": "IErrorObject"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.defaultActionGroupId",
"type": "string",
"tags": [],
"label": "defaultActionGroupId",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParamsExpressionProps.metadata",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"MetaData | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.SecretsFieldSchema",
"type": "Interface",
"tags": [],
"label": "SecretsFieldSchema",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.SecretsFieldSchema",
"text": "SecretsFieldSchema"
},
" extends ",
"CommonFieldSchema"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/simple_connector_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.SecretsFieldSchema.isPasswordField",
"type": "CompoundType",
"tags": [],
"label": "isPasswordField",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/components/simple_connector_form.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices",
"type": "Interface",
"tags": [],
"label": "TriggersAndActionsUiServices",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUiServices",
"text": "TriggersAndActionsUiServices"
},
" extends ",
"CoreStart"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.actions",
"type": "Object",
"tags": [],
"label": "actions",
"description": [],
"signature": [
{
"pluginId": "actions",
"scope": "public",
"docId": "kibActionsPluginApi",
"section": "def-public.ActionsPublicPluginSetup",
"text": "ActionsPublicPluginSetup"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.cloud",
"type": "Object",
"tags": [],
"label": "cloud",
"description": [],
"signature": [
{
"pluginId": "cloud",
"scope": "public",
"docId": "kibCloudPluginApi",
"section": "def-public.CloudSetup",
"text": "CloudSetup"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.dataViewEditor",
"type": "Object",
"tags": [],
"label": "dataViewEditor",
"description": [],
"signature": [
{
"pluginId": "dataViewEditor",
"scope": "public",
"docId": "kibDataViewEditorPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.dashboard",
"type": "Object",
"tags": [],
"label": "dashboard",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardStart",
"text": "DashboardStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.charts",
"type": "CompoundType",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
},
" & { activeCursor: ",
"ActiveCursor",
"; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.alerting",
"type": "Object",
"tags": [],
"label": "alerting",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "public",
"docId": "kibAlertingPluginApi",
"section": "def-public.PluginStartContract",
"text": "PluginStartContract"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.spaces",
"type": "Object",
"tags": [],
"label": "spaces",
"description": [],
"signature": [
{
"pluginId": "spaces",
"scope": "public",
"docId": "kibSpacesPluginApi",
"section": "def-public.SpacesApi",
"text": "SpacesApi"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.storage",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.isCloud",
"type": "boolean",
"tags": [],
"label": "isCloud",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.setBreadcrumbs",
"type": "Function",
"tags": [],
"label": "setBreadcrumbs",
"description": [],
"signature": [
"(crumbs: ",
"ChromeBreadcrumb",
"[]) => void"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.setBreadcrumbs.$1",
"type": "Array",
"tags": [],
"label": "crumbs",
"description": [],
"signature": [
"ChromeBreadcrumb",
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>; list: () => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>[]; register: (objectType: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>) => void; has: (id: string) => boolean; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">; list: () => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">[]; register: (objectType: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void; has: (id: string) => boolean; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.kibanaFeatures",
"type": "Array",
"tags": [],
"label": "kibanaFeatures",
"description": [],
"signature": [
{
"pluginId": "features",
"scope": "common",
"docId": "kibFeaturesPluginApi",
"section": "def-common.KibanaFeature",
"text": "KibanaFeature"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.element",
"type": "Object",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLElement"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.i18n",
"type": "Object",
"tags": [],
"label": "i18n",
"description": [],
"signature": [
"I18nStart"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.theme",
"type": "Object",
"tags": [],
"label": "theme",
"description": [],
"signature": [
"ThemeServiceSetup"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.unifiedSearch",
"type": "Object",
"tags": [],
"label": "unifiedSearch",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.licensing",
"type": "Object",
"tags": [],
"label": "licensing",
"description": [],
"signature": [
{
"pluginId": "licensing",
"scope": "public",
"docId": "kibLicensingPluginApi",
"section": "def-public.LicensingPluginStart",
"text": "LicensingPluginStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.expressions",
"type": "Object",
"tags": [],
"label": "expressions",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "public",
"docId": "kibExpressionsPluginApi",
"section": "def-public.ExpressionsStart",
"text": "ExpressionsStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.isServerless",
"type": "boolean",
"tags": [],
"label": "isServerless",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.fieldFormats",
"type": "CompoundType",
"tags": [],
"label": "fieldFormats",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
},
", \"init\" | \"register\"> & { deserialize: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FormatFactory",
"text": "FormatFactory"
},
"; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.lens",
"type": "Object",
"tags": [],
"label": "lens",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensPublicStart",
"text": "LensPublicStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.fieldsMetadata",
"type": "Object",
"tags": [],
"label": "fieldsMetadata",
"description": [],
"signature": [
{
"pluginId": "fieldsMetadata",
"scope": "public",
"docId": "kibFieldsMetadataPluginApi",
"section": "def-public.FieldsMetadataPublicStart",
"text": "FieldsMetadataPublicStart"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.share",
"type": "CompoundType",
"tags": [],
"label": "share",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePublicStart",
"text": "SharePublicStart"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/rules_app.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValidationResult",
"type": "Interface",
"tags": [],
"label": "ValidationResult",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValidationResult.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionConnectorMode",
"type": "Enum",
"tags": [],
"label": "ActionConnectorMode",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertProvidedActionVariables",
"type": "Enum",
"tags": [],
"label": "AlertProvidedActionVariables",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/action_variables/action_variables.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleFlyoutCloseReason",
"type": "Enum",
"tags": [],
"label": "RuleFlyoutCloseReason",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TIME_UNITS",
"type": "Enum",
"tags": [],
"label": "TIME_UNITS",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/constants/time_units.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/action_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionVariables",
"type": "Type",
"tags": [],
"label": "ActionVariables",
"description": [],
"signature": [
"AsActionVariables<\"params\"> & Partial<AsActionVariables<\"context\" | \"state\">>"
],
"path": "src/platform/packages/shared/kbn-triggers-actions-ui-types/action_variable_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ALERT_HISTORY_PREFIX",
"type": "string",
"tags": [],
"label": "ALERT_HISTORY_PREFIX",
"description": [],
"signature": [
"\"kibana-alert-history-\""
],
"path": "x-pack/platform/plugins/shared/actions/common/alert_history_schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertHistoryDefaultIndexName",
"type": "string",
"tags": [],
"label": "AlertHistoryDefaultIndexName",
"description": [],
"path": "x-pack/platform/plugins/shared/actions/common/alert_history_schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertHistoryDocumentTemplate",
"type": "CompoundType",
"tags": [],
"label": "AlertHistoryDocumentTemplate",
"description": [],
"signature": [
"Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record<string, unknown>; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record<string, unknown>; } | undefined; name?: string | undefined; id?: string | undefined; } | undefined; message?: unknown; tags?: string[] | undefined; '@timestamp': string; }> | null"
],
"path": "x-pack/platform/plugins/shared/actions/common/alert_history_schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertHistoryEsIndexConnectorId",
"type": "string",
"tags": [],
"label": "AlertHistoryEsIndexConnectorId",
"description": [],
"signature": [
"\"preconfigured-alert-history-es-index\""
],
"path": "x-pack/platform/plugins/shared/actions/common/alert_history_schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AsApiContract",
"type": "Type",
"tags": [],
"label": "AsApiContract",
"description": [],
"signature": [
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: K extends \"frequency\" ? ",
{
"pluginId": "@kbn/actions-types",
"scope": "common",
"docId": "kibKbnActionsTypesPluginApi",
"section": "def-common.AsApiContract",
"text": "AsApiContract"
},
"<T[K]> : T[K]; }"
],
"path": "src/platform/packages/shared/kbn-actions-types/rewrite_request_case_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.BulkOperationAttributes",
"type": "Type",
"tags": [],
"label": "BulkOperationAttributes",
"description": [],
"signature": [
"BulkOperationAttributesWithoutHttp",
" & { http: ",
"HttpSetup",
"; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.connectorDeprecatedMessage",
"type": "string",
"tags": [],
"label": "connectorDeprecatedMessage",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/connectors_selection.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ConnectorFormSchema",
"type": "Type",
"tags": [],
"label": "ConnectorFormSchema",
"description": [
"\nThe following type is equivalent to:\n\ninterface ConnectorFormSchema<Config, Secrets> {\n id?: string,\n name?: string,\n actionTypeId: string,\n isDeprecated: boolean,\n config: Config,\n secrets: Secrets,\n}"
],
"signature": [
"Pick<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UserConfiguredActionConnector",
"text": "UserConfiguredActionConnector"
},
"<Config, Secrets>, \"config\" | \"secrets\" | \"actionTypeId\" | \"isDeprecated\"> & Partial<Pick<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.UserConfiguredActionConnector",
"text": "UserConfiguredActionConnector"
},
"<Config, Secrets>, \"id\" | \"name\">>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/action_connector_form/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.deprecatedMessage",
"type": "string",
"tags": [],
"label": "deprecatedMessage",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/connectors_selection.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"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: ",
"RuleUiAction",
"[]; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleCreationValidConsumer",
"type": "Type",
"tags": [],
"label": "RuleCreationValidConsumer",
"description": [],
"signature": [
"\"observability\" | \"stackAlerts\" | \"alerts\" | \"logs\" | \"infrastructure\""
],
"path": "src/platform/packages/shared/kbn-rule-data-utils/src/rule_types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleEventLogListProps",
"type": "Type",
"tags": [],
"label": "RuleEventLogListProps",
"description": [],
"signature": [
"T extends \"default\" ? ",
"RuleEventLogListCommonProps",
" : T extends \"stackManagement\" ? ",
"RuleEventLogListStackManagementProps",
" & ",
"RuleEventLogListCommonProps",
" : never"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RulesListVisibleColumns",
"type": "Type",
"tags": [],
"label": "RulesListVisibleColumns",
"description": [],
"signature": [
"\"ruleName\" | \"ruleTags\" | \"ruleExecutionStatusLastDate\" | \"ruleSnoozeNotify\" | \"ruleScheduleInterval\" | \"ruleExecutionStatusLastDuration\" | \"ruleExecutionPercentile\" | \"ruleExecutionSuccessRatio\" | \"ruleExecutionStatus\" | \"ruleExecutionState\""
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/application/sections/rules_list/components/rules_list_column_selector.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleStatus",
"type": "Type",
"tags": [],
"label": "RuleStatus",
"description": [],
"signature": [
"\"disabled\" | \"enabled\" | \"snoozed\""
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeIndex",
"type": "Type",
"tags": [],
"label": "RuleTypeIndex",
"description": [],
"signature": [
"Map<string, ",
{
"pluginId": "@kbn/triggers-actions-ui-types",
"scope": "common",
"docId": "kibKbnTriggersActionsUiTypesPluginApi",
"section": "def-common.RuleType",
"text": "RuleType"
},
"<string, string>>"
],
"path": "src/platform/packages/shared/kbn-triggers-actions-ui-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeParams",
"type": "Type",
"tags": [],
"label": "RuleTypeParams",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "src/platform/packages/shared/kbn-alerting-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.RuleTypeRegistryContract",
"type": "Type",
"tags": [],
"label": "RuleTypeRegistryContract",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">; list: () => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">[]; register: (objectType: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void; has: (id: string) => boolean; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"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": "src/platform/packages/shared/kbn-alerting-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValidNormalizedTypes",
"type": "Type",
"tags": [],
"label": "ValidNormalizedTypes",
"description": [],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"date_range\" | \"ip_range\" | \"histogram\" | \"number_range\""
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes",
"type": "Object",
"tags": [],
"label": "builtInAggregationTypes",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count",
"type": "Object",
"tags": [],
"label": "count",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"false"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
"AGGREGATION_TYPES"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"never[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg",
"type": "Object",
"tags": [],
"label": "avg",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"\"number\"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
"AGGREGATION_TYPES"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum",
"type": "Object",
"tags": [],
"label": "sum",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"\"number\"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
"AGGREGATION_TYPES"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min",
"type": "Object",
"tags": [],
"label": "min",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"(\"date\" | \"number\")[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
"AGGREGATION_TYPES"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max",
"type": "Object",
"tags": [],
"label": "max",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"(\"date\" | \"number\")[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
"AGGREGATION_TYPES"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators",
"type": "Object",
"tags": [],
"label": "builtInComparators",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.GREATER_THAN]",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-comparators",
"scope": "common",
"docId": "kibKbnAlertingComparatorsPluginApi",
"section": "def-common.COMPARATORS",
"text": "COMPARATORS"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.GREATER_THAN_OR_EQUALS]",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-comparators",
"scope": "common",
"docId": "kibKbnAlertingComparatorsPluginApi",
"section": "def-common.COMPARATORS",
"text": "COMPARATORS"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.LESS_THAN]",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-comparators",
"scope": "common",
"docId": "kibKbnAlertingComparatorsPluginApi",
"section": "def-common.COMPARATORS",
"text": "COMPARATORS"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.LESS_THAN_OR_EQUALS]",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-comparators",
"scope": "common",
"docId": "kibKbnAlertingComparatorsPluginApi",
"section": "def-common.COMPARATORS",
"text": "COMPARATORS"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.BETWEEN]",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-comparators",
"scope": "common",
"docId": "kibKbnAlertingComparatorsPluginApi",
"section": "def-common.COMPARATORS",
"text": "COMPARATORS"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.NOT_BETWEEN]",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-comparators",
"scope": "common",
"docId": "kibKbnAlertingComparatorsPluginApi",
"section": "def-common.COMPARATORS",
"text": "COMPARATORS"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes",
"type": "Object",
"tags": [],
"label": "builtInGroupByTypes",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all",
"type": "Object",
"tags": [],
"label": "all",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.sizeRequired",
"type": "boolean",
"tags": [],
"label": "sizeRequired",
"description": [],
"signature": [
"false"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"never[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top",
"type": "Object",
"tags": [],
"label": "top",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.sizeRequired",
"type": "boolean",
"tags": [],
"label": "sizeRequired",
"description": [],
"signature": [
"true"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/constants/group_by_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.firstFieldOption",
"type": "Object",
"tags": [],
"label": "firstFieldOption",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.firstFieldOption.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.firstFieldOption.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/index_controls/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"setup": {
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginSetup",
"type": "Interface",
"tags": [],
"label": "TriggersAndActionsUIPublicPluginSetup",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginSetup.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<any, any, any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginSetup.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
"<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart",
"type": "Interface",
"tags": [],
"label": "TriggersAndActionsUIPublicPluginStart",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<any, any, any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
"<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getActionForm",
"type": "Function",
"tags": [],
"label": "getActionForm",
"description": [],
"signature": [
"(props: Omit<",
"ActionAccordionFormProps",
", \"setActions\" | \"actionTypeRegistry\"> & { setActions: (actions: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleAction",
"text": "RuleAction"
},
"[]) => void; }) => React.ReactElement<",
"ActionAccordionFormProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getActionForm.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Omit<",
"ActionAccordionFormProps",
", \"setActions\" | \"actionTypeRegistry\"> & { setActions: (actions: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleAction",
"text": "RuleAction"
},
"[]) => void; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddConnectorFlyout",
"type": "Function",
"tags": [],
"label": "getAddConnectorFlyout",
"description": [],
"signature": [
"(props: Omit<",
"CreateConnectorFlyoutProps",
", \"actionTypeRegistry\">) => React.ReactElement<",
"CreateConnectorFlyoutProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddConnectorFlyout.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Omit<",
"CreateConnectorFlyoutProps",
", \"actionTypeRegistry\">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditConnectorFlyout",
"type": "Function",
"tags": [],
"label": "getEditConnectorFlyout",
"description": [],
"signature": [
"(props: Omit<",
"EditConnectorFlyoutProps",
", \"actionTypeRegistry\">) => React.ReactElement<",
"EditConnectorFlyoutProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditConnectorFlyout.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Omit<",
"EditConnectorFlyoutProps",
", \"actionTypeRegistry\">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAlertsSearchBar",
"type": "Function",
"tags": [],
"label": "getAlertsSearchBar",
"description": [],
"signature": [
"(props: ",
"AlertsSearchBarProps",
") => React.ReactElement<",
"AlertsSearchBarProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAlertsSearchBar.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AlertsSearchBarProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusDropdown",
"type": "Function",
"tags": [],
"label": "getRuleStatusDropdown",
"description": [],
"signature": [
"(props: ",
"ComponentOpts",
") => React.ReactElement<",
"ComponentOpts",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusDropdown.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"ComponentOpts"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagFilter",
"type": "Function",
"tags": [],
"label": "getRuleTagFilter",
"description": [],
"signature": [
"(props: ",
"RuleTagFilterProps",
") => React.ReactElement<",
"RuleTagFilterProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagFilter.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RuleTagFilterProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusFilter",
"type": "Function",
"tags": [],
"label": "getRuleStatusFilter",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatusFilterProps",
"text": "RuleStatusFilterProps"
},
") => React.ReactElement<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatusFilterProps",
"text": "RuleStatusFilterProps"
},
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusFilter.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleStatusFilterProps",
"text": "RuleStatusFilterProps"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagBadge",
"type": "Function",
"tags": [],
"label": "getRuleTagBadge",
"description": [],
"signature": [
"<T extends ",
"RuleTagBadgeOptions",
">(props: ",
"RuleTagBadgeProps",
"<T>) => React.ReactElement<",
"RuleTagBadgeProps",
"<T>, string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagBadge.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RuleTagBadgeProps",
"<T>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleEventLogList",
"type": "Function",
"tags": [],
"label": "getRuleEventLogList",
"description": [],
"signature": [
"<T extends ",
"RuleEventLogListOptions",
">(props: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleEventLogListProps",
"text": "RuleEventLogListProps"
},
"<T>) => React.ReactElement<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleEventLogListProps",
"text": "RuleEventLogListProps"
},
"<T>, string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleEventLogList.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleEventLogListProps",
"text": "RuleEventLogListProps"
},
"<T>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRulesList",
"type": "Function",
"tags": [],
"label": "getRulesList",
"description": [],
"signature": [
"(props: ",
"RulesListProps",
") => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRulesList.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RulesListProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRulesListNotifyBadge",
"type": "Function",
"tags": [],
"label": "getRulesListNotifyBadge",
"description": [],
"signature": [
"(props: ",
"RulesListNotifyBadgePropsWithApi",
") => React.ReactElement<",
"RulesListNotifyBadgePropsWithApi",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRulesListNotifyBadge.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RulesListNotifyBadgePropsWithApi"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleDefinition",
"type": "Function",
"tags": [],
"label": "getRuleDefinition",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleDefinitionProps",
"text": "RuleDefinitionProps"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => React.ReactElement<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleDefinitionProps",
"text": "RuleDefinitionProps"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">, string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleDefinition.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.RuleDefinitionProps",
"text": "RuleDefinitionProps"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusPanel",
"type": "Function",
"tags": [],
"label": "getRuleStatusPanel",
"description": [],
"signature": [
"(props: ",
"RuleStatusPanelProps",
") => React.ReactElement<",
"RuleStatusPanelProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusPanel.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RuleStatusPanelProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAlertSummaryWidget",
"type": "Function",
"tags": [],
"label": "getAlertSummaryWidget",
"description": [],
"signature": [
"(props: ",
"AlertSummaryWidgetProps",
") => React.ReactElement<",
"AlertSummaryWidgetProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAlertSummaryWidget.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AlertSummaryWidgetProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleSnoozeModal",
"type": "Function",
"tags": [],
"label": "getRuleSnoozeModal",
"description": [],
"signature": [
"(props: ",
"RuleSnoozeModalProps",
") => React.ReactElement<",
"RuleSnoozeModalProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleSnoozeModal.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RuleSnoozeModalProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getRulesSettingsLink",
"type": "Function",
"tags": [],
"label": "getRulesSettingsLink",
"description": [],
"signature": [
"() => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getGlobalRuleEventLogList",
"type": "Function",
"tags": [],
"label": "getGlobalRuleEventLogList",
"description": [],
"signature": [
"(props: ",
"GlobalRuleEventLogListProps",
") => React.ReactElement<",
"GlobalRuleEventLogListProps",
", string | React.JSXElementConstructor<any>>"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getGlobalRuleEventLogList.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"GlobalRuleEventLogListProps"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.DEFAULT_GROUPS",
"type": "number",
"tags": [],
"label": "DEFAULT_GROUPS",
"description": [],
"signature": [
"100"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/server/data/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.TIME_SERIES_BUCKET_SELECTOR_FIELD",
"type": "string",
"tags": [],
"label": "TIME_SERIES_BUCKET_SELECTOR_FIELD",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/server/data/lib/time_series_query.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.TimeSeriesQuery",
"type": "Type",
"tags": [],
"label": "TimeSeriesQuery",
"description": [],
"signature": [
"{ readonly interval?: string | undefined; readonly aggField?: string | undefined; readonly termSize?: number | undefined; readonly termField?: string | undefined; readonly dateStart?: string | undefined; readonly dateEnd?: string | undefined; readonly filterKuery?: string | undefined; readonly index: string | string[]; readonly groupBy: string; readonly timeField: string; readonly aggType: string; readonly timeWindowSize: number; readonly timeWindowUnit: string; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/server/data/lib/time_series_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "triggersActionsUi",
"id": "def-server.PluginStartContract",
"type": "Interface",
"tags": [],
"label": "PluginStartContract",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.PluginStartContract.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"{ timeSeriesQuery: (params: ",
"TimeSeriesQueryParameters",
") => Promise<",
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.TimeSeriesResult",
"text": "TimeSeriesResult"
},
">; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.buildAggregation",
"type": "Function",
"tags": [],
"label": "buildAggregation",
"description": [],
"signature": [
"({ timeSeries, aggType, aggField, termField, termSize, sourceFieldsParams, condition, topHitsSize, loggerCb, }: ",
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.BuildAggregationOpts",
"text": "BuildAggregationOpts"
},
") => Record<string, ",
"AggregationsAggregationContainer",
">"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.buildAggregation.$1",
"type": "Object",
"tags": [],
"label": "{\n timeSeries,\n aggType,\n aggField,\n termField,\n termSize,\n sourceFieldsParams,\n condition,\n topHitsSize,\n loggerCb,\n}",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.BuildAggregationOpts",
"text": "BuildAggregationOpts"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.getDateRangeInfo",
"type": "Function",
"tags": [],
"label": "getDateRangeInfo",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.GetDateRangeInfoParams",
"text": "GetDateRangeInfoParams"
},
") => ",
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.DateRangeInfo",
"text": "DateRangeInfo"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.getDateRangeInfo.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.GetDateRangeInfoParams",
"text": "GetDateRangeInfoParams"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.getDateStartAfterDateEndErrorMessage",
"type": "Function",
"tags": [],
"label": "getDateStartAfterDateEndErrorMessage",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.getExperimentalAllowedValues",
"type": "Function",
"tags": [],
"label": "getExperimentalAllowedValues",
"description": [],
"signature": [
"() => string[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.getTooManyIntervalsErrorMessage",
"type": "Function",
"tags": [],
"label": "getTooManyIntervalsErrorMessage",
"description": [],
"signature": [
"(intervals: number, maxIntervals: number) => string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.getTooManyIntervalsErrorMessage.$1",
"type": "number",
"tags": [],
"label": "intervals",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.getTooManyIntervalsErrorMessage.$2",
"type": "number",
"tags": [],
"label": "maxIntervals",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.isCountAggregation",
"type": "Function",
"tags": [],
"label": "isCountAggregation",
"description": [],
"signature": [
"(aggType: string) => boolean"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.isCountAggregation.$1",
"type": "string",
"tags": [],
"label": "aggType",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.isGroupAggregation",
"type": "Function",
"tags": [],
"label": "isGroupAggregation",
"description": [],
"signature": [
"(termField?: string | string[] | undefined) => boolean"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.isGroupAggregation.$1",
"type": "CompoundType",
"tags": [],
"label": "termField",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.isValidExperimentalValue",
"type": "Function",
"tags": [],
"label": "isValidExperimentalValue",
"description": [],
"signature": [
"(value: string) => boolean"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.isValidExperimentalValue.$1",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.parseAggregationResults",
"type": "Function",
"tags": [],
"label": "parseAggregationResults",
"description": [],
"signature": [
"({ isCountAgg, isGroupAgg, esResult, resultLimit, sourceFieldsParams, generateSourceFieldsFromHits, termField, }: ParseAggregationResultsOpts) => ",
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.ParsedAggregationResults",
"text": "ParsedAggregationResults"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.parseAggregationResults.$1",
"type": "Object",
"tags": [],
"label": "{\n isCountAgg,\n isGroupAgg,\n esResult,\n resultLimit,\n sourceFieldsParams = [],\n generateSourceFieldsFromHits = false,\n termField,\n}",
"description": [],
"signature": [
"ParseAggregationResultsOpts"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.parseExperimentalConfigValue",
"type": "Function",
"tags": [
"throws"
],
"label": "parseExperimentalConfigValue",
"description": [
"\nParses the string value used in `xpack.trigger_actions_ui.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`):\nxpack.trigger_actions_ui.enableExperimental: ['ruleStatusFilter', 'ruleTagFilter']\n"
],
"signature": [
"(configValue: string[]) => ",
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.ExperimentalFeatures",
"text": "ExperimentalFeatures"
}
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.parseExperimentalConfigValue.$1",
"type": "Array",
"tags": [],
"label": "configValue",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.parseInterval",
"type": "Function",
"tags": [],
"label": "parseInterval",
"description": [],
"signature": [
"(intervalString: string) => { value: number; unit: string; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/parse_interval.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.parseInterval.$1",
"type": "string",
"tags": [],
"label": "intervalString",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/parse_interval.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts",
"type": "Interface",
"tags": [],
"label": "BuildAggregationOpts",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.timeSeries",
"type": "Object",
"tags": [],
"label": "timeSeries",
"description": [],
"signature": [
"{ timeField: string; dateStart?: string | undefined; dateEnd?: string | undefined; interval?: string | undefined; timeWindowSize: number; timeWindowUnit: string; } | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.aggType",
"type": "string",
"tags": [],
"label": "aggType",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.aggField",
"type": "string",
"tags": [],
"label": "aggField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.termSize",
"type": "number",
"tags": [],
"label": "termSize",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.termField",
"type": "CompoundType",
"tags": [],
"label": "termField",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.sourceFieldsParams",
"type": "Array",
"tags": [],
"label": "sourceFieldsParams",
"description": [],
"signature": [
"{ label: string; searchPath: string; }[] | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.topHitsSize",
"type": "number",
"tags": [],
"label": "topHitsSize",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.condition",
"type": "Object",
"tags": [],
"label": "condition",
"description": [],
"signature": [
"{ resultLimit?: number | undefined; conditionScript: string; } | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.loggerCb",
"type": "Function",
"tags": [],
"label": "loggerCb",
"description": [],
"signature": [
"((message: string) => void) | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BuildAggregationOpts.loggerCb.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DateRange",
"type": "Interface",
"tags": [],
"label": "DateRange",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DateRange.from",
"type": "string",
"tags": [],
"label": "from",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DateRange.to",
"type": "string",
"tags": [],
"label": "to",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DateRangeInfo",
"type": "Interface",
"tags": [],
"label": "DateRangeInfo",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DateRangeInfo.dateStart",
"type": "string",
"tags": [],
"label": "dateStart",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DateRangeInfo.dateEnd",
"type": "string",
"tags": [],
"label": "dateEnd",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DateRangeInfo.dateRanges",
"type": "Array",
"tags": [],
"label": "dateRanges",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.DateRange",
"text": "DateRange"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.GetDateRangeInfoParams",
"type": "Interface",
"tags": [],
"label": "GetDateRangeInfoParams",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.GetDateRangeInfoParams.dateStart",
"type": "string",
"tags": [],
"label": "dateStart",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.GetDateRangeInfoParams.dateEnd",
"type": "string",
"tags": [],
"label": "dateEnd",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.GetDateRangeInfoParams.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.GetDateRangeInfoParams.window",
"type": "string",
"tags": [],
"label": "window",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationGroup",
"type": "Interface",
"tags": [],
"label": "ParsedAggregationGroup",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationGroup.group",
"type": "string",
"tags": [],
"label": "group",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationGroup.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationGroup.hits",
"type": "Array",
"tags": [],
"label": "hits",
"description": [],
"signature": [
"SearchHit",
"<unknown>[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationGroup.sourceFields",
"type": "Array",
"tags": [],
"label": "sourceFields",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationGroup.groups",
"type": "Array",
"tags": [],
"label": "groups",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-rule-utils",
"scope": "common",
"docId": "kibKbnAlertingRuleUtilsPluginApi",
"section": "def-common.Group",
"text": "Group"
},
"[] | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationGroup.value",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationResults",
"type": "Interface",
"tags": [],
"label": "ParsedAggregationResults",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationResults.results",
"type": "Array",
"tags": [],
"label": "results",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.ParsedAggregationGroup",
"text": "ParsedAggregationGroup"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ParsedAggregationResults.truncated",
"type": "boolean",
"tags": [],
"label": "truncated",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResult",
"type": "Interface",
"tags": [],
"label": "TimeSeriesResult",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResult.results",
"type": "Array",
"tags": [],
"label": "results",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.TimeSeriesResultRow",
"text": "TimeSeriesResultRow"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResult.truncated",
"type": "boolean",
"tags": [],
"label": "truncated",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResultRow",
"type": "Interface",
"tags": [],
"label": "TimeSeriesResultRow",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResultRow.group",
"type": "string",
"tags": [],
"label": "group",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResultRow.metrics",
"type": "Array",
"tags": [],
"label": "metrics",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "common",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-common.MetricResult",
"text": "MetricResult"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BASE_TRIGGERS_ACTIONS_UI_API_PATH",
"type": "string",
"tags": [],
"label": "BASE_TRIGGERS_ACTIONS_UI_API_PATH",
"description": [],
"signature": [
"\"/internal/triggers_actions_ui\""
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BUCKET_SELECTOR_FIELD",
"type": "string",
"tags": [],
"label": "BUCKET_SELECTOR_FIELD",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.BUCKET_SELECTOR_PATH_NAME",
"type": "string",
"tags": [],
"label": "BUCKET_SELECTOR_PATH_NAME",
"description": [],
"signature": [
"\"compareValue\""
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.DEFAULT_GROUPS",
"type": "number",
"tags": [],
"label": "DEFAULT_GROUPS",
"description": [],
"signature": [
"100"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.ExperimentalFeatures",
"type": "Type",
"tags": [],
"label": "ExperimentalFeatures",
"description": [],
"signature": [
"{ readonly rulesListDatagrid: boolean; readonly stackAlertsPage: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; readonly ruleKqlBar: boolean; readonly isMustacheAutocompleteOn: boolean; readonly showMustacheAutocompleteSwitch: boolean; readonly alertDeletionSettingsEnabled: boolean; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.MAX_INTERVALS",
"type": "number",
"tags": [],
"label": "MAX_INTERVALS",
"description": [],
"signature": [
"1000"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/date_range_info.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.MAX_SOURCE_FIELDS_TO_COPY",
"type": "number",
"tags": [],
"label": "MAX_SOURCE_FIELDS_TO_COPY",
"description": [],
"signature": [
"10"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/build_agg.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.MetricResult",
"type": "Type",
"tags": [],
"label": "MetricResult",
"description": [],
"signature": [
"[string, number]"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.UngroupedGroupId",
"type": "string",
"tags": [],
"label": "UngroupedGroupId",
"description": [],
"signature": [
"\"all documents\""
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/data/lib/parse_aggregation_results.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.allowedExperimentalValues",
"type": "Object",
"tags": [],
"label": "allowedExperimentalValues",
"description": [
"\nA list of allowed values that can be used in `xpack.trigger_actions_ui.enableExperimental`.\nThis object is then used to validate and parse the value entered."
],
"signature": [
"{ readonly rulesListDatagrid: true; readonly stackAlertsPage: true; readonly ruleTagFilter: true; readonly ruleStatusFilter: true; readonly rulesDetailLogs: true; readonly ruleUseExecutionStatus: false; readonly ruleKqlBar: false; readonly isMustacheAutocompleteOn: false; readonly showMustacheAutocompleteSwitch: false; readonly alertDeletionSettingsEnabled: false; }"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.INTERVAL_STRING_RE",
"type": "Object",
"tags": [],
"label": "INTERVAL_STRING_RE",
"description": [],
"signature": [
"RegExp"
],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/parse_interval.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES",
"type": "Object",
"tags": [],
"label": "NORMALIZED_FIELD_TYPES",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.long",
"type": "string",
"tags": [],
"label": "long",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.integer",
"type": "string",
"tags": [],
"label": "integer",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.short",
"type": "string",
"tags": [],
"label": "short",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.byte",
"type": "string",
"tags": [],
"label": "byte",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.double",
"type": "string",
"tags": [],
"label": "double",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.float",
"type": "string",
"tags": [],
"label": "float",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.half_float",
"type": "string",
"tags": [],
"label": "half_float",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.scaled_float",
"type": "string",
"tags": [],
"label": "scaled_float",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.NORMALIZED_FIELD_TYPES.unsigned_long",
"type": "string",
"tags": [],
"label": "unsigned_long",
"description": [],
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/common/normalized_field_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink