* 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
3419 lines
117 KiB
JSON
3419 lines
117 KiB
JSON
{
|
|
"id": "alerts",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.PluginSetupContract",
|
|
"type": "Interface",
|
|
"label": "PluginSetupContract",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginSetupContract.registerNavigation",
|
|
"type": "Function",
|
|
"label": "registerNavigation",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/public/plugin.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/public/plugin.ts#L15"
|
|
},
|
|
"signature": [
|
|
"(consumer: string, alertType: string, handler: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "public",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-public.AlertNavigationHandler",
|
|
"text": "AlertNavigationHandler"
|
|
},
|
|
") => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginSetupContract.registerDefaultNavigation",
|
|
"type": "Function",
|
|
"label": "registerDefaultNavigation",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/public/plugin.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/public/plugin.ts#L20"
|
|
},
|
|
"signature": [
|
|
"(consumer: string, handler: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "public",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-public.AlertNavigationHandler",
|
|
"text": "AlertNavigationHandler"
|
|
},
|
|
") => void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/public/plugin.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/public/plugin.ts#L14"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.PluginStartContract",
|
|
"type": "Interface",
|
|
"label": "PluginStartContract",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginStartContract.getNavigation",
|
|
"type": "Function",
|
|
"label": "getNavigation",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/public/plugin.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/public/plugin.ts#L23"
|
|
},
|
|
"signature": [
|
|
"(alertId: string) => Promise<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertUrlNavigation",
|
|
"text": "AlertUrlNavigation"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertStateNavigation",
|
|
"text": "AlertStateNavigation"
|
|
},
|
|
" | undefined>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/public/plugin.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/public/plugin.ts#L22"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-server.parseDuration",
|
|
"type": "Function",
|
|
"label": "parseDuration",
|
|
"signature": [
|
|
"(duration: string) => number"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "duration",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L14"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L14"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.ActionVariable",
|
|
"type": "Interface",
|
|
"label": "ActionVariable",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionVariable.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 106,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L106"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionVariable.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 107,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L107"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionVariable.useWithTripleBracesInTemplates",
|
|
"type": "CompoundType",
|
|
"label": "useWithTripleBracesInTemplates",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 108,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L108"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 105,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L105"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertType",
|
|
"type": "Interface",
|
|
"label": "AlertType",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertType",
|
|
"text": "AlertType"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 132,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L132"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 133,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L133"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.validate",
|
|
"type": "Object",
|
|
"label": "validate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 134,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L134"
|
|
},
|
|
"signature": [
|
|
"{ params?: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertTypeParamsValidator",
|
|
"text": "AlertTypeParamsValidator"
|
|
},
|
|
"<Params> | undefined; } | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.actionGroups",
|
|
"type": "Array",
|
|
"label": "actionGroups",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 137,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L137"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.defaultActionGroupId",
|
|
"type": "Uncategorized",
|
|
"label": "defaultActionGroupId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 138,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L138"
|
|
},
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.recoveryActionGroup",
|
|
"type": "Object",
|
|
"label": "recoveryActionGroup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 139,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L139"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.executor",
|
|
"type": "Function",
|
|
"label": "executor",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 140,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L140"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.ExecutorType",
|
|
"text": "ExecutorType"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.WithoutReservedActionGroups",
|
|
"text": "WithoutReservedActionGroups"
|
|
},
|
|
"<ActionGroupIds, RecoveryActionGroupId>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.producer",
|
|
"type": "string",
|
|
"label": "producer",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 151,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L151"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.actionVariables",
|
|
"type": "Object",
|
|
"label": "actionVariables",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 152,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L152"
|
|
},
|
|
"signature": [
|
|
"{ context?: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[] | undefined; state?: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[] | undefined; params?: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[] | undefined; } | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 157,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L157"
|
|
},
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 124,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L124"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionGroup",
|
|
"type": "Interface",
|
|
"label": "ActionGroup",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionGroup.id",
|
|
"type": "Uncategorized",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L26"
|
|
},
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionGroup.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L27"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L25"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertingPlugin",
|
|
"type": "Interface",
|
|
"label": "AlertingPlugin",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertingPlugin.setup",
|
|
"type": "Object",
|
|
"label": "setup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 231,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L231"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertingPlugin.start",
|
|
"type": "Object",
|
|
"label": "start",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 232,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L232"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.PluginStartContract",
|
|
"text": "PluginStartContract"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 230,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L230"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertExecutorOptions",
|
|
"type": "Interface",
|
|
"label": "AlertExecutorOptions",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertExecutorOptions",
|
|
"text": "AlertExecutorOptions"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.alertId",
|
|
"type": "string",
|
|
"label": "alertId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 91,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L91"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.startedAt",
|
|
"type": "Object",
|
|
"label": "startedAt",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 92,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L92"
|
|
},
|
|
"signature": [
|
|
"Date"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.previousStartedAt",
|
|
"type": "CompoundType",
|
|
"label": "previousStartedAt",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L93"
|
|
},
|
|
"signature": [
|
|
"Date | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.services",
|
|
"type": "Object",
|
|
"label": "services",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 94,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L94"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertServices",
|
|
"text": "AlertServices"
|
|
},
|
|
"<InstanceState, InstanceContext, ActionGroupIds>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.params",
|
|
"type": "Uncategorized",
|
|
"label": "params",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 95,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L95"
|
|
},
|
|
"signature": [
|
|
"Params"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.state",
|
|
"type": "Uncategorized",
|
|
"label": "state",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 96,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L96"
|
|
},
|
|
"signature": [
|
|
"State"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.spaceId",
|
|
"type": "string",
|
|
"label": "spaceId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 97,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L97"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.namespace",
|
|
"type": "string",
|
|
"label": "namespace",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 98,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L98"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 99,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L99"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.tags",
|
|
"type": "Array",
|
|
"label": "tags",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 100,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L100"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.createdBy",
|
|
"type": "CompoundType",
|
|
"label": "createdBy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 101,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L101"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertExecutorOptions.updatedBy",
|
|
"type": "CompoundType",
|
|
"label": "updatedBy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 102,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L102"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 84,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L84"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertServices",
|
|
"type": "Interface",
|
|
"label": "AlertServices",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertServices",
|
|
"text": "AlertServices"
|
|
},
|
|
"<InstanceState, InstanceContext, ActionGroupIds> extends ",
|
|
"Services"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertServices.alertInstanceFactory",
|
|
"type": "Function",
|
|
"label": "alertInstanceFactory",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 79,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L79"
|
|
},
|
|
"signature": [
|
|
"(id: string) => Pick<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertInstance",
|
|
"text": "AlertInstance"
|
|
},
|
|
"<InstanceState, InstanceContext, ActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 74,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L74"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertingApiRequestHandlerContext",
|
|
"type": "Interface",
|
|
"label": "AlertingApiRequestHandlerContext",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertingApiRequestHandlerContext.getAlertsClient",
|
|
"type": "Function",
|
|
"label": "getAlertsClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L47"
|
|
},
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertsClient",
|
|
"text": "AlertsClient"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertingApiRequestHandlerContext.listTypes",
|
|
"type": "Function",
|
|
"label": "listTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L48"
|
|
},
|
|
"signature": [
|
|
"() => Set<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.RegistryAlertType",
|
|
"text": "RegistryAlertType"
|
|
},
|
|
">"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.AlertingApiRequestHandlerContext.getFrameworkHealth",
|
|
"type": "Function",
|
|
"label": "getFrameworkHealth",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 49,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L49"
|
|
},
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertsHealth",
|
|
"text": "AlertsHealth"
|
|
},
|
|
">"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L46"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.PluginSetupContract",
|
|
"type": "Interface",
|
|
"label": "PluginSetupContract",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.PluginSetupContract.registerType",
|
|
"type": "Function",
|
|
"label": "registerType",
|
|
"signature": [
|
|
"<Params extends Record<string, unknown> = Record<string, unknown>, State extends Record<string, unknown> = Record<string, unknown>, InstanceState extends { [x: string]: unknown; } = { [x: string]: unknown; }, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = never, RecoveryActionGroupId extends string = never>(alertType: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertType",
|
|
"text": "AlertType"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId>) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "alertType",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertType",
|
|
"text": "AlertType"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 112,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L112"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 104,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L104"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 103,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L103"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract",
|
|
"type": "Interface",
|
|
"label": "PluginStartContract",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.PluginStartContract.listTypes",
|
|
"type": "Function",
|
|
"label": "listTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 124,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L124"
|
|
},
|
|
"signature": [
|
|
"() => Set<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.RegistryAlertType",
|
|
"text": "RegistryAlertType"
|
|
},
|
|
">"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract.getAlertsClientWithRequest",
|
|
"type": "Function",
|
|
"label": "getAlertsClientWithRequest",
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Pick<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.AlertsClient",
|
|
"text": "AlertsClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 125,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L125"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 125,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L125"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.PluginStartContract.getFrameworkHealth",
|
|
"type": "Function",
|
|
"label": "getFrameworkHealth",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 126,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L126"
|
|
},
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertsHealth",
|
|
"text": "AlertsHealth"
|
|
},
|
|
">"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/plugin.ts",
|
|
"lineNumber": 123,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/plugin.ts#L123"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.FindResult",
|
|
"type": "Interface",
|
|
"label": "FindResult",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.FindResult",
|
|
"text": "FindResult"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FindResult.page",
|
|
"type": "number",
|
|
"label": "page",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts",
|
|
"lineNumber": 131,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L131"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FindResult.perPage",
|
|
"type": "number",
|
|
"label": "perPage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts",
|
|
"lineNumber": 132,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L132"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FindResult.total",
|
|
"type": "number",
|
|
"label": "total",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts",
|
|
"lineNumber": 133,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L133"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FindResult.data",
|
|
"type": "Array",
|
|
"label": "data",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts",
|
|
"lineNumber": 134,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L134"
|
|
},
|
|
"signature": [
|
|
"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\">[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts",
|
|
"lineNumber": 130,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L130"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.AlertsClient",
|
|
"type": "Type",
|
|
"label": "AlertsClient",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/index.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/index.ts#L15"
|
|
},
|
|
"signature": [
|
|
"{ get: <Params>({ id, }: { id: string; }) => Promise<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\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: <Params extends Record<string, unknown> = never>({ data, options, }: ",
|
|
"CreateOptions",
|
|
"<Params>) => Promise<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.Alert",
|
|
"text": "Alert"
|
|
},
|
|
"<Params>>; find: <Params>({ options: { fields, ...options }, }?: { options?: ",
|
|
"FindOptions",
|
|
" | undefined; }) => Promise<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "server",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-server.FindResult",
|
|
"text": "FindResult"
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionGroupIdsOf",
|
|
"type": "Type",
|
|
"label": "ActionGroupIdsOf",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L30"
|
|
},
|
|
"signature": [
|
|
"T extends ActionGroup<infer groups> ? groups : T extends Readonly<ActionGroup<infer groups>> ? groups : never"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertActionParams",
|
|
"type": "Type",
|
|
"label": "AlertActionParams",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L40"
|
|
},
|
|
"signature": [
|
|
"SavedObjectAttributes"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertTypeState",
|
|
"type": "Type",
|
|
"label": "AlertTypeState",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L11"
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.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
|
|
},
|
|
{
|
|
"id": "def-server.PartialAlert",
|
|
"type": "Type",
|
|
"label": "PartialAlert",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/types.ts",
|
|
"lineNumber": 190,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/types.ts#L190"
|
|
},
|
|
"signature": [
|
|
"Pick<Alert<Params>, \"id\"> & Partial<Pick<Alert<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertInstanceState",
|
|
"type": "Type",
|
|
"label": "AlertInstanceState",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance.ts#L25"
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.AlertInstanceContext",
|
|
"type": "Type",
|
|
"label": "AlertInstanceContext",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance.ts#L28"
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.PublicAlertInstance",
|
|
"type": "Type",
|
|
"label": "PublicAlertInstance",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/server/alert_instance/alert_instance.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/server/alert_instance/alert_instance.ts#L30"
|
|
},
|
|
"signature": [
|
|
"{ getState: () => State; replaceState: (state: State) => AlertInstance<State, Context, ActionGroupIds>; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance<State, Context, ActionGroupIds>; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance<State, Context, ActionGroupIds>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-common.getBuiltinActionGroups",
|
|
"type": "Function",
|
|
"label": "getBuiltinActionGroups",
|
|
"signature": [
|
|
"(customRecoveryGroup: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId> | undefined) => [",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ReservedActionGroups",
|
|
"text": "ReservedActionGroups"
|
|
},
|
|
"<RecoveryActionGroupId>>]"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "customRecoveryGroup",
|
|
"isRequired": false,
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/builtin_action_groups.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/builtin_action_groups.ts#L31"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/builtin_action_groups.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/builtin_action_groups.ts#L30"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.isActionGroupDisabledForActionTypeId",
|
|
"type": "Function",
|
|
"label": "isActionGroupDisabledForActionTypeId",
|
|
"signature": [
|
|
"(actionGroup: string, actionTypeId: string) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "actionGroup",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/disabled_action_groups.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/disabled_action_groups.ts#L19"
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "actionTypeId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/disabled_action_groups.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/disabled_action_groups.ts#L20"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/disabled_action_groups.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/disabled_action_groups.ts#L18"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.validateNotifyWhenType",
|
|
"type": "Function",
|
|
"label": "validateNotifyWhenType",
|
|
"signature": [
|
|
"(notifyWhen: string) => string | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "notifyWhen",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_notify_when_type.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_notify_when_type.ts#L15"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_notify_when_type.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_notify_when_type.ts#L15"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.parseDuration",
|
|
"type": "Function",
|
|
"label": "parseDuration",
|
|
"signature": [
|
|
"(duration: string) => number"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "duration",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L14"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L14"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.getDurationNumberInItsUnit",
|
|
"type": "Function",
|
|
"label": "getDurationNumberInItsUnit",
|
|
"signature": [
|
|
"(duration: string) => number"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "duration",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L30"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L30"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.getDurationUnitValue",
|
|
"type": "Function",
|
|
"label": "getDurationUnitValue",
|
|
"signature": [
|
|
"(duration: string) => string"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "duration",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L34"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L34"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.validateDurationSchema",
|
|
"type": "Function",
|
|
"label": "validateDurationSchema",
|
|
"signature": [
|
|
"(duration: string) => string | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "duration",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L39"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/parse_duration.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/parse_duration.ts#L39"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-common.AlertingFrameworkHealth",
|
|
"type": "Interface",
|
|
"label": "AlertingFrameworkHealth",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertingFrameworkHealth.isSufficientlySecure",
|
|
"type": "boolean",
|
|
"label": "isSufficientlySecure",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/index.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/index.ts#L22"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey",
|
|
"type": "boolean",
|
|
"label": "hasPermanentEncryptionKey",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/index.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/index.ts#L23"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertingFrameworkHealth.alertingFrameworkHeath",
|
|
"type": "Object",
|
|
"label": "alertingFrameworkHeath",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/index.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/index.ts#L24"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertsHealth",
|
|
"text": "AlertsHealth"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/index.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/index.ts#L21"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IntervalSchedule",
|
|
"type": "Interface",
|
|
"label": "IntervalSchedule",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.IntervalSchedule",
|
|
"text": "IntervalSchedule"
|
|
},
|
|
" extends ",
|
|
"SavedObjectAttributes"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IntervalSchedule.interval",
|
|
"type": "string",
|
|
"label": "interval",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L15"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L14"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertExecutionStatus",
|
|
"type": "Interface",
|
|
"label": "AlertExecutionStatus",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertExecutionStatus.status",
|
|
"type": "CompoundType",
|
|
"label": "status",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L32"
|
|
},
|
|
"signature": [
|
|
"\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\""
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertExecutionStatus.lastExecutionDate",
|
|
"type": "Object",
|
|
"label": "lastExecutionDate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L33"
|
|
},
|
|
"signature": [
|
|
"Date"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertExecutionStatus.error",
|
|
"type": "Object",
|
|
"label": "error",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L34"
|
|
},
|
|
"signature": [
|
|
"{ reason: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertExecutionStatusErrorReasons",
|
|
"text": "AlertExecutionStatusErrorReasons"
|
|
},
|
|
"; message: string; } | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L31"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertAction",
|
|
"type": "Interface",
|
|
"label": "AlertAction",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.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-common.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-common.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-common.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-common.AlertAggregations",
|
|
"type": "Interface",
|
|
"label": "AlertAggregations",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertAggregations.alertExecutionStatus",
|
|
"type": "Object",
|
|
"label": "alertExecutionStatus",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 51,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L51"
|
|
},
|
|
"signature": [
|
|
"{ [status: string]: number; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 50,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L50"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.Alert",
|
|
"type": "Interface",
|
|
"label": "Alert",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.Alert",
|
|
"text": "Alert"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L55"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.enabled",
|
|
"type": "boolean",
|
|
"label": "enabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 56,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L56"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 57,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L57"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.tags",
|
|
"type": "Array",
|
|
"label": "tags",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 58,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L58"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.alertTypeId",
|
|
"type": "string",
|
|
"label": "alertTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 59,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L59"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.consumer",
|
|
"type": "string",
|
|
"label": "consumer",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 60,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L60"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.schedule",
|
|
"type": "Object",
|
|
"label": "schedule",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 61,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L61"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.IntervalSchedule",
|
|
"text": "IntervalSchedule"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.actions",
|
|
"type": "Array",
|
|
"label": "actions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 62,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L62"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertAction",
|
|
"text": "AlertAction"
|
|
},
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.params",
|
|
"type": "Uncategorized",
|
|
"label": "params",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 63,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L63"
|
|
},
|
|
"signature": [
|
|
"Params"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.scheduledTaskId",
|
|
"type": "string",
|
|
"label": "scheduledTaskId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 64,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L64"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.createdBy",
|
|
"type": "CompoundType",
|
|
"label": "createdBy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 65,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L65"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.updatedBy",
|
|
"type": "CompoundType",
|
|
"label": "updatedBy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 66,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L66"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.createdAt",
|
|
"type": "Object",
|
|
"label": "createdAt",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 67,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L67"
|
|
},
|
|
"signature": [
|
|
"Date"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.updatedAt",
|
|
"type": "Object",
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 68,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L68"
|
|
},
|
|
"signature": [
|
|
"Date"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.apiKey",
|
|
"type": "CompoundType",
|
|
"label": "apiKey",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 69,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L69"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.apiKeyOwner",
|
|
"type": "CompoundType",
|
|
"label": "apiKeyOwner",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 70,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L70"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.throttle",
|
|
"type": "CompoundType",
|
|
"label": "throttle",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 71,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L71"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.notifyWhen",
|
|
"type": "CompoundType",
|
|
"label": "notifyWhen",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 72,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L72"
|
|
},
|
|
"signature": [
|
|
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.muteAll",
|
|
"type": "boolean",
|
|
"label": "muteAll",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 73,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L73"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.mutedInstanceIds",
|
|
"type": "Array",
|
|
"label": "mutedInstanceIds",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 74,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L74"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.Alert.executionStatus",
|
|
"type": "Object",
|
|
"label": "executionStatus",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 75,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L75"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertExecutionStatus",
|
|
"text": "AlertExecutionStatus"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 54,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L54"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertsHealth",
|
|
"type": "Interface",
|
|
"label": "AlertsHealth",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertsHealth.decryptionHealth",
|
|
"type": "Object",
|
|
"label": "decryptionHealth",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 87,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L87"
|
|
},
|
|
"signature": [
|
|
"{ status: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.HealthStatus",
|
|
"text": "HealthStatus"
|
|
},
|
|
"; timestamp: string; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertsHealth.executionHealth",
|
|
"type": "Object",
|
|
"label": "executionHealth",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 91,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L91"
|
|
},
|
|
"signature": [
|
|
"{ status: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.HealthStatus",
|
|
"text": "HealthStatus"
|
|
},
|
|
"; timestamp: string; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertsHealth.readHealth",
|
|
"type": "Object",
|
|
"label": "readHealth",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 95,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L95"
|
|
},
|
|
"signature": [
|
|
"{ status: ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.HealthStatus",
|
|
"text": "HealthStatus"
|
|
},
|
|
"; timestamp: string; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 86,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L86"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertType",
|
|
"type": "Interface",
|
|
"label": "AlertType",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertType",
|
|
"text": "AlertType"
|
|
},
|
|
"<ActionGroupIds, RecoveryActionGroupId>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L15"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L16"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.actionGroups",
|
|
"type": "Array",
|
|
"label": "actionGroups",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L17"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.recoveryActionGroup",
|
|
"type": "Object",
|
|
"label": "recoveryActionGroup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L18"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.actionVariables",
|
|
"type": "Array",
|
|
"label": "actionVariables",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L19"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.defaultActionGroupId",
|
|
"type": "Uncategorized",
|
|
"label": "defaultActionGroupId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L20"
|
|
},
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.producer",
|
|
"type": "string",
|
|
"label": "producer",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L21"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L22"
|
|
},
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.ActionGroup",
|
|
"type": "Interface",
|
|
"label": "ActionGroup",
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionGroup.id",
|
|
"type": "Uncategorized",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L26"
|
|
},
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionGroup.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L27"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L25"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertUrlNavigation",
|
|
"type": "Interface",
|
|
"label": "AlertUrlNavigation",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertUrlNavigation.path",
|
|
"type": "string",
|
|
"label": "path",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_navigation.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_navigation.ts#L11"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_navigation.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_navigation.ts#L10"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertStateNavigation",
|
|
"type": "Interface",
|
|
"label": "AlertStateNavigation",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertStateNavigation.state",
|
|
"type": "Object",
|
|
"label": "state",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_navigation.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_navigation.ts#L14"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.JsonObject",
|
|
"text": "JsonObject"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_navigation.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_navigation.ts#L13"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertInstanceSummary",
|
|
"type": "Interface",
|
|
"label": "AlertInstanceSummary",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L12"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L13"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.tags",
|
|
"type": "Array",
|
|
"label": "tags",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L14"
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.alertTypeId",
|
|
"type": "string",
|
|
"label": "alertTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L15"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.consumer",
|
|
"type": "string",
|
|
"label": "consumer",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L16"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.muteAll",
|
|
"type": "boolean",
|
|
"label": "muteAll",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L17"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.throttle",
|
|
"type": "CompoundType",
|
|
"label": "throttle",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L18"
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.enabled",
|
|
"type": "boolean",
|
|
"label": "enabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L19"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.statusStartDate",
|
|
"type": "string",
|
|
"label": "statusStartDate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L20"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.statusEndDate",
|
|
"type": "string",
|
|
"label": "statusEndDate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L21"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.status",
|
|
"type": "CompoundType",
|
|
"label": "status",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L22"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertStatusValues",
|
|
"text": "AlertStatusValues"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.lastRun",
|
|
"type": "string",
|
|
"label": "lastRun",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L23"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.errorMessages",
|
|
"type": "Array",
|
|
"label": "errorMessages",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L24"
|
|
},
|
|
"signature": [
|
|
"{ date: string; message: string; }[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceSummary.instances",
|
|
"type": "Object",
|
|
"label": "instances",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L25"
|
|
},
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertInstanceStatus",
|
|
"text": "AlertInstanceStatus"
|
|
},
|
|
">"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertInstanceStatus",
|
|
"type": "Interface",
|
|
"label": "AlertInstanceStatus",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceStatus.status",
|
|
"type": "CompoundType",
|
|
"label": "status",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L29"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertInstanceStatusValues",
|
|
"text": "AlertInstanceStatusValues"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceStatus.muted",
|
|
"type": "boolean",
|
|
"label": "muted",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L30"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceStatus.actionGroupId",
|
|
"type": "string",
|
|
"label": "actionGroupId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L31"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceStatus.actionSubgroup",
|
|
"type": "string",
|
|
"label": "actionSubgroup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L32"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertInstanceStatus.activeStartDate",
|
|
"type": "string",
|
|
"label": "activeStartDate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L33"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L28"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"id": "def-common.AlertExecutionStatusErrorReasons",
|
|
"type": "Enum",
|
|
"label": "AlertExecutionStatusErrorReasons",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L23"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.HealthStatus",
|
|
"type": "Enum",
|
|
"label": "HealthStatus",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 80,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L80"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BASE_ALERT_API_PATH",
|
|
"type": "string",
|
|
"label": "BASE_ALERT_API_PATH",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/index.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/index.ts#L27"
|
|
},
|
|
"signature": [
|
|
"\"/api/alerts\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ALERTS_FEATURE_ID",
|
|
"type": "string",
|
|
"label": "ALERTS_FEATURE_ID",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/index.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/index.ts#L28"
|
|
},
|
|
"signature": [
|
|
"\"alerts\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertTypeState",
|
|
"type": "Type",
|
|
"label": "AlertTypeState",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L11"
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.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
|
|
},
|
|
{
|
|
"id": "def-common.AlertExecutionStatuses",
|
|
"type": "Type",
|
|
"label": "AlertExecutionStatuses",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L21"
|
|
},
|
|
"signature": [
|
|
"\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertActionParams",
|
|
"type": "Type",
|
|
"label": "AlertActionParams",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L40"
|
|
},
|
|
"signature": [
|
|
"SavedObjectAttributes"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertActionParam",
|
|
"type": "Type",
|
|
"label": "AlertActionParam",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L41"
|
|
},
|
|
"signature": [
|
|
"undefined | null | string | number | false | true | ",
|
|
"SavedObjectAttributes",
|
|
" | ",
|
|
"SavedObjectAttributeSingle",
|
|
"[]"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.SanitizedAlert",
|
|
"type": "Type",
|
|
"label": "SanitizedAlert",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 78,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L78"
|
|
},
|
|
"signature": [
|
|
"{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; muteAll: boolean; tags: string[]; alertTypeId: string; consumer: string; schedule: 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: AlertExecutionStatus; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.ActionGroupIdsOf",
|
|
"type": "Type",
|
|
"label": "ActionGroupIdsOf",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_type.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_type.ts#L30"
|
|
},
|
|
"signature": [
|
|
"T extends ActionGroup<infer groups> ? groups : T extends Readonly<ActionGroup<infer groups>> ? groups : never"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertInstanceMeta",
|
|
"type": "Type",
|
|
"label": "AlertInstanceMeta",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance.ts#L22"
|
|
},
|
|
"signature": [
|
|
"{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertInstanceState",
|
|
"type": "Type",
|
|
"label": "AlertInstanceState",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance.ts#L25"
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertInstanceContext",
|
|
"type": "Type",
|
|
"label": "AlertInstanceContext",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance.ts#L28"
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.RawAlertInstance",
|
|
"type": "Type",
|
|
"label": "RawAlertInstance",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance.ts#L34"
|
|
},
|
|
"signature": [
|
|
"{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertTaskState",
|
|
"type": "Type",
|
|
"label": "AlertTaskState",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_task_instance.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_task_instance.ts#L18"
|
|
},
|
|
"signature": [
|
|
"{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertTaskParams",
|
|
"type": "Type",
|
|
"label": "AlertTaskParams",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_task_instance.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_task_instance.ts#L28"
|
|
},
|
|
"signature": [
|
|
"{ alertId: string; } & { spaceId?: string | undefined; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertNavigation",
|
|
"type": "Type",
|
|
"label": "AlertNavigation",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_navigation.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_navigation.ts#L16"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertUrlNavigation",
|
|
"text": "AlertUrlNavigation"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.AlertStateNavigation",
|
|
"text": "AlertStateNavigation"
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertStatusValues",
|
|
"type": "Type",
|
|
"label": "AlertStatusValues",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 8,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L8"
|
|
},
|
|
"signature": [
|
|
"\"OK\" | \"Active\" | \"Error\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertInstanceStatusValues",
|
|
"type": "Type",
|
|
"label": "AlertInstanceStatusValues",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance_summary.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance_summary.ts#L9"
|
|
},
|
|
"signature": [
|
|
"\"OK\" | \"Active\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.DefaultActionGroupId",
|
|
"type": "Type",
|
|
"label": "DefaultActionGroupId",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/builtin_action_groups.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/builtin_action_groups.ts#L11"
|
|
},
|
|
"signature": [
|
|
"\"default\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.RecoveredActionGroupId",
|
|
"type": "Type",
|
|
"label": "RecoveredActionGroupId",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/builtin_action_groups.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/builtin_action_groups.ts#L13"
|
|
},
|
|
"signature": [
|
|
"\"recovered\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.ReservedActionGroups",
|
|
"type": "Type",
|
|
"label": "ReservedActionGroups",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/builtin_action_groups.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/builtin_action_groups.ts#L21"
|
|
},
|
|
"signature": [
|
|
"RecoveryActionGroupId | \"recovered\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.WithoutReservedActionGroups",
|
|
"type": "Type",
|
|
"label": "WithoutReservedActionGroups",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/builtin_action_groups.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/builtin_action_groups.ts#L25"
|
|
},
|
|
"signature": [
|
|
"ActionGroupIds extends ReservedActionGroups<RecoveryActionGroupId> ? never : ActionGroupIds"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.AlertNotifyWhenType",
|
|
"type": "Type",
|
|
"label": "AlertNotifyWhenType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_notify_when_type.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_notify_when_type.ts#L13"
|
|
},
|
|
"signature": [
|
|
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AlertExecutionStatusValues",
|
|
"type": "Object",
|
|
"label": "AlertExecutionStatusValues",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert.ts#L20"
|
|
},
|
|
"signature": [
|
|
"readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.rawAlertInstance",
|
|
"type": "Object",
|
|
"label": "rawAlertInstance",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_instance.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_instance.ts#L30"
|
|
},
|
|
"signature": [
|
|
"PartialC",
|
|
"<{ state: ",
|
|
"RecordC",
|
|
"<",
|
|
"StringC",
|
|
", ",
|
|
"UnknownC",
|
|
">; meta: ",
|
|
"PartialC"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.alertStateSchema",
|
|
"type": "Object",
|
|
"label": "alertStateSchema",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_task_instance.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_task_instance.ts#L12"
|
|
},
|
|
"signature": [
|
|
"PartialC",
|
|
"<{ alertTypeState: ",
|
|
"RecordC",
|
|
"<",
|
|
"StringC",
|
|
", ",
|
|
"UnknownC",
|
|
">; alertInstances: ",
|
|
"RecordC"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.alertParamsSchema",
|
|
"type": "Object",
|
|
"label": "alertParamsSchema",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/alert_task_instance.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/alert_task_instance.ts#L20"
|
|
},
|
|
"signature": [
|
|
"IntersectionC",
|
|
"<[",
|
|
"TypeC",
|
|
"<{ alertId: ",
|
|
"StringC",
|
|
"; }>, ",
|
|
"PartialC",
|
|
"<{ spaceId: ",
|
|
"StringC"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.RecoveredActionGroup",
|
|
"type": "Object",
|
|
"label": "RecoveredActionGroup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/builtin_action_groups.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/builtin_action_groups.ts#L14"
|
|
},
|
|
"signature": [
|
|
"Readonly<",
|
|
{
|
|
"pluginId": "alerts",
|
|
"scope": "common",
|
|
"docId": "kibAlertsPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<\"recovered\">>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.DisabledActionTypeIdsForActionGroup",
|
|
"type": "Object",
|
|
"label": "DisabledActionTypeIdsForActionGroup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/alerts/common/disabled_action_groups.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/alerts/common/disabled_action_groups.ts#L14"
|
|
},
|
|
"signature": [
|
|
"Map<string, string[]>"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |