* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
3968 lines
150 KiB
JSON
3968 lines
150 KiB
JSON
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L88"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.Plugin.setup",
|
|
"type": "Function",
|
|
"label": "setup",
|
|
"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"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L93"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "plugins",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"PluginsSetup"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L93"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L93"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L169"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L203"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 77,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L77"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/alert_form/index.tsx#L11"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"AlertAddProps",
|
|
"<Record<string, any>>) => JSX.Element"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx#L17"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"AlertEditProps",
|
|
"<Record<string, any>>) => 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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx#L13"
|
|
},
|
|
"signature": [
|
|
"React.LazyExoticComponent<(<ConditionProps extends unknown, ActionGroupIds extends string>({ headline, actionGroups, onInitializeConditionsFor, onResetConditionsFor, includeBuiltInActionGroups, children, }: React.PropsWithChildren<",
|
|
"AlertConditionsProps",
|
|
"<ConditionProps, ActionGroupIds>>) => 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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx#L14"
|
|
},
|
|
"signature": [
|
|
"React.LazyExoticComponent<(<ConditionProps extends unknown>({ actionGroup, onResetConditionsFor, children, ...otherProps }: React.PropsWithChildren<",
|
|
"AlertConditionsGroupProps",
|
|
"<ConditionProps>>) => JSX.Element | null)>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts#L17"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"ActionAccordionFormProps",
|
|
") => 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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts#L11"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/index.ts#L14"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"ConnectorEditFlyoutProps",
|
|
") => 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.{-http }",
|
|
"type": "Object",
|
|
"label": "{ http }",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.loadActionTypes.{-http }.http",
|
|
"type": "Object",
|
|
"label": "http",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts#L13"
|
|
},
|
|
"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.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts#L13"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts#L13"
|
|
},
|
|
"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": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts#L11"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts#L11"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/lib/get_time_unit_label.ts#L11"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx#L64"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx#L99"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/jira/jira.tsx#L63"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/resilient/resilient.tsx#L68"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts#L11"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"GroupByExpressionProps",
|
|
") => 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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts#L12"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"ForLastExpressionProps",
|
|
") => 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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts#L13"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts#L15"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"WhenExpressionProps",
|
|
") => JSX.Element"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts#L16"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts#L17"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
"ThresholdExpressionProps",
|
|
") => JSX.Element"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getIndexPatterns",
|
|
"type": "Function",
|
|
"children": [],
|
|
"signature": [
|
|
"() => Promise<any>"
|
|
],
|
|
"description": [],
|
|
"label": "getIndexPatterns",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L23"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getIndexOptions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L33"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L35"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L32"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getFields",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L88"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L88"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L88"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getTimeFieldOptions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts#L25"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts#L24"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getTimeOptions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts#L11"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts#L11"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"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/alerts/common/alert.ts",
|
|
"lineNumber": 44,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L44"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertAction.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 45,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L45"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertAction.actionTypeId",
|
|
"type": "string",
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L46"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertAction.params",
|
|
"type": "Object",
|
|
"label": "params",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L47"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L43"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.AlertTypeModel",
|
|
"type": "Interface",
|
|
"label": "AlertTypeModel",
|
|
"signature": [
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertTypeModel",
|
|
"text": "AlertTypeModel"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"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": 221,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L221"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeModel.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 222,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L222"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeModel.iconClass",
|
|
"type": "string",
|
|
"label": "iconClass",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 223,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L223"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeModel.documentationUrl",
|
|
"type": "CompoundType",
|
|
"label": "documentationUrl",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 224,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L224"
|
|
},
|
|
"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": 225,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L225"
|
|
},
|
|
"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": 226,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L226"
|
|
},
|
|
"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>>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeModel.requiresAppContext",
|
|
"type": "boolean",
|
|
"label": "requiresAppContext",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 229,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L229"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeModel.defaultActionMessage",
|
|
"type": "string",
|
|
"label": "defaultActionMessage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 230,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L230"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 220,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L220"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/actions/common/types.ts#L11"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionType.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/actions/common/types.ts#L12"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionType.enabled",
|
|
"type": "boolean",
|
|
"label": "enabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/actions/common/types.ts#L13"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionType.enabledInConfig",
|
|
"type": "boolean",
|
|
"label": "enabledInConfig",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/actions/common/types.ts#L14"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionType.enabledInLicense",
|
|
"type": "boolean",
|
|
"label": "enabledInLicense",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/actions/common/types.ts#L15"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/actions/common/types.ts#L16"
|
|
},
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/actions/common/types.ts#L10"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.AlertTypeParamsExpressionProps",
|
|
"type": "Interface",
|
|
"label": "AlertTypeParamsExpressionProps",
|
|
"signature": [
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertTypeParamsExpressionProps",
|
|
"text": "AlertTypeParamsExpressionProps"
|
|
},
|
|
"<Params, MetaData, ActionGroupIds>"
|
|
],
|
|
"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": 203,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L203"
|
|
},
|
|
"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": 204,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L204"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeParamsExpressionProps.alertThrottle",
|
|
"type": "string",
|
|
"label": "alertThrottle",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 205,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L205"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeParamsExpressionProps.alertNotifyWhen",
|
|
"type": "CompoundType",
|
|
"label": "alertNotifyWhen",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 206,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L206"
|
|
},
|
|
"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": 207,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L207"
|
|
},
|
|
"signature": [
|
|
"<Key extends keyof Params>(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": 208,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L208"
|
|
},
|
|
"signature": [
|
|
"<Prop extends \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">(key: Prop, value: Pick<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.Alert",
|
|
"text": "Alert"
|
|
},
|
|
"<Params>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"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": 212,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L212"
|
|
},
|
|
"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": 213,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L213"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeParamsExpressionProps.actionGroups",
|
|
"type": "Array",
|
|
"label": "actionGroups",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 214,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L214"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.AlertTypeParamsExpressionProps.metadata",
|
|
"type": "Uncategorized",
|
|
"label": "metadata",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 215,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L215"
|
|
},
|
|
"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": 216,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L216"
|
|
},
|
|
"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": 217,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L217"
|
|
},
|
|
"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": 198,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L198"
|
|
},
|
|
"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": 110,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L110"
|
|
},
|
|
"signature": [
|
|
"Record<string, any>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 109,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L109"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.ActionVariable",
|
|
"type": "Interface",
|
|
"label": "ActionVariable",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionVariable.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 156,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L156"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionVariable.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 157,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L157"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ActionVariable.useWithTripleBracesInTemplates",
|
|
"type": "CompoundType",
|
|
"label": "useWithTripleBracesInTemplates",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 158,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L158"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 155,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L155"
|
|
},
|
|
"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": 234,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L234"
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 233,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L233"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L35"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L36"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "charts",
|
|
"scope": "public",
|
|
"docId": "kibChartsPluginApi",
|
|
"section": "def-public.ChartsPluginSetup",
|
|
"text": "ChartsPluginSetup"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.TriggersAndActionsUiServices.alerts",
|
|
"type": "Object",
|
|
"label": "alerts",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L37"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "public",
|
|
"docId": "kibAlertsPluginApi",
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L38"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L39"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L40"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L41"
|
|
},
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.TypeRegistry",
|
|
"text": "TypeRegistry"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.ActionTypeModel",
|
|
"text": "ActionTypeModel"
|
|
},
|
|
"<unknown, unknown, any>>, \"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L42"
|
|
},
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.TypeRegistry",
|
|
"text": "TypeRegistry"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertTypeModel",
|
|
"text": "AlertTypeModel"
|
|
},
|
|
"<Record<string, unknown>>>, \"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L43"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ScopedHistory",
|
|
"text": "ScopedHistory"
|
|
},
|
|
"<unknown>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L44"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L45"
|
|
},
|
|
"signature": [
|
|
"HTMLElement"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/app.tsx#L34"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L19"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L20"
|
|
},
|
|
"signature": [
|
|
"{ value: string; label: string; }[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L18"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L9"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L10"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L11"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
|
|
"lineNumber": 8,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L8"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L15"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L16"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L17"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L18"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L14"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L22"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L23"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L24"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L25"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/types.ts#L21"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"id": "def-public.AlertFlyoutCloseReason",
|
|
"type": "Enum",
|
|
"label": "AlertFlyoutCloseReason",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 66,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L66"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/constants/time_units.ts#L8"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L10"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/application/sections/alert_form/alert_conditions.tsx#L16"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds> & { conditions?: T | undefined; isRequired?: false | undefined; } | ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds> & { conditions: T; isRequired: true; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.Alert",
|
|
"type": "Type",
|
|
"label": "Alert",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L33"
|
|
},
|
|
"signature": [
|
|
"{ enabled: boolean; id: string; name: string; params: Record<string, unknown>; actions: AlertAction[]; muteAll: boolean; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"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": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertExecutionStatus",
|
|
"text": "AlertExecutionStatus"
|
|
},
|
|
"; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.ActionTypeRegistryContract",
|
|
"type": "Type",
|
|
"label": "ActionTypeRegistryContract",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 51,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L51"
|
|
},
|
|
"signature": [
|
|
"{ get: (id: string) => ActionTypeModel<ActionConnector, ActionParams, any>; register: (objectType: ActionTypeModel<ActionConnector, ActionParams, any>) => void; list: () => ActionTypeModel<ActionConnector, ActionParams, any>[]; has: (id: string) => boolean; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.AlertTypeRegistryContract",
|
|
"type": "Type",
|
|
"label": "AlertTypeRegistryContract",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L55"
|
|
},
|
|
"signature": [
|
|
"{ get: (id: string) => AlertTypeModel<Record<string, unknown>>; register: (objectType: AlertTypeModel<Record<string, unknown>>) => void; list: () => AlertTypeModel<Record<string, unknown>>[]; 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": 166,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L166"
|
|
},
|
|
"signature": [
|
|
"AsActionVariables<\"params\" | \"state\"> & Partial<AsActionVariables<\"context\">>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.ActionConnector",
|
|
"type": "Type",
|
|
"label": "ActionConnector",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
|
|
"lineNumber": 142,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/types.ts#L142"
|
|
},
|
|
"signature": [
|
|
"PreConfiguredActionConnector",
|
|
" | ",
|
|
"UserConfiguredActionConnector",
|
|
"<Config, Secrets>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.AlertTypeParams",
|
|
"type": "Type",
|
|
"label": "AlertTypeParams",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L12"
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/index.ts#L12"
|
|
},
|
|
"signature": [
|
|
"\"https://www.elastic.co/subscriptions\""
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/index.ts#L14"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/index.ts#L16"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L21"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L24"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L25"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "[COMPARATORS.GREATER_THAN]",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L20"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L28"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L34"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L35"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "[COMPARATORS.GREATER_THAN_OR_EQUALS]",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L27"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L38"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L41"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L42"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "[COMPARATORS.LESS_THAN]",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L37"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L45"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L51"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L52"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "[COMPARATORS.LESS_THAN_OR_EQUALS]",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
|
|
"lineNumber": 44,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L44"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L55"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L58"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L59"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "[COMPARATORS.BETWEEN]",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
|
|
"lineNumber": 54,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L54"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "builtInComparators",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts#L19"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L20"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L21"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L22"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L23"
|
|
},
|
|
"signature": [
|
|
"never[]"
|
|
]
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "count",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L19"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L26"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L27"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L28"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L29"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L25"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L32"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L33"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L34"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L35"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L31"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L38"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L39"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L40"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L41"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L37"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L44"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L45"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L46"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L47"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L43"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "builtInAggregationTypes",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts#L18"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L13"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L19"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L20"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L21"
|
|
},
|
|
"signature": [
|
|
"never[]"
|
|
]
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "all",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L12"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L24"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L30"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L31"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L32"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "top",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L23"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "builtInGroupByTypes",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/constants/group_by_types.ts#L11"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L93"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L99"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "firstFieldOption",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts",
|
|
"lineNumber": 92,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts#L92"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L42"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.TypeRegistry",
|
|
"text": "TypeRegistry"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.ActionTypeModel",
|
|
"text": "ActionTypeModel"
|
|
},
|
|
"<any, any, any>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.TriggersAndActionsUIPublicPluginSetup.alertTypeRegistry",
|
|
"type": "Object",
|
|
"label": "alertTypeRegistry",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L43"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.TypeRegistry",
|
|
"text": "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": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L41"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L47"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.TypeRegistry",
|
|
"text": "TypeRegistry"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.ActionTypeModel",
|
|
"text": "ActionTypeModel"
|
|
},
|
|
"<any, any, any>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.TriggersAndActionsUIPublicPluginStart.alertTypeRegistry",
|
|
"type": "Object",
|
|
"label": "alertTypeRegistry",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L48"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.TypeRegistry",
|
|
"text": "TypeRegistry"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertTypeModel",
|
|
"text": "AlertTypeModel"
|
|
},
|
|
"<any>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddConnectorFlyout",
|
|
"type": "Function",
|
|
"label": "getAddConnectorFlyout",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 49,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L49"
|
|
},
|
|
"signature": [
|
|
"(props: Pick<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.ConnectorAddFlyoutProps",
|
|
"text": "ConnectorAddFlyoutProps"
|
|
},
|
|
", \"onClose\" | \"consumer\" | \"actionTypes\" | \"onTestConnector\" | \"reloadConnectors\">) => React.ReactElement<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.ConnectorAddFlyoutProps",
|
|
"text": "ConnectorAddFlyoutProps"
|
|
},
|
|
", 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>)>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditConnectorFlyout",
|
|
"type": "Function",
|
|
"label": "getEditConnectorFlyout",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 52,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L52"
|
|
},
|
|
"signature": [
|
|
"(props: Pick<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.ConnectorEditFlyoutProps",
|
|
"text": "ConnectorEditFlyoutProps"
|
|
},
|
|
", \"onClose\" | \"consumer\" | \"reloadConnectors\" | \"initialConnector\" | \"tab\">) => React.ReactElement<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.ConnectorEditFlyoutProps",
|
|
"text": "ConnectorEditFlyoutProps"
|
|
},
|
|
", 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>)>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddAlertFlyout",
|
|
"type": "Function",
|
|
"label": "getAddAlertFlyout",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L55"
|
|
},
|
|
"signature": [
|
|
"(props: Pick<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertAddProps",
|
|
"text": "AlertAddProps"
|
|
},
|
|
"<Record<string, any>>, \"onClose\" | \"metadata\" | \"onSave\" | \"alertTypeId\" | \"consumer\" | \"canChangeTrigger\" | \"initialValues\" | \"reloadAlerts\">) => React.ReactElement<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertAddProps",
|
|
"text": "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>)>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditAlertFlyout",
|
|
"type": "Function",
|
|
"label": "getEditAlertFlyout",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
|
|
"lineNumber": 58,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L58"
|
|
},
|
|
"signature": [
|
|
"(props: Pick<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertEditProps",
|
|
"text": "AlertEditProps"
|
|
},
|
|
"<Record<string, any>>, \"onClose\" | \"metadata\" | \"onSave\" | \"reloadAlerts\" | \"initialAlert\">) => React.ReactElement<",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.AlertEditProps",
|
|
"text": "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": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/public/plugin.ts#L46"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-server.validateCoreQueryBody",
|
|
"type": "Function",
|
|
"label": "validateCoreQueryBody",
|
|
"signature": [
|
|
"(anyParams: unknown) => string | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L46"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L46"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.validateTimeWindowUnits",
|
|
"type": "Function",
|
|
"label": "validateTimeWindowUnits",
|
|
"signature": [
|
|
"(timeWindowUnit: string) => string | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L128"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
|
|
"lineNumber": 128,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L128"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/time_series_types.ts#L29"
|
|
},
|
|
"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
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L40"
|
|
},
|
|
"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.MAX_INTERVALS",
|
|
"type": "number",
|
|
"label": "MAX_INTERVALS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/server/data/index.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/index.ts#L21"
|
|
},
|
|
"signature": [
|
|
"1000"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/index.ts#L22"
|
|
},
|
|
"signature": [
|
|
"1000"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/index.ts#L23"
|
|
},
|
|
"signature": [
|
|
"100"
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L17"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<string | string[]>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L22"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<string>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L24"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<string>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L26"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<string | undefined>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L28"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<string>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L30"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<string | undefined>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L32"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<number | undefined>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L34"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<number>"
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L36"
|
|
},
|
|
"signature": [
|
|
"Type",
|
|
"<string>"
|
|
]
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "CoreQueryParamsSchemaProperties",
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts#L15"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/plugin.ts#L16"
|
|
},
|
|
"signature": [
|
|
"{ timeSeriesQuery: typeof ",
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "server",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-server.timeSeriesQuery",
|
|
"text": "timeSeriesQuery"
|
|
},
|
|
"; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/triggers_actions_ui/server/plugin.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/server/plugin.ts#L15"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/common/data/index.ts#L9"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/common/data/index.ts#L8"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/common/data/index.ts#L13"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/common/data/index.ts#L14"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/common/data/index.ts#L12"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/triggers_actions_ui/common/data/index.ts#L17"
|
|
},
|
|
"signature": [
|
|
"[string, number]"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |