{ "id": "triggersActionsUi", "client": { "classes": [ { "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>" ], "children": [ { "id": "def-public.Plugin.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 88 } }, { "id": "def-public.Plugin.setup", "type": "Function", "label": "setup", "signature": [ "(core: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, ", plugins: PluginsSetup) => ", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.TriggersAndActionsUIPublicPluginSetup", "text": "TriggersAndActionsUIPublicPluginSetup" } ], "description": [], "children": [ { "id": "def-public.Plugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, "" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 93 } }, { "id": "def-public.Plugin.setup.$2", "type": "Object", "label": "plugins", "isRequired": true, "signature": [ "PluginsSetup" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 93 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 93 } }, { "id": "def-public.Plugin.start", "type": "Function", "label": "start", "signature": [ "() => ", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.TriggersAndActionsUIPublicPluginStart", "text": "TriggersAndActionsUIPublicPluginStart" } ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 169 } }, { "id": "def-public.Plugin.stop", "type": "Function", "label": "stop", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 203 } } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 77 }, "initialIsOpen": false } ], "functions": [ { "tags": [], "id": "def-public.ActionForm", "type": "Function", "label": "ActionForm", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts", "lineNumber": 17 }, "signature": [ "(props: ", "ActionAccordionFormProps", ") => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.AlertAdd", "type": "Function", "label": "AlertAdd", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alert_form/index.tsx", "lineNumber": 11 }, "signature": [ "(props: ", "AlertAddProps", ">) => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.AlertConditions", "type": "Function", "label": "AlertConditions", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx", "lineNumber": 13 }, "signature": [ "React.LazyExoticComponent<(({ headline, actionGroups, onInitializeConditionsFor, onResetConditionsFor, includeBuiltInActionGroups, children, }: React.PropsWithChildren<", "AlertConditionsProps", ">) => JSX.Element)>" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.AlertConditionsGroup", "type": "Function", "label": "AlertConditionsGroup", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx", "lineNumber": 14 }, "signature": [ "React.LazyExoticComponent<(({ actionGroup, onResetConditionsFor, children, ...otherProps }: React.PropsWithChildren<", "AlertConditionsGroupProps", ">) => JSX.Element | null)>" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.AlertEdit", "type": "Function", "label": "AlertEdit", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx", "lineNumber": 17 }, "signature": [ "(props: ", "AlertEditProps", ">) => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.ConnectorAddFlyout", "type": "Function", "label": "ConnectorAddFlyout", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts", "lineNumber": 11 }, "signature": [ "(props: ", "ConnectorAddFlyoutProps", ") => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.ConnectorEditFlyout", "type": "Function", "label": "ConnectorEditFlyout", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts", "lineNumber": 14 }, "signature": [ "(props: ", "ConnectorEditFlyoutProps", ") => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.ForLastExpression", "type": "Function", "label": "ForLastExpression", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", "lineNumber": 12 }, "signature": [ "(props: ", "ForLastExpressionProps", ") => JSX.Element" ], "initialIsOpen": false }, { "id": "def-public.getActionType", "type": "Function", "label": "getActionType", "signature": [ "() => ", "ActionTypeModel", "<", "JiraConfig", ", ", "JiraSecrets", ", ", "JiraActionParams", ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/jira/jira.tsx", "lineNumber": 63 }, "initialIsOpen": false }, { "id": "def-public.getActionType", "type": "Function", "label": "getActionType", "signature": [ "() => ", "ActionTypeModel", "<", "ResilientConfig", ", ", "ResilientSecrets", ", ", "ResilientActionParams", ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/resilient/resilient.tsx", "lineNumber": 68 }, "initialIsOpen": false }, { "id": "def-public.getFields", "type": "Function", "children": [ { "id": "def-public.getFields.$1", "type": "Object", "label": "http", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" } ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 88 } }, { "id": "def-public.getFields.$2", "type": "Array", "label": "indexes", "isRequired": true, "signature": [ "string[]" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 88 } } ], "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; }[]>" ], "description": [], "label": "getFields", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 88 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.getIndexOptions", "type": "Function", "children": [ { "id": "def-public.getIndexOptions.$1", "type": "Object", "label": "http", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" } ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 33 } }, { "id": "def-public.getIndexOptions.$2", "type": "string", "label": "pattern", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 34 } }, { "id": "def-public.getIndexOptions.$3", "type": "Array", "label": "indexPatternsParam", "isRequired": true, "signature": [ "string[]" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 35 } } ], "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" }, "[]>" ], "description": [], "label": "getIndexOptions", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 32 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.getIndexPatterns", "type": "Function", "children": [], "signature": [ "() => Promise" ], "description": [], "label": "getIndexPatterns", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 23 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.getServiceNowITSMActionType", "type": "Function", "label": "getServiceNowITSMActionType", "signature": [ "() => ", "ActionTypeModel", "<", "ServiceNowConfig", ", ", "ServiceNowSecrets", ", ", "ServiceNowITSMActionParams", ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx", "lineNumber": 64 }, "initialIsOpen": false }, { "id": "def-public.getServiceNowSIRActionType", "type": "Function", "label": "getServiceNowSIRActionType", "signature": [ "() => ", "ActionTypeModel", "<", "ServiceNowConfig", ", ", "ServiceNowSecrets", ", ", "ServiceNowSIRActionParams", ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx", "lineNumber": 99 }, "initialIsOpen": false }, { "id": "def-public.getTimeFieldOptions", "type": "Function", "children": [ { "id": "def-public.getTimeFieldOptions.$1", "type": "Array", "label": "fields", "isRequired": true, "signature": [ "{ type: string; name: string; }[]" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts", "lineNumber": 25 } } ], "signature": [ "(fields: { type: string; name: string; }[]) => TimeFieldOptions[]" ], "description": [], "label": "getTimeFieldOptions", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts", "lineNumber": 24 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.getTimeOptions", "type": "Function", "children": [ { "id": "def-public.getTimeOptions.$1", "type": "number", "label": "unitSize", "isRequired": true, "signature": [ "number" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts", "lineNumber": 11 } } ], "signature": [ "(unitSize: number) => { text: string; value: ", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.TIME_UNITS", "text": "TIME_UNITS" }, "; }[]" ], "description": [], "label": "getTimeOptions", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts", "lineNumber": 11 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.getTimeUnitLabel", "type": "Function", "label": "getTimeUnitLabel", "signature": [ "(timeUnit: ", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.TIME_UNITS", "text": "TIME_UNITS" }, ", timeValue: string) => string" ], "description": [], "children": [ { "id": "def-public.getTimeUnitLabel.$1", "type": "Enum", "label": "timeUnit", "isRequired": true, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.TIME_UNITS", "text": "TIME_UNITS" } ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts", "lineNumber": 11 } }, { "id": "def-public.getTimeUnitLabel.$2", "type": "string", "label": "timeValue", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts", "lineNumber": 11 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "tags": [], "id": "def-public.GroupByExpression", "type": "Function", "label": "GroupByExpression", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", "lineNumber": 11 }, "signature": [ "(props: ", "GroupByExpressionProps", ") => JSX.Element" ], "initialIsOpen": false }, { "id": "def-public.loadActionTypes", "type": "Function", "label": "loadActionTypes", "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" }, "[]>" ], "description": [], "children": [ { "id": "def-public.loadActionTypes.$1.http", "type": "Object", "label": "{ http }", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-public.loadActionTypes.$1.http.http", "type": "Object", "label": "http", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts", "lineNumber": 29 }, "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 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts", "lineNumber": 29 }, "initialIsOpen": false }, { "tags": [], "id": "def-public.OfExpression", "type": "Function", "label": "OfExpression", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", "lineNumber": 16 }, "signature": [ "(props: ", "OfExpressionProps", ") => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.ThresholdExpression", "type": "Function", "label": "ThresholdExpression", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", "lineNumber": 17 }, "signature": [ "(props: ", "ThresholdExpressionProps", ") => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.ValueExpression", "type": "Function", "label": "ValueExpression", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", "lineNumber": 13 }, "signature": [ "(props: ", "ValueExpressionProps", ") => JSX.Element" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.WhenExpression", "type": "Function", "label": "WhenExpression", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", "lineNumber": 15 }, "signature": [ "(props: ", "WhenExpressionProps", ") => JSX.Element" ], "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.ActionType", "type": "Interface", "label": "ActionType", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ActionType.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 11 } }, { "tags": [], "id": "def-public.ActionType.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 12 } }, { "tags": [], "id": "def-public.ActionType.enabled", "type": "boolean", "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 13 } }, { "tags": [], "id": "def-public.ActionType.enabledInConfig", "type": "boolean", "label": "enabledInConfig", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 14 } }, { "tags": [], "id": "def-public.ActionType.enabledInLicense", "type": "boolean", "label": "enabledInLicense", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 15 } }, { "tags": [], "id": "def-public.ActionType.minimumLicenseRequired", "type": "CompoundType", "label": "minimumLicenseRequired", "description": [], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 16 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ] } ], "source": { "path": "x-pack/plugins/actions/common/types.ts", "lineNumber": 10 }, "initialIsOpen": false }, { "id": "def-public.AggregationType", "type": "Interface", "label": "AggregationType", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.AggregationType.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 15 } }, { "tags": [], "id": "def-public.AggregationType.fieldRequired", "type": "boolean", "label": "fieldRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 16 } }, { "tags": [], "id": "def-public.AggregationType.value", "type": "string", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-public.AggregationType.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 18 }, "signature": [ "string[]" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-public.AlertAction", "type": "Interface", "label": "AlertAction", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.AlertAction.group", "type": "string", "label": "group", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 44 } }, { "tags": [], "id": "def-public.AlertAction.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 45 } }, { "tags": [], "id": "def-public.AlertAction.actionTypeId", "type": "string", "label": "actionTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 46 } }, { "tags": [], "id": "def-public.AlertAction.params", "type": "Object", "label": "params", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 47 }, "signature": [ "SavedObjectAttributes" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 43 }, "initialIsOpen": false }, { "id": "def-public.AlertTypeModel", "type": "Interface", "label": "AlertTypeModel", "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AlertTypeModel", "text": "AlertTypeModel" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.AlertTypeModel.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 234 } }, { "tags": [], "id": "def-public.AlertTypeModel.description", "type": "string", "label": "description", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 235 } }, { "tags": [], "id": "def-public.AlertTypeModel.iconClass", "type": "string", "label": "iconClass", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 236 } }, { "tags": [], "id": "def-public.AlertTypeModel.documentationUrl", "type": "CompoundType", "label": "documentationUrl", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 237 }, "signature": [ "string | ((docLinks: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.DocLinksStart", "text": "DocLinksStart" }, ") => string) | null" ] }, { "tags": [], "id": "def-public.AlertTypeModel.validate", "type": "Function", "label": "validate", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 238 }, "signature": [ "(alertParams: Params) => ", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.ValidationResult", "text": "ValidationResult" } ] }, { "tags": [], "id": "def-public.AlertTypeModel.alertParamsExpression", "type": "Function", "label": "alertParamsExpression", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 239 }, "signature": [ "React.FunctionComponent | React.LazyExoticComponent, string>>>" ] }, { "tags": [], "id": "def-public.AlertTypeModel.requiresAppContext", "type": "boolean", "label": "requiresAppContext", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 242 } }, { "tags": [], "id": "def-public.AlertTypeModel.defaultActionMessage", "type": "string", "label": "defaultActionMessage", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 243 }, "signature": [ "string | undefined" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 233 }, "initialIsOpen": false }, { "id": "def-public.AlertTypeParamsExpressionProps", "type": "Interface", "label": "AlertTypeParamsExpressionProps", "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AlertTypeParamsExpressionProps", "text": "AlertTypeParamsExpressionProps" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.alertParams", "type": "Uncategorized", "label": "alertParams", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 216 }, "signature": [ "Params" ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.alertInterval", "type": "string", "label": "alertInterval", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 217 } }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.alertThrottle", "type": "string", "label": "alertThrottle", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 218 } }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.alertNotifyWhen", "type": "CompoundType", "label": "alertNotifyWhen", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 219 }, "signature": [ "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.setAlertParams", "type": "Function", "label": "setAlertParams", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 220 }, "signature": [ "(property: Key, value: Params[Key] | undefined) => void" ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.setAlertProperty", "type": "Function", "label": "setAlertProperty", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 221 }, "signature": [ "(key: Prop, value: Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.Alert", "text": "Alert" }, ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null) => void" ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.errors", "type": "Object", "label": "errors", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 225 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.IErrorObject", "text": "IErrorObject" } ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.defaultActionGroupId", "type": "string", "label": "defaultActionGroupId", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 226 } }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.actionGroups", "type": "Array", "label": "actionGroups", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 227 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "[]" ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.metadata", "type": "Uncategorized", "label": "metadata", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 228 }, "signature": [ "MetaData | undefined" ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.charts", "type": "Object", "label": "charts", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 229 }, "signature": [ { "pluginId": "charts", "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.ChartsPluginSetup", "text": "ChartsPluginSetup" } ] }, { "tags": [], "id": "def-public.AlertTypeParamsExpressionProps.data", "type": "Object", "label": "data", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 230 }, "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": 211 }, "initialIsOpen": false }, { "id": "def-public.Comparator", "type": "Interface", "label": "Comparator", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Comparator.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 9 } }, { "tags": [], "id": "def-public.Comparator.value", "type": "string", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 10 } }, { "tags": [], "id": "def-public.Comparator.requiredValues", "type": "number", "label": "requiredValues", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 11 } } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 8 }, "initialIsOpen": false }, { "id": "def-public.GroupByType", "type": "Interface", "label": "GroupByType", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.GroupByType.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 22 } }, { "tags": [], "id": "def-public.GroupByType.sizeRequired", "type": "boolean", "label": "sizeRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 23 } }, { "tags": [], "id": "def-public.GroupByType.value", "type": "string", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 24 } }, { "tags": [], "id": "def-public.GroupByType.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 25 }, "signature": [ "string[]" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "lineNumber": 21 }, "initialIsOpen": false }, { "id": "def-public.IErrorObject", "type": "Interface", "label": "IErrorObject", "description": [], "tags": [], "children": [ { "id": "def-public.IErrorObject.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 247 }, "signature": [ "any" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 246 }, "initialIsOpen": false }, { "id": "def-public.IOption", "type": "Interface", "label": "IOption", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.IOption.label", "type": "string", "label": "label", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 19 } }, { "tags": [], "id": "def-public.IOption.options", "type": "Array", "label": "options", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 20 }, "signature": [ "{ value: string; label: string; }[]" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 18 }, "initialIsOpen": false }, { "id": "def-public.TriggersAndActionsUiServices", "type": "Interface", "label": "TriggersAndActionsUiServices", "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" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.TriggersAndActionsUiServices.data", "type": "Object", "label": "data", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 35 }, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataPluginApi", "section": "def-public.DataPublicPluginStart", "text": "DataPublicPluginStart" } ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.charts", "type": "Object", "label": "charts", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 36 }, "signature": [ { "pluginId": "charts", "scope": "public", "docId": "kibChartsPluginApi", "section": "def-public.ChartsPluginSetup", "text": "ChartsPluginSetup" } ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.alerting", "type": "Object", "label": "alerting", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 37 }, "signature": [ { "pluginId": "alerting", "scope": "public", "docId": "kibAlertingPluginApi", "section": "def-public.PluginStartContract", "text": "PluginStartContract" }, " | undefined" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.spaces", "type": "Object", "label": "spaces", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 38 }, "signature": [ { "pluginId": "spacesOss", "scope": "public", "docId": "kibSpacesOssPluginApi", "section": "def-public.SpacesApi", "text": "SpacesApi" }, " | undefined" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.storage", "type": "Object", "label": "storage", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 39 }, "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.Storage", "text": "Storage" }, " | undefined" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.setBreadcrumbs", "type": "Function", "label": "setBreadcrumbs", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 40 }, "signature": [ "(crumbs: ", "EuiBreadcrumb", "[]) => void" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.actionTypeRegistry", "type": "Object", "label": "actionTypeRegistry", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 41 }, "signature": [ "Pick<", "TypeRegistry", "<", "ActionTypeModel", ">, \"get\" | \"register\" | \"list\" | \"has\">" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.alertTypeRegistry", "type": "Object", "label": "alertTypeRegistry", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 42 }, "signature": [ "Pick<", "TypeRegistry", "<", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AlertTypeModel", "text": "AlertTypeModel" }, ">>, \"get\" | \"register\" | \"list\" | \"has\">" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.history", "type": "Object", "label": "history", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 43 }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ScopedHistory", "text": "ScopedHistory" }, "" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.kibanaFeatures", "type": "Array", "label": "kibanaFeatures", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 44 }, "signature": [ { "pluginId": "features", "scope": "common", "docId": "kibFeaturesPluginApi", "section": "def-common.KibanaFeature", "text": "KibanaFeature" }, "[]" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUiServices.element", "type": "Object", "label": "element", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 45 }, "signature": [ "HTMLElement" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-public.ValidationResult", "type": "Interface", "label": "ValidationResult", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ValidationResult.errors", "type": "Object", "label": "errors", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 128 }, "signature": [ "Record" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 127 }, "initialIsOpen": false } ], "enums": [ { "id": "def-public.AGGREGATION_TYPES", "type": "Enum", "label": "AGGREGATION_TYPES", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 10 }, "initialIsOpen": false }, { "id": "def-public.AlertFlyoutCloseReason", "type": "Enum", "label": "AlertFlyoutCloseReason", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 79 }, "initialIsOpen": false }, { "id": "def-public.COMPARATORS", "type": "Enum", "label": "COMPARATORS", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-public.TIME_UNITS", "type": "Enum", "label": "TIME_UNITS", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/constants/time_units.ts", "lineNumber": 8 }, "initialIsOpen": false } ], "misc": [ { "id": "def-public.ActionConnector", "type": "Type", "label": "ActionConnector", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 160 }, "signature": [ "PreConfiguredActionConnector", " | ", "UserConfiguredActionConnector", "" ], "initialIsOpen": false }, { "id": "def-public.ActionGroupWithCondition", "type": "Type", "label": "ActionGroupWithCondition", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alert_form/alert_conditions.tsx", "lineNumber": 16 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " & { conditions?: T | undefined; isRequired?: false | undefined; } | ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " & { conditions: T; isRequired: true; }" ], "initialIsOpen": false }, { "id": "def-public.ActionTypeRegistryContract", "type": "Type", "label": "ActionTypeRegistryContract", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 64 }, "signature": [ "{ get: (id: string) => ActionTypeModel; register: (objectType: ActionTypeModel) => void; list: () => ActionTypeModel[]; has: (id: string) => boolean; }" ], "initialIsOpen": false }, { "id": "def-public.ActionVariables", "type": "Type", "label": "ActionVariables", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 178 }, "signature": [ "AsActionVariables<\"params\" | \"state\"> & Partial>" ], "initialIsOpen": false }, { "id": "def-public.Alert", "type": "Type", "label": "Alert", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 40 }, "signature": [ "{ enabled: boolean; id: string; name: string; params: Record; actions: AlertAction[]; tags: string[]; muteAll: boolean; 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; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertExecutionStatus", "text": "AlertExecutionStatus" }, "; }" ], "initialIsOpen": false }, { "id": "def-public.AlertTypeParams", "type": "Type", "label": "AlertTypeParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 12 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-public.AlertTypeRegistryContract", "type": "Type", "label": "AlertTypeRegistryContract", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "lineNumber": 68 }, "signature": [ "{ get: (id: string) => AlertTypeModel>; register: (objectType: AlertTypeModel>) => void; list: () => AlertTypeModel>[]; has: (id: string) => boolean; }" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.DEFAULT_HIDDEN_ACTION_TYPES", "type": "Array", "label": "DEFAULT_HIDDEN_ACTION_TYPES", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts", "lineNumber": 14 }, "signature": [ "string[]" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.DEFAULT_HIDDEN_ONLY_ON_ALERTS_ACTION_TYPES", "type": "Array", "label": "DEFAULT_HIDDEN_ONLY_ON_ALERTS_ACTION_TYPES", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts", "lineNumber": 16 }, "signature": [ "string[]" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.VIEW_LICENSE_OPTIONS_LINK", "type": "string", "label": "VIEW_LICENSE_OPTIONS_LINK", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts", "lineNumber": 12 }, "signature": [ "\"https://www.elastic.co/subscriptions\"" ], "initialIsOpen": false } ], "objects": [ { "id": "def-public.builtInAggregationTypes", "type": "Object", "tags": [], "children": [ { "id": "def-public.builtInAggregationTypes.count", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInAggregationTypes.count.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 20 } }, { "tags": [], "id": "def-public.builtInAggregationTypes.count.fieldRequired", "type": "boolean", "label": "fieldRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 21 }, "signature": [ "false" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.count.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 22 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AGGREGATION_TYPES", "text": "AGGREGATION_TYPES" } ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.count.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 23 }, "signature": [ "never[]" ] } ], "description": [], "label": "count", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 19 } }, { "id": "def-public.builtInAggregationTypes.avg", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInAggregationTypes.avg.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 26 } }, { "tags": [], "id": "def-public.builtInAggregationTypes.avg.fieldRequired", "type": "boolean", "label": "fieldRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 27 }, "signature": [ "true" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.avg.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 28 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.avg.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 29 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AGGREGATION_TYPES", "text": "AGGREGATION_TYPES" } ] } ], "description": [], "label": "avg", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 25 } }, { "id": "def-public.builtInAggregationTypes.sum", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInAggregationTypes.sum.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 32 } }, { "tags": [], "id": "def-public.builtInAggregationTypes.sum.fieldRequired", "type": "boolean", "label": "fieldRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 33 }, "signature": [ "true" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.sum.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 34 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.sum.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 35 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AGGREGATION_TYPES", "text": "AGGREGATION_TYPES" } ] } ], "description": [], "label": "sum", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 31 } }, { "id": "def-public.builtInAggregationTypes.min", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInAggregationTypes.min.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 38 } }, { "tags": [], "id": "def-public.builtInAggregationTypes.min.fieldRequired", "type": "boolean", "label": "fieldRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 39 }, "signature": [ "true" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.min.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 40 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.min.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 41 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AGGREGATION_TYPES", "text": "AGGREGATION_TYPES" } ] } ], "description": [], "label": "min", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 37 } }, { "id": "def-public.builtInAggregationTypes.max", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInAggregationTypes.max.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 44 } }, { "tags": [], "id": "def-public.builtInAggregationTypes.max.fieldRequired", "type": "boolean", "label": "fieldRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 45 }, "signature": [ "true" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.max.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 46 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-public.builtInAggregationTypes.max.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 47 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AGGREGATION_TYPES", "text": "AGGREGATION_TYPES" } ] } ], "description": [], "label": "max", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 43 } } ], "description": [], "label": "builtInAggregationTypes", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "lineNumber": 18 }, "initialIsOpen": false }, { "id": "def-public.builtInComparators", "type": "Object", "tags": [], "children": [ { "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 21 } }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 24 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.COMPARATORS", "text": "COMPARATORS" } ] }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN.requiredValues", "type": "number", "label": "requiredValues", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 25 } } ], "description": [], "label": "[COMPARATORS.GREATER_THAN]", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 20 } }, { "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 28 } }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 34 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.COMPARATORS", "text": "COMPARATORS" } ] }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.GREATER_THAN_OR_EQUALS.requiredValues", "type": "number", "label": "requiredValues", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 35 } } ], "description": [], "label": "[COMPARATORS.GREATER_THAN_OR_EQUALS]", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 27 } }, { "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 38 } }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 41 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.COMPARATORS", "text": "COMPARATORS" } ] }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN.requiredValues", "type": "number", "label": "requiredValues", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 42 } } ], "description": [], "label": "[COMPARATORS.LESS_THAN]", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 37 } }, { "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 45 } }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 51 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.COMPARATORS", "text": "COMPARATORS" } ] }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.LESS_THAN_OR_EQUALS.requiredValues", "type": "number", "label": "requiredValues", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 52 } } ], "description": [], "label": "[COMPARATORS.LESS_THAN_OR_EQUALS]", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 44 } }, { "id": "def-public.builtInComparators.COMPARATORS.BETWEEN", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.BETWEEN.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 55 } }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.BETWEEN.value", "type": "Enum", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 58 }, "signature": [ { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.COMPARATORS", "text": "COMPARATORS" } ] }, { "tags": [], "id": "def-public.builtInComparators.COMPARATORS.BETWEEN.requiredValues", "type": "number", "label": "requiredValues", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 59 } } ], "description": [], "label": "[COMPARATORS.BETWEEN]", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 54 } } ], "description": [], "label": "builtInComparators", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", "lineNumber": 19 }, "initialIsOpen": false }, { "id": "def-public.builtInGroupByTypes", "type": "Object", "tags": [], "children": [ { "id": "def-public.builtInGroupByTypes.all", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInGroupByTypes.all.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 13 } }, { "tags": [], "id": "def-public.builtInGroupByTypes.all.sizeRequired", "type": "boolean", "label": "sizeRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 19 }, "signature": [ "false" ] }, { "tags": [], "id": "def-public.builtInGroupByTypes.all.value", "type": "string", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 20 } }, { "tags": [], "id": "def-public.builtInGroupByTypes.all.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 21 }, "signature": [ "never[]" ] } ], "description": [], "label": "all", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 12 } }, { "id": "def-public.builtInGroupByTypes.top", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.builtInGroupByTypes.top.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 24 } }, { "tags": [], "id": "def-public.builtInGroupByTypes.top.sizeRequired", "type": "boolean", "label": "sizeRequired", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 30 }, "signature": [ "true" ] }, { "tags": [], "id": "def-public.builtInGroupByTypes.top.value", "type": "string", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 31 } }, { "tags": [], "id": "def-public.builtInGroupByTypes.top.validNormalizedTypes", "type": "Array", "label": "validNormalizedTypes", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 32 }, "signature": [ "string[]" ] } ], "description": [], "label": "top", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 23 } } ], "description": [], "label": "builtInGroupByTypes", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-public.firstFieldOption", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.firstFieldOption.text", "type": "string", "label": "text", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 93 } }, { "tags": [], "id": "def-public.firstFieldOption.value", "type": "string", "label": "value", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 99 } } ], "description": [], "label": "firstFieldOption", "source": { "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "lineNumber": 92 }, "initialIsOpen": false } ], "setup": { "id": "def-public.TriggersAndActionsUIPublicPluginSetup", "type": "Interface", "label": "TriggersAndActionsUIPublicPluginSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginSetup.actionTypeRegistry", "type": "Object", "label": "actionTypeRegistry", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 42 }, "signature": [ "TypeRegistry", "<", "ActionTypeModel", ">" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginSetup.alertTypeRegistry", "type": "Object", "label": "alertTypeRegistry", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 43 }, "signature": [ "TypeRegistry", "<", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AlertTypeModel", "text": "AlertTypeModel" }, ">" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 41 }, "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-public.TriggersAndActionsUIPublicPluginStart", "type": "Interface", "label": "TriggersAndActionsUIPublicPluginStart", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginStart.actionTypeRegistry", "type": "Object", "label": "actionTypeRegistry", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 47 }, "signature": [ "TypeRegistry", "<", "ActionTypeModel", ">" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginStart.alertTypeRegistry", "type": "Object", "label": "alertTypeRegistry", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 48 }, "signature": [ "TypeRegistry", "<", { "pluginId": "triggersActionsUi", "scope": "public", "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.AlertTypeModel", "text": "AlertTypeModel" }, ">" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddConnectorFlyout", "type": "Function", "label": "getAddConnectorFlyout", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 49 }, "signature": [ "(props: Pick<", "ConnectorAddFlyoutProps", ", \"onClose\" | \"consumer\" | \"actionTypes\" | \"onTestConnector\" | \"reloadConnectors\">) => React.ReactElement<", "ConnectorAddFlyoutProps", ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditConnectorFlyout", "type": "Function", "label": "getEditConnectorFlyout", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 52 }, "signature": [ "(props: Pick<", "ConnectorEditFlyoutProps", ", \"onClose\" | \"consumer\" | \"reloadConnectors\" | \"initialConnector\" | \"tab\">) => React.ReactElement<", "ConnectorEditFlyoutProps", ", string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddAlertFlyout", "type": "Function", "label": "getAddAlertFlyout", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 55 }, "signature": [ "(props: Pick<", "AlertAddProps", ">, \"onClose\" | \"metadata\" | \"onSave\" | \"alertTypeId\" | \"consumer\" | \"canChangeTrigger\" | \"initialValues\" | \"reloadAlerts\">) => React.ReactElement<", "AlertAddProps", ">, string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] }, { "tags": [], "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditAlertFlyout", "type": "Function", "label": "getEditAlertFlyout", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 58 }, "signature": [ "(props: Pick<", "AlertEditProps", ">, \"onClose\" | \"metadata\" | \"onSave\" | \"reloadAlerts\" | \"initialAlert\">) => React.ReactElement<", "AlertEditProps", ">, string | ((props: any) => React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "lineNumber": 46 }, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [ { "id": "def-server.validateCoreQueryBody", "type": "Function", "label": "validateCoreQueryBody", "signature": [ "(anyParams: unknown) => string | undefined" ], "description": [], "children": [ { "id": "def-server.validateCoreQueryBody.$1", "type": "Unknown", "label": "anyParams", "isRequired": true, "signature": [ "unknown" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 46 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 46 }, "initialIsOpen": false }, { "id": "def-server.validateTimeWindowUnits", "type": "Function", "label": "validateTimeWindowUnits", "signature": [ "(timeWindowUnit: string) => string | undefined" ], "description": [], "children": [ { "id": "def-server.validateTimeWindowUnits.$1", "type": "string", "label": "timeWindowUnit", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 128 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 128 }, "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [ { "id": "def-server.CoreQueryParams", "type": "Type", "label": "CoreQueryParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 40 }, "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; }" ], "initialIsOpen": false }, { "tags": [], "id": "def-server.DEFAULT_GROUPS", "type": "number", "label": "DEFAULT_GROUPS", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/index.ts", "lineNumber": 23 }, "signature": [ "100" ], "initialIsOpen": false }, { "tags": [], "id": "def-server.MAX_GROUPS", "type": "number", "label": "MAX_GROUPS", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/index.ts", "lineNumber": 22 }, "signature": [ "1000" ], "initialIsOpen": false }, { "tags": [], "id": "def-server.MAX_INTERVALS", "type": "number", "label": "MAX_INTERVALS", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/index.ts", "lineNumber": 21 }, "signature": [ "1000" ], "initialIsOpen": false }, { "id": "def-server.TimeSeriesQuery", "type": "Type", "label": "TimeSeriesQuery", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/time_series_types.ts", "lineNumber": 29 }, "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; }" ], "initialIsOpen": false } ], "objects": [ { "id": "def-server.CoreQueryParamsSchemaProperties", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.index", "type": "Object", "label": "index", "description": [ "// name of the indices to search" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 17 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.timeField", "type": "Object", "label": "timeField", "description": [ "// field in index used for date/time" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 22 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.aggType", "type": "Object", "label": "aggType", "description": [ "// aggregation type" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 24 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.aggField", "type": "Object", "label": "aggField", "description": [ "// aggregation field" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 26 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.groupBy", "type": "Object", "label": "groupBy", "description": [ "// how to group" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 28 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.termField", "type": "Object", "label": "termField", "description": [ "// field to group on (for groupBy: top)" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 30 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.termSize", "type": "Object", "label": "termSize", "description": [ "// limit on number of groups returned" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 32 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.timeWindowSize", "type": "Object", "label": "timeWindowSize", "description": [ "// size of time window for date range aggregations" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 34 }, "signature": [ "Type", "" ] }, { "tags": [], "id": "def-server.CoreQueryParamsSchemaProperties.timeWindowUnit", "type": "Object", "label": "timeWindowUnit", "description": [ "// units of time window for date range aggregations" ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 36 }, "signature": [ "Type", "" ] } ], "description": [], "label": "CoreQueryParamsSchemaProperties", "source": { "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "lineNumber": 15 }, "initialIsOpen": false } ], "start": { "id": "def-server.PluginStartContract", "type": "Interface", "label": "PluginStartContract", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.PluginStartContract.data", "type": "Object", "label": "data", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/plugin.ts", "lineNumber": 16 }, "signature": [ "{ timeSeriesQuery: typeof ", "timeSeriesQuery", "; }" ] } ], "source": { "path": "x-pack/plugins/triggers_actions_ui/server/plugin.ts", "lineNumber": 15 }, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [ { "id": "def-common.TimeSeriesResult", "type": "Interface", "label": "TimeSeriesResult", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.TimeSeriesResult.results", "type": "Array", "label": "results", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts", "lineNumber": 9 }, "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": 8 }, "initialIsOpen": false }, { "id": "def-common.TimeSeriesResultRow", "type": "Interface", "label": "TimeSeriesResultRow", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.TimeSeriesResultRow.group", "type": "string", "label": "group", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts", "lineNumber": 13 } }, { "tags": [], "id": "def-common.TimeSeriesResultRow.metrics", "type": "Array", "label": "metrics", "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts", "lineNumber": 14 }, "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": 12 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "id": "def-common.MetricResult", "type": "Type", "label": "MetricResult", "tags": [], "description": [], "source": { "path": "x-pack/plugins/triggers_actions_ui/common/data/index.ts", "lineNumber": 17 }, "signature": [ "[string, number]" ], "initialIsOpen": false } ], "objects": [] } }