kibana/api_docs/triggers_actions_ui.json
2021-07-30 15:26:29 -04:00

4463 lines
149 KiB
JSON

{
"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 ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "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>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 80
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 91
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, plugins: PluginsSetup) => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginSetup",
"text": "TriggersAndActionsUIPublicPluginSetup"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 96
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 96
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.setup.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"PluginsSetup"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 96
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginStart",
"text": "TriggersAndActionsUIPublicPluginStart"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 172
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Plugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 206
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionForm",
"type": "Function",
"tags": [],
"label": "ActionForm",
"description": [],
"signature": [
"(props: ",
"ActionAccordionFormProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts",
"lineNumber": 17
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertConditions",
"type": "Function",
"tags": [],
"label": "AlertConditions",
"description": [],
"signature": [
"React.ExoticComponent<React.PropsWithChildren<",
"AlertConditionsProps",
"<unknown, string>>> & { readonly _result: <ConditionProps extends unknown, ActionGroupIds extends string>({ headline, actionGroups, onInitializeConditionsFor, onResetConditionsFor, includeBuiltInActionGroups, children, }: React.PropsWithChildren<",
"AlertConditionsProps",
"<ConditionProps, ActionGroupIds>>) => JSX.Element; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx",
"lineNumber": 13
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"source": {
"path": "node_modules/@types/react/index.d.ts",
"lineNumber": 359
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertConditionsGroup",
"type": "Function",
"tags": [],
"label": "AlertConditionsGroup",
"description": [],
"signature": [
"React.ExoticComponent<React.PropsWithChildren<",
"AlertConditionsGroupProps",
"<unknown>>> & { readonly _result: <ConditionProps extends unknown>({ actionGroup, onResetConditionsFor, children, ...otherProps }: React.PropsWithChildren<",
"AlertConditionsGroupProps",
"<ConditionProps>>) => JSX.Element | null; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx",
"lineNumber": 14
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"source": {
"path": "node_modules/@types/react/index.d.ts",
"lineNumber": 359
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ConnectorAddFlyout",
"type": "Function",
"tags": [],
"label": "ConnectorAddFlyout",
"description": [],
"signature": [
"(props: ",
"ConnectorAddFlyoutProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts",
"lineNumber": 11
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ConnectorEditFlyout",
"type": "Function",
"tags": [],
"label": "ConnectorEditFlyout",
"description": [],
"signature": [
"(props: ",
"ConnectorEditFlyoutProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts",
"lineNumber": 14
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ForLastExpression",
"type": "Function",
"tags": [],
"label": "ForLastExpression",
"description": [],
"signature": [
"(props: ",
"ForLastExpressionProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts",
"lineNumber": 12
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getFields",
"type": "Function",
"tags": [],
"label": "getFields",
"description": [],
"signature": [
"(http: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
},
", indexes: string[]) => Promise<{ name: string; type: string; normalizedType: string; searchable: boolean; aggregatable: boolean; }[]>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 88
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getFields.$1",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 88
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getFields.$2",
"type": "Array",
"tags": [],
"label": "indexes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 88
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexOptions",
"type": "Function",
"tags": [],
"label": "getIndexOptions",
"description": [],
"signature": [
"(http: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
},
", pattern: string, indexPatternsParam: string[]) => Promise<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.IOption",
"text": "IOption"
},
"[]>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 32
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexOptions.$1",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 33
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexOptions.$2",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 34
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexOptions.$3",
"type": "Array",
"tags": [],
"label": "indexPatternsParam",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 35
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getIndexPatterns",
"type": "Function",
"tags": [],
"label": "getIndexPatterns",
"description": [],
"signature": [
"() => Promise<any>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 23
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeFieldOptions",
"type": "Function",
"tags": [],
"label": "getTimeFieldOptions",
"description": [],
"signature": [
"(fields: { type: string; name: string; }[]) => TimeFieldOptions[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeFieldOptions.$1",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"{ type: string; name: string; }[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts",
"lineNumber": 25
},
"deprecated": 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"
},
"; }[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeOptions.$1",
"type": "number",
"tags": [],
"label": "unitSize",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts",
"lineNumber": 11
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts",
"lineNumber": 11
},
"deprecated": 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"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts",
"lineNumber": 11
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.getTimeUnitLabel.$2",
"type": "string",
"tags": [],
"label": "timeValue",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts",
"lineNumber": 11
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByExpression",
"type": "Function",
"tags": [],
"label": "GroupByExpression",
"description": [],
"signature": [
"(props: ",
"GroupByExpressionProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts",
"lineNumber": 11
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadActionTypes",
"type": "Function",
"tags": [],
"label": "loadActionTypes",
"description": [],
"signature": [
"({ http }: { http: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
},
"; }) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionType",
"text": "ActionType"
},
"[]>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadActionTypes.$1.http",
"type": "Object",
"tags": [],
"label": "{ http }",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.loadActionTypes.$1.http.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpSetup",
"text": "HttpSetup"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts",
"lineNumber": 29
},
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.OfExpression",
"type": "Function",
"tags": [],
"label": "OfExpression",
"description": [],
"signature": [
"(props: ",
"OfExpressionProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts",
"lineNumber": 16
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ThresholdExpression",
"type": "Function",
"tags": [],
"label": "ThresholdExpression",
"description": [],
"signature": [
"(props: ",
"ThresholdExpressionProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts",
"lineNumber": 17
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValueExpression",
"type": "Function",
"tags": [],
"label": "ValueExpression",
"description": [],
"signature": [
"(props: ",
"ValueExpressionProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts",
"lineNumber": 13
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.WhenExpression",
"type": "Function",
"tags": [],
"label": "WhenExpression",
"description": [],
"signature": [
"(props: ",
"WhenExpressionProps",
") => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts",
"lineNumber": 15
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType",
"type": "Interface",
"tags": [],
"label": "ActionType",
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
"lineNumber": 10
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
"lineNumber": 11
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
"lineNumber": 12
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
"lineNumber": 13
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.enabledInConfig",
"type": "boolean",
"tags": [],
"label": "enabledInConfig",
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
"lineNumber": 14
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.enabledInLicense",
"type": "boolean",
"tags": [],
"label": "enabledInLicense",
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
"lineNumber": 15
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionType.minimumLicenseRequired",
"type": "CompoundType",
"tags": [],
"label": "minimumLicenseRequired",
"description": [],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType",
"type": "Interface",
"tags": [],
"label": "AggregationType",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 14
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 15
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AggregationType.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 18
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertAction",
"type": "Interface",
"tags": [],
"label": "AlertAction",
"description": [],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
"lineNumber": 43
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertAction.group",
"type": "string",
"tags": [],
"label": "group",
"description": [],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertAction.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
"lineNumber": 45
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertAction.actionTypeId",
"type": "string",
"tags": [],
"label": "actionTypeId",
"description": [],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
"lineNumber": 46
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertAction.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"SavedObjectAttributes"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
"lineNumber": 47
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel",
"type": "Interface",
"tags": [],
"label": "AlertTypeModel",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertTypeModel",
"text": "AlertTypeModel"
},
"<Params>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 235
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 236
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 237
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.iconClass",
"type": "string",
"tags": [],
"label": "iconClass",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 238
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.documentationUrl",
"type": "CompoundType",
"tags": [],
"label": "documentationUrl",
"description": [],
"signature": [
"string | ((docLinks: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.DocLinksStart",
"text": "DocLinksStart"
},
") => string) | null"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 239
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"(alertParams: Params) => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.ValidationResult",
"text": "ValidationResult"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 240
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.alertParams",
"type": "Uncategorized",
"tags": [],
"label": "alertParams",
"description": [],
"signature": [
"Params"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 240
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.alertParamsExpression",
"type": "Function",
"tags": [],
"label": "alertParamsExpression",
"description": [],
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertTypeParamsExpressionProps",
"text": "AlertTypeParamsExpressionProps"
},
"<Params, Record<string, unknown>, string>>>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 241
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"source": {
"path": "node_modules/@types/react/index.d.ts",
"lineNumber": 359
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.requiresAppContext",
"type": "boolean",
"tags": [],
"label": "requiresAppContext",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 244
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeModel.defaultActionMessage",
"type": "string",
"tags": [],
"label": "defaultActionMessage",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 245
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps",
"type": "Interface",
"tags": [],
"label": "AlertTypeParamsExpressionProps",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertTypeParamsExpressionProps",
"text": "AlertTypeParamsExpressionProps"
},
"<Params, MetaData, ActionGroupIds>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 213
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.alertParams",
"type": "Uncategorized",
"tags": [],
"label": "alertParams",
"description": [],
"signature": [
"Params"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 218
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.alertInterval",
"type": "string",
"tags": [],
"label": "alertInterval",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 219
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.alertThrottle",
"type": "string",
"tags": [],
"label": "alertThrottle",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 220
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.alertNotifyWhen",
"type": "CompoundType",
"tags": [],
"label": "alertNotifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 221
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.setAlertParams",
"type": "Function",
"tags": [],
"label": "setAlertParams",
"description": [],
"signature": [
"<Key extends keyof Params>(property: Key, value: Params[Key] | undefined) => void"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 222
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.property",
"type": "Uncategorized",
"tags": [],
"label": "property",
"description": [],
"signature": [
"Key"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 222
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.value",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"Params[Key] | undefined"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 222
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.setAlertProperty",
"type": "Function",
"tags": [],
"label": "setAlertProperty",
"description": [],
"signature": [
"<Prop extends \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">(key: Prop, value: Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null) => void"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 223
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.key",
"type": "Uncategorized",
"tags": [],
"label": "key",
"description": [],
"signature": [
"Prop"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 224
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 225
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.IErrorObject",
"text": "IErrorObject"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 227
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.defaultActionGroupId",
"type": "string",
"tags": [],
"label": "defaultActionGroupId",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 228
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.actionGroups",
"type": "Array",
"tags": [],
"label": "actionGroups",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds>[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 229
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.metadata",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"MetaData | undefined"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 230
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.charts",
"type": "Object",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 231
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParamsExpressionProps.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 232
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Comparator",
"type": "Interface",
"tags": [],
"label": "Comparator",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Comparator.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 9
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Comparator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 10
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Comparator.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 11
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByType",
"type": "Interface",
"tags": [],
"label": "GroupByType",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByType.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByType.sizeRequired",
"type": "boolean",
"tags": [],
"label": "sizeRequired",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 23
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByType.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.GroupByType.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
"lineNumber": 25
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.IErrorObject",
"type": "Interface",
"tags": [],
"label": "IErrorObject",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 248
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.IErrorObject.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 249
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.IOption",
"type": "Interface",
"tags": [],
"label": "IOption",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 18
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.IOption.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.IOption.options",
"type": "Array",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ value: string; label: string; }[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 20
},
"deprecated": 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 ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"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"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.charts",
"type": "Object",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 36
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 37
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.spaces",
"type": "Object",
"tags": [],
"label": "spaces",
"description": [],
"signature": [
{
"pluginId": "spacesOss",
"scope": "public",
"docId": "kibSpacesOssPluginApi",
"section": "def-public.SpacesApi",
"text": "SpacesApi"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 38
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 39
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.setBreadcrumbs",
"type": "Function",
"tags": [],
"label": "setBreadcrumbs",
"description": [],
"signature": [
"(crumbs: ",
"EuiBreadcrumb",
"[]) => void"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 40
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.crumbs",
"type": "Array",
"tags": [],
"label": "crumbs",
"description": [],
"signature": [
"EuiBreadcrumb",
"[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 40
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
"ActionTypeModel",
"<unknown, unknown, any>; register: (objectType: ",
"ActionTypeModel",
"<unknown, unknown, any>) => void; has: (id: string) => boolean; list: () => ",
"ActionTypeModel",
"<unknown, unknown, any>[]; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 41
},
"deprecated": 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.AlertTypeModel",
"text": "AlertTypeModel"
},
"<Record<string, unknown>>; register: (objectType: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertTypeModel",
"text": "AlertTypeModel"
},
"<Record<string, unknown>>) => void; has: (id: string) => boolean; list: () => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertTypeModel",
"text": "AlertTypeModel"
},
"<Record<string, unknown>>[]; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 42
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.ScopedHistory",
"text": "ScopedHistory"
},
"<unknown>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 43
},
"deprecated": 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"
},
"[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.element",
"type": "Object",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLElement"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
"lineNumber": 45
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValidationResult",
"type": "Interface",
"tags": [],
"label": "ValidationResult",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 128
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ValidationResult.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 129
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AGGREGATION_TYPES",
"type": "Enum",
"tags": [],
"label": "AGGREGATION_TYPES",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertFlyoutCloseReason",
"type": "Enum",
"tags": [],
"label": "AlertFlyoutCloseReason",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 80
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.COMPARATORS",
"type": "Enum",
"tags": [],
"label": "COMPARATORS",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TIME_UNITS",
"type": "Enum",
"tags": [],
"label": "TIME_UNITS",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/constants/time_units.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionConnector",
"type": "Type",
"tags": [],
"label": "ActionConnector",
"description": [],
"signature": [
"PreConfiguredActionConnector",
" | ",
"UserConfiguredActionConnector",
"<Config, Secrets>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 162
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionGroupWithCondition",
"type": "Type",
"tags": [],
"label": "ActionGroupWithCondition",
"description": [],
"signature": [
"(",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds> & { conditions?: T | undefined; isRequired?: false | undefined; }) | (",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds> & { conditions: T; isRequired: true; })"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alert_form/alert_conditions.tsx",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionTypeRegistryContract",
"type": "Type",
"tags": [],
"label": "ActionTypeRegistryContract",
"description": [],
"signature": [
"{ get: (id: string) => ",
"ActionTypeModel",
"<ActionConnector, ActionParams, any>; register: (objectType: ",
"ActionTypeModel",
"<ActionConnector, ActionParams, any>) => void; has: (id: string) => boolean; list: () => ",
"ActionTypeModel",
"<ActionConnector, ActionParams, any>[]; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 65
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.ActionVariables",
"type": "Type",
"tags": [],
"label": "ActionVariables",
"description": [],
"signature": [
"AsActionVariables<\"params\" | \"state\"> & Partial<AsActionVariables<\"context\">>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 180
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.Alert",
"type": "Type",
"tags": [],
"label": "Alert",
"description": [],
"signature": [
"{ enabled: boolean; id: string; name: string; params: Record<string, unknown>; actions: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.AlertAction",
"text": "AlertAction"
},
"[]; throttle: string | null; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.AlertExecutionStatus",
"text": "AlertExecutionStatus"
},
"; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 41
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeParams",
"type": "Type",
"tags": [],
"label": "AlertTypeParams",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.DEFAULT_HIDDEN_ACTION_TYPES",
"type": "Array",
"tags": [],
"label": "DEFAULT_HIDDEN_ACTION_TYPES",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts",
"lineNumber": 14
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.DEFAULT_HIDDEN_ONLY_ON_ALERTS_ACTION_TYPES",
"type": "Array",
"tags": [],
"label": "DEFAULT_HIDDEN_ONLY_ON_ALERTS_ACTION_TYPES",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts",
"lineNumber": 16
},
"deprecated": 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.AlertTypeModel",
"text": "AlertTypeModel"
},
"<Record<string, unknown>>; register: (objectType: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertTypeModel",
"text": "AlertTypeModel"
},
"<Record<string, unknown>>) => void; has: (id: string) => boolean; list: () => ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertTypeModel",
"text": "AlertTypeModel"
},
"<Record<string, unknown>>[]; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 69
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.VIEW_LICENSE_OPTIONS_LINK",
"type": "string",
"tags": [],
"label": "VIEW_LICENSE_OPTIONS_LINK",
"description": [],
"signature": [
"\"https://www.elastic.co/subscriptions\""
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes",
"type": "Object",
"tags": [],
"label": "builtInAggregationTypes",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 18
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count",
"type": "Object",
"tags": [],
"label": "count",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"false"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 21
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AGGREGATION_TYPES",
"text": "AGGREGATION_TYPES"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.count.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"never[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 23
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg",
"type": "Object",
"tags": [],
"label": "avg",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.avg.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AGGREGATION_TYPES",
"text": "AGGREGATION_TYPES"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 29
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum",
"type": "Object",
"tags": [],
"label": "sum",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 31
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.sum.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AGGREGATION_TYPES",
"text": "AGGREGATION_TYPES"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 35
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min",
"type": "Object",
"tags": [],
"label": "min",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 38
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 39
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 40
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.min.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AGGREGATION_TYPES",
"text": "AGGREGATION_TYPES"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 41
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max",
"type": "Object",
"tags": [],
"label": "max",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 43
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.fieldRequired",
"type": "boolean",
"tags": [],
"label": "fieldRequired",
"description": [],
"signature": [
"true"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 45
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 46
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInAggregationTypes.max.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AGGREGATION_TYPES",
"text": "AGGREGATION_TYPES"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
"lineNumber": 47
},
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators",
"type": "Object",
"tags": [],
"label": "builtInComparators",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.GREATER_THAN]",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 21
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.COMPARATORS",
"text": "COMPARATORS"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 25
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.GREATER_THAN_OR_EQUALS]",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.COMPARATORS",
"text": "COMPARATORS"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 35
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.LESS_THAN]",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 38
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.COMPARATORS",
"text": "COMPARATORS"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 41
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 42
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.LESS_THAN_OR_EQUALS]",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 44
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 45
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.COMPARATORS",
"text": "COMPARATORS"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 51
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 52
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN",
"type": "Object",
"tags": [],
"label": "[COMPARATORS.BETWEEN]",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 54
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 55
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN.value",
"type": "Enum",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.COMPARATORS",
"text": "COMPARATORS"
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 58
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInComparators.COMPARATORS.BETWEEN.requiredValues",
"type": "number",
"tags": [],
"label": "requiredValues",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
"lineNumber": 59
},
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes",
"type": "Object",
"tags": [],
"label": "builtInGroupByTypes",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all",
"type": "Object",
"tags": [],
"label": "all",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 12
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 13
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.sizeRequired",
"type": "boolean",
"tags": [],
"label": "sizeRequired",
"description": [],
"signature": [
"false"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.all.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"never[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 21
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top",
"type": "Object",
"tags": [],
"label": "top",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 23
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.sizeRequired",
"type": "boolean",
"tags": [],
"label": "sizeRequired",
"description": [],
"signature": [
"true"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.builtInGroupByTypes.top.validNormalizedTypes",
"type": "Array",
"tags": [],
"label": "validNormalizedTypes",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
"lineNumber": 32
},
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.firstFieldOption",
"type": "Object",
"tags": [],
"label": "firstFieldOption",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 92
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.firstFieldOption.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 93
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.firstFieldOption.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
"lineNumber": 99
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"setup": {
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginSetup",
"type": "Interface",
"tags": [],
"label": "TriggersAndActionsUIPublicPluginSetup",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 44
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginSetup.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
"<",
"ActionTypeModel",
"<any, any, any>>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 45
},
"deprecated": 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.AlertTypeModel",
"text": "AlertTypeModel"
},
"<any>>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 46
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart",
"type": "Interface",
"tags": [],
"label": "TriggersAndActionsUIPublicPluginStart",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 49
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
"<",
"ActionTypeModel",
"<any, any, any>>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 50
},
"deprecated": 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.AlertTypeModel",
"text": "AlertTypeModel"
},
"<any>>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 51
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddConnectorFlyout",
"type": "Function",
"tags": [],
"label": "getAddConnectorFlyout",
"description": [],
"signature": [
"(props: Pick<",
"ConnectorAddFlyoutProps",
", \"onClose\" | \"consumer\" | \"actionTypes\" | \"onTestConnector\" | \"reloadConnectors\">) => React.ReactElement<",
"ConnectorAddFlyoutProps",
">"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 52
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ onClose: () => void; consumer?: string | undefined; actionTypes?: ",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionType",
"text": "ActionType"
},
"[] | undefined; onTestConnector?: ((connector: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>) => void) | undefined; reloadConnectors?: (() => Promise<void | ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>[]>) | undefined; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 53
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditConnectorFlyout",
"type": "Function",
"tags": [],
"label": "getEditConnectorFlyout",
"description": [],
"signature": [
"(props: Pick<",
"ConnectorEditFlyoutProps",
", \"onClose\" | \"consumer\" | \"reloadConnectors\" | \"initialConnector\" | \"tab\">) => React.ReactElement<",
"ConnectorEditFlyoutProps",
">"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 55
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ onClose: () => void; consumer?: string | undefined; reloadConnectors?: (() => Promise<void | ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>[]>) | undefined; initialConnector: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>; tab?: ",
"EditConectorTabs",
" | undefined; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 56
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddAlertFlyout",
"type": "Function",
"tags": [],
"label": "getAddAlertFlyout",
"description": [],
"signature": [
"(props: Pick<",
"AlertAddProps",
"<Record<string, any>>, \"onClose\" | \"metadata\" | \"onSave\" | \"alertTypeId\" | \"consumer\" | \"canChangeTrigger\" | \"initialValues\" | \"reloadAlerts\">) => React.ReactElement<",
"AlertAddProps",
"<Record<string, any>>, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 58
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ onClose: (reason: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertFlyoutCloseReason",
"text": "AlertFlyoutCloseReason"
},
") => void; metadata?: Record<string, any> | undefined; onSave?: (() => Promise<void>) | undefined; alertTypeId?: string | undefined; consumer: string; canChangeTrigger?: boolean | undefined; initialValues?: Partial<Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
"<Record<string, unknown>>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">> | undefined; reloadAlerts?: (() => Promise<void>) | undefined; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 59
},
"deprecated": false
}
]
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditAlertFlyout",
"type": "Function",
"tags": [],
"label": "getEditAlertFlyout",
"description": [],
"signature": [
"(props: Pick<",
"AlertEditProps",
"<Record<string, any>>, \"onClose\" | \"metadata\" | \"onSave\" | \"reloadAlerts\" | \"initialAlert\">) => React.ReactElement<",
"AlertEditProps",
"<Record<string, any>>, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 61
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ onClose: (reason: ",
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.AlertFlyoutCloseReason",
"text": "AlertFlyoutCloseReason"
},
") => void; metadata?: Record<string, any> | undefined; onSave?: (() => Promise<void>) | undefined; reloadAlerts?: (() => Promise<void>) | undefined; initialAlert: Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
"<Record<string, unknown>>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 62
},
"deprecated": false
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.validateCoreQueryBody",
"type": "Function",
"tags": [],
"label": "validateCoreQueryBody",
"description": [],
"signature": [
"(anyParams: unknown) => string | undefined"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 46
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.validateCoreQueryBody.$1",
"type": "Unknown",
"tags": [],
"label": "anyParams",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 46
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.validateTimeWindowUnits",
"type": "Function",
"tags": [],
"label": "validateTimeWindowUnits",
"description": [],
"signature": [
"(timeWindowUnit: string) => string | undefined"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 128
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.validateTimeWindowUnits.$1",
"type": "string",
"tags": [],
"label": "timeWindowUnit",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 128
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParams",
"type": "Type",
"tags": [],
"label": "CoreQueryParams",
"description": [],
"signature": [
"{ readonly termSize?: number | undefined; readonly termField?: string | undefined; readonly aggField?: string | undefined; readonly index: string | string[]; readonly groupBy: string; readonly timeWindowSize: number; readonly timeWindowUnit: string; readonly aggType: string; readonly timeField: string; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 40
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.DEFAULT_GROUPS",
"type": "number",
"tags": [],
"label": "DEFAULT_GROUPS",
"description": [],
"signature": [
"100"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/index.ts",
"lineNumber": 23
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.MAX_GROUPS",
"type": "number",
"tags": [],
"label": "MAX_GROUPS",
"description": [],
"signature": [
"1000"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/index.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.MAX_INTERVALS",
"type": "number",
"tags": [],
"label": "MAX_INTERVALS",
"description": [],
"signature": [
"1000"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/index.ts",
"lineNumber": 21
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.TimeSeriesQuery",
"type": "Type",
"tags": [],
"label": "TimeSeriesQuery",
"description": [],
"signature": [
"{ readonly interval?: string | undefined; readonly termSize?: number | undefined; readonly termField?: string | undefined; readonly aggField?: string | undefined; readonly dateStart?: string | undefined; readonly dateEnd?: string | undefined; readonly index: string | string[]; readonly groupBy: string; readonly timeWindowSize: number; readonly timeWindowUnit: string; readonly aggType: string; readonly timeField: string; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/time_series_types.ts",
"lineNumber": 29
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties",
"type": "Object",
"tags": [],
"label": "CoreQueryParamsSchemaProperties",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.index",
"type": "Object",
"tags": [],
"label": "index",
"description": [
"// name of the indices to search"
],
"signature": [
"Type",
"<string | string[]>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.timeField",
"type": "Object",
"tags": [],
"label": "timeField",
"description": [
"// field in index used for date/time"
],
"signature": [
"Type",
"<string>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.aggType",
"type": "Object",
"tags": [],
"label": "aggType",
"description": [
"// aggregation type"
],
"signature": [
"Type",
"<string>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.aggField",
"type": "Object",
"tags": [],
"label": "aggField",
"description": [
"// aggregation field"
],
"signature": [
"Type",
"<string | undefined>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.groupBy",
"type": "Object",
"tags": [],
"label": "groupBy",
"description": [
"// how to group"
],
"signature": [
"Type",
"<string>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.termField",
"type": "Object",
"tags": [],
"label": "termField",
"description": [
"// field to group on (for groupBy: top)"
],
"signature": [
"Type",
"<string | undefined>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.termSize",
"type": "Object",
"tags": [],
"label": "termSize",
"description": [
"// limit on number of groups returned"
],
"signature": [
"Type",
"<number | undefined>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.timeWindowSize",
"type": "Object",
"tags": [],
"label": "timeWindowSize",
"description": [
"// size of time window for date range aggregations"
],
"signature": [
"Type",
"<number>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-server.CoreQueryParamsSchemaProperties.timeWindowUnit",
"type": "Object",
"tags": [],
"label": "timeWindowUnit",
"description": [
"// units of time window for date range aggregations"
],
"signature": [
"Type",
"<string>"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
"lineNumber": 36
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"start": {
"parentPluginId": "triggersActionsUi",
"id": "def-server.PluginStartContract",
"type": "Interface",
"tags": [],
"label": "PluginStartContract",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/plugin.ts",
"lineNumber": 15
},
"deprecated": 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"
},
">; }"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/server/plugin.ts",
"lineNumber": 16
},
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResult",
"type": "Interface",
"tags": [],
"label": "TimeSeriesResult",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts",
"lineNumber": 8
},
"deprecated": 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"
},
"[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts",
"lineNumber": 9
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResultRow",
"type": "Interface",
"tags": [],
"label": "TimeSeriesResultRow",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts",
"lineNumber": 12
},
"deprecated": false,
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.TimeSeriesResultRow.group",
"type": "string",
"tags": [],
"label": "group",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts",
"lineNumber": 13
},
"deprecated": 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"
},
"[]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts",
"lineNumber": 14
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-common.MetricResult",
"type": "Type",
"tags": [],
"label": "MetricResult",
"description": [],
"signature": [
"[string, number]"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}