mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
14783 lines
No EOL
548 KiB
JSON
14783 lines
No EOL
548 KiB
JSON
{
|
|
"id": "alerting",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.AlertNavigationHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AlertNavigationHandler",
|
|
"description": [
|
|
"\nReturns information that can be used to navigate to a specific page to view the given rule.\n"
|
|
],
|
|
"signature": [
|
|
"(rule: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<never>) => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [
|
|
"A URL that is meant to be relative to your application id, or a state object that your application uses to render\nthe rule. This information is intended to be used with cores NavigateToApp function, along with the application id that was\noriginally registered to {@link PluginSetupContract.registerNavigation }."
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.AlertNavigationHandler.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rule",
|
|
"description": [
|
|
"The rule to view"
|
|
],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<never>, \"actions\" | \"apiKey\"> & { actions: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRuleAction",
|
|
"text": "SanitizedRuleAction"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginSetupContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract.registerNavigation",
|
|
"type": "Function",
|
|
"tags": [
|
|
"throws",
|
|
"deprecated"
|
|
],
|
|
"label": "registerNavigation",
|
|
"description": [
|
|
"\nRegister a customized view of the particular rule type. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule details view in Stack Management.\n"
|
|
],
|
|
"signature": [
|
|
"(applicationId: string, ruleType: string, handler: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "public",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-public.AlertNavigationHandler",
|
|
"text": "AlertNavigationHandler"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "ml",
|
|
"path": "x-pack/plugins/ml/public/alerting/register_ml_alerts.ts"
|
|
},
|
|
{
|
|
"plugin": "stackAlerts",
|
|
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
|
},
|
|
{
|
|
"plugin": "stackAlerts",
|
|
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
|
},
|
|
{
|
|
"plugin": "stackAlerts",
|
|
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
|
},
|
|
{
|
|
"plugin": "stackAlerts",
|
|
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
|
},
|
|
{
|
|
"plugin": "stackAlerts",
|
|
"path": "x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract.registerNavigation.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "applicationId",
|
|
"description": [
|
|
"The application id that the user should be navigated to, to view a particular rule in a custom way."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract.registerNavigation.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ruleType",
|
|
"description": [
|
|
"The rule type that has been registered with Alerting.Server.PluginSetupContract.registerType. If\nno such rule with that id exists, a warning is output to the console log. It used to throw an error, but that was temporarily moved\nbecause it was causing flaky test failures with https://github.com/elastic/kibana/issues/59229 and needs to be\ninvestigated more."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract.registerNavigation.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "public",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-public.AlertNavigationHandler",
|
|
"text": "AlertNavigationHandler"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract.registerDefaultNavigation",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "registerDefaultNavigation",
|
|
"description": [
|
|
"\nRegister a customized view for all rule types with this application id. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule details view in Stack Management.\n"
|
|
],
|
|
"signature": [
|
|
"(applicationId: string, handler: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "public",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-public.AlertNavigationHandler",
|
|
"text": "AlertNavigationHandler"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract.registerDefaultNavigation.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "applicationId",
|
|
"description": [
|
|
"The application id that the user should be navigated to, to view a particular rule in a custom way."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginSetupContract.registerDefaultNavigation.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "public",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-public.AlertNavigationHandler",
|
|
"text": "AlertNavigationHandler"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginStartContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginStartContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginStartContract.getNavigation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getNavigation",
|
|
"description": [],
|
|
"signature": [
|
|
"(ruleId: string) => Promise<string | undefined>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginStartContract.getNavigation.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ruleId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-public.PluginStartContract.getMaxAlertsPerRun",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getMaxAlertsPerRun",
|
|
"description": [],
|
|
"signature": [
|
|
"() => number"
|
|
],
|
|
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "AlertingAuthorization",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n getSpace,\n getSpaceId,\n }",
|
|
"description": [],
|
|
"signature": [
|
|
"ConstructorOptions"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getSpaceId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceId",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAugmentedRuleTypesWithAuthorization",
|
|
"description": [],
|
|
"signature": [
|
|
"(featureIds: readonly string[], operations: (",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ReadOperations",
|
|
"text": "ReadOperations"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.WriteOperations",
|
|
"text": "WriteOperations"
|
|
},
|
|
")[], authorizationEntity: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
},
|
|
") => Promise<{ username?: string | undefined; hasAllRequested: boolean; authorizedRuleTypes: Set<",
|
|
"RegistryAlertTypeWithAuth",
|
|
">; }>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featureIds",
|
|
"description": [],
|
|
"signature": [
|
|
"readonly string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "operations",
|
|
"description": [],
|
|
"signature": [
|
|
"(",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ReadOperations",
|
|
"text": "ReadOperations"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.WriteOperations",
|
|
"text": "WriteOperations"
|
|
},
|
|
")[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization.$3",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "authorizationEntity",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.ensureAuthorized",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "ensureAuthorized",
|
|
"description": [],
|
|
"signature": [
|
|
"({ ruleTypeId, consumer: legacyConsumer, operation, entity, additionalPrivileges, }: ",
|
|
"EnsureAuthorizedOpts",
|
|
") => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.ensureAuthorized.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n ruleTypeId,\n consumer: legacyConsumer,\n operation,\n entity,\n additionalPrivileges = [],\n }",
|
|
"description": [],
|
|
"signature": [
|
|
"EnsureAuthorizedOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getFindAuthorizationFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFindAuthorizationFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"(authorizationEntity: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
},
|
|
", filterOpts: ",
|
|
"AlertingAuthorizationFilterOpts",
|
|
", featuresIds?: Set<string> | undefined) => Promise<{ filter?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.KueryNode",
|
|
"text": "KueryNode"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.JsonObject",
|
|
"text": "JsonObject"
|
|
},
|
|
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getFindAuthorizationFilter.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "authorizationEntity",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getFindAuthorizationFilter.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "filterOpts",
|
|
"description": [],
|
|
"signature": [
|
|
"AlertingAuthorizationFilterOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getFindAuthorizationFilter.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featuresIds",
|
|
"description": [],
|
|
"signature": [
|
|
"Set<string> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizedRuleTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAuthorizedRuleTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"(authorizationEntity: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
},
|
|
", featuresIds?: Set<string> | undefined) => Promise<",
|
|
"RegistryAlertTypeWithAuth",
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizedRuleTypes.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "authorizationEntity",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizedRuleTypes.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featuresIds",
|
|
"description": [],
|
|
"signature": [
|
|
"Set<string> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizationFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAuthorizationFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"(authorizationEntity: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
},
|
|
", filterOpts: ",
|
|
"AlertingAuthorizationFilterOpts",
|
|
", operation: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ReadOperations",
|
|
"text": "ReadOperations"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.WriteOperations",
|
|
"text": "WriteOperations"
|
|
},
|
|
", featuresIds?: Set<string> | undefined) => Promise<{ filter?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.KueryNode",
|
|
"text": "KueryNode"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.JsonObject",
|
|
"text": "JsonObject"
|
|
},
|
|
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizationFilter.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "authorizationEntity",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizationFilter.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "filterOpts",
|
|
"description": [],
|
|
"signature": [
|
|
"AlertingAuthorizationFilterOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizationFilter.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "operation",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ReadOperations",
|
|
"text": "ReadOperations"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.WriteOperations",
|
|
"text": "WriteOperations"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.getAuthorizationFilter.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featuresIds",
|
|
"description": [],
|
|
"signature": [
|
|
"Set<string> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "filterByRuleTypeAuthorization",
|
|
"description": [],
|
|
"signature": [
|
|
"(ruleTypes: Set<",
|
|
"RegistryRuleType",
|
|
">, operations: (",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ReadOperations",
|
|
"text": "ReadOperations"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.WriteOperations",
|
|
"text": "WriteOperations"
|
|
},
|
|
")[], authorizationEntity: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
},
|
|
") => Promise<Set<",
|
|
"RegistryAlertTypeWithAuth",
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ruleTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"Set<",
|
|
"RegistryRuleType",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "operations",
|
|
"description": [],
|
|
"signature": [
|
|
"(",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ReadOperations",
|
|
"text": "ReadOperations"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.WriteOperations",
|
|
"text": "WriteOperations"
|
|
},
|
|
")[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization.$3",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "authorizationEntity",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorizationEntity",
|
|
"text": "AlertingAuthorizationEntity"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertsClientError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "AlertsClientError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertsClientError",
|
|
"text": "AlertsClientError"
|
|
},
|
|
" extends Error"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client_error.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertsClientError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client_error.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.InstallShutdownError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "InstallShutdownError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.InstallShutdownError",
|
|
"text": "InstallShutdownError"
|
|
},
|
|
" extends Error"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.InstallShutdownError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createConcreteWriteIndex",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createConcreteWriteIndex",
|
|
"description": [
|
|
"\nInstalls index template that uses installed component template\nPrior to installation, simulates the installation to check for possible\nconflicts. Simulate should return an empty mapping if a template\nconflicts with an already installed template."
|
|
],
|
|
"signature": [
|
|
"(opts: ",
|
|
"CreateConcreteWriteIndexOpts",
|
|
") => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_concrete_write_index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createConcreteWriteIndex.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"signature": [
|
|
"CreateConcreteWriteIndexOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_concrete_write_index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createOrUpdateComponentTemplate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createOrUpdateComponentTemplate",
|
|
"description": [],
|
|
"signature": [
|
|
"({ logger, esClient, template, totalFieldsLimit, }: CreateOrUpdateComponentTemplateOpts) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_component_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createOrUpdateComponentTemplate.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n logger,\n esClient,\n template,\n totalFieldsLimit,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"CreateOrUpdateComponentTemplateOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_component_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createOrUpdateIlmPolicy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createOrUpdateIlmPolicy",
|
|
"description": [
|
|
"\nCreates ILM policy if it doesn't already exist, updates it if it does"
|
|
],
|
|
"signature": [
|
|
"({ logger, esClient, name, policy, dataStreamAdapter, }: CreateOrUpdateIlmPolicyOpts) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_ilm_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createOrUpdateIlmPolicy.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n logger,\n esClient,\n name,\n policy,\n dataStreamAdapter,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"CreateOrUpdateIlmPolicyOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_ilm_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createOrUpdateIndexTemplate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createOrUpdateIndexTemplate",
|
|
"description": [
|
|
"\nInstalls index template that uses installed component template\nPrior to installation, simulates the installation to check for possible\nconflicts. Simulate should return an empty mapping if a template\nconflicts with an already installed template."
|
|
],
|
|
"signature": [
|
|
"({ logger, esClient, template, }: CreateOrUpdateIndexTemplateOpts) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.createOrUpdateIndexTemplate.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n logger,\n esClient,\n template,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"CreateOrUpdateIndexTemplateOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getComponentTemplate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getComponentTemplate",
|
|
"description": [],
|
|
"signature": [
|
|
"({ fieldMap, context, name, dynamic, includeSettings, }: GetComponentTemplateOpts) => ",
|
|
"ClusterPutComponentTemplateRequest"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/resource_installer_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getComponentTemplate.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n fieldMap,\n context,\n name,\n dynamic,\n includeSettings,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"GetComponentTemplateOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/resource_installer_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getDataStreamAdapter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDataStreamAdapter",
|
|
"description": [],
|
|
"signature": [
|
|
"(opts: ",
|
|
"GetDataStreamAdapterOpts",
|
|
") => ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.DataStreamAdapter",
|
|
"text": "DataStreamAdapter"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getDataStreamAdapter.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"signature": [
|
|
"GetDataStreamAdapterOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getEsErrorMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEsErrorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: ",
|
|
"ElasticsearchError",
|
|
") => string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getEsErrorMessage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"ElasticsearchError"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getIndexTemplate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIndexTemplate",
|
|
"description": [],
|
|
"signature": [
|
|
"({ componentTemplateRefs, ilmPolicyName, indexPatterns, kibanaVersion, namespace, totalFieldsLimit, dataStreamAdapter, }: GetIndexTemplateOpts) => ",
|
|
"IndicesPutIndexTemplateRequest"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.getIndexTemplate.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n componentTemplateRefs,\n ilmPolicyName,\n indexPatterns,\n kibanaVersion,\n namespace,\n totalFieldsLimit,\n dataStreamAdapter,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"GetIndexTemplateOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.installWithTimeout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "installWithTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"({ description, installFn, pluginStop$, logger, timeoutMs, }: InstallWithTimeoutOpts) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.installWithTimeout.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n description,\n installFn,\n pluginStop$,\n logger,\n timeoutMs = INSTALLATION_TIMEOUT,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"InstallWithTimeoutOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.isRuleSnoozed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isRuleSnoozed",
|
|
"description": [],
|
|
"signature": [
|
|
"(rule: RuleSnoozeProps) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.isRuleSnoozed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "rule",
|
|
"description": [],
|
|
"signature": [
|
|
"RuleSnoozeProps"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.isValidAlertIndexName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isValidAlertIndexName",
|
|
"description": [],
|
|
"signature": [
|
|
"(indexName: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/is_valid_alert_index_name.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.isValidAlertIndexName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "indexName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/is_valid_alert_index_name.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.parseDuration",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "parseDuration",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: string) => number"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.parseDuration.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.sanitizeBulkErrorResponse",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "sanitizeBulkErrorResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"(response: ",
|
|
"BulkResponse",
|
|
" | ",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>) => ",
|
|
"BulkResponse",
|
|
" | ",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_client/lib/sanitize_bulk_response.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.sanitizeBulkErrorResponse.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"BulkResponse",
|
|
" | ",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_client/lib/sanitize_bulk_response.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ActionGroup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionGroup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ActionGroup.id",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ActionGroup.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ActionGroup.severity",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "severity",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroupSeverity",
|
|
"text": "ActionGroupSeverity"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingApiRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertingApiRequestHandlerContext",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingApiRequestHandlerContext.getRulesClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRulesClient",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RulesClient",
|
|
"text": "RulesClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingApiRequestHandlerContext.getRulesSettingsClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRulesSettingsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"RulesSettingsClient"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingApiRequestHandlerContext.getMaintenanceWindowClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getMaintenanceWindowClient",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"MaintenanceWindowClient"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingApiRequestHandlerContext.listTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "listTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Set<",
|
|
"RegistryRuleType",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingApiRequestHandlerContext.getFrameworkHealth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFrameworkHealth",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsHealth",
|
|
"text": "AlertsHealth"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingApiRequestHandlerContext.areApiKeysEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "areApiKeysEnabled",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingPlugin",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertingPlugin",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingPlugin.setup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingPlugin.start",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.PluginStartContract",
|
|
"text": "PluginStartContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.BulkOperationError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkOperationError",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/rules_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.BulkOperationError.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/rules_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.BulkOperationError.status",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/rules_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.BulkOperationError.rule",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "rule",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; name: string; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/rules_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ConnectorAdapter",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ConnectorAdapter",
|
|
"text": "ConnectorAdapter"
|
|
},
|
|
"<RuleActionParams, ConnectorParams>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.connectorTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "connectorTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.ruleActionParamsSchema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ruleActionParamsSchema",
|
|
"description": [
|
|
"\nThe schema of the action persisted\nin the rule. The schema will be validated\nwhen a rule is created or updated.\nThe schema should be backwards compatible\nand should never introduce any breaking\nchanges."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<any>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.buildActionParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "buildActionParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(args: BuildActionParamsArgs<RuleActionParams>) => ConnectorParams"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.buildActionParams.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"BuildActionParamsArgs<RuleActionParams>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.getKibanaPrivileges",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getKibanaPrivileges",
|
|
"description": [],
|
|
"signature": [
|
|
"((args: { consumer: string; producer: string; }) => string[]) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.getKibanaPrivileges.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.getKibanaPrivileges.$1.consumer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "consumer",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ConnectorAdapter.getKibanaPrivileges.$1.producer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "producer",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/connector_adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DataStreamAdapter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DataStreamAdapter",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DataStreamAdapter.isUsingDataStreams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isUsingDataStreams",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DataStreamAdapter.getIndexTemplateFields",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIndexTemplateFields",
|
|
"description": [],
|
|
"signature": [
|
|
"(alias: string, pattern: string) => ",
|
|
"IndexTemplateFields"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DataStreamAdapter.getIndexTemplateFields.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "alias",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DataStreamAdapter.getIndexTemplateFields.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pattern",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DataStreamAdapter.createStream",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createStream",
|
|
"description": [],
|
|
"signature": [
|
|
"(opts: ",
|
|
"CreateConcreteWriteIndexOpts",
|
|
") => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DataStreamAdapter.createStream.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"signature": [
|
|
"CreateConcreteWriteIndexOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.FindResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FindResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.FindResult",
|
|
"text": "FindResult"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.FindResult.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.FindResult.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.FindResult.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.FindResult.data",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<Params>[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/methods/find/find_rules.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.GetViewInAppRelativeUrlFnOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetViewInAppRelativeUrlFnOpts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.GetViewInAppRelativeUrlFnOpts",
|
|
"text": "GetViewInAppRelativeUrlFnOpts"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.GetViewInAppRelativeUrlFnOpts.rule",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rule",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<Params>, \"id\"> & Omit<Partial<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<Params>>, \"viewInAppRelativeUrl\">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.GetViewInAppRelativeUrlFnOpts.start",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.GetViewInAppRelativeUrlFnOpts.end",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "end",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IRuleTypeAlerts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.IRuleTypeAlerts",
|
|
"text": "IRuleTypeAlerts"
|
|
},
|
|
"<AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.context",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [
|
|
"\nSpecifies the target alerts-as-data resource\nfor this rule type. All alerts created with the same\ncontext are written to the same alerts-as-data index.\n\nAll custom mappings defined for a context must be the same!"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.mappings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mappings",
|
|
"description": [
|
|
"\nSpecifies custom mappings for the target alerts-as-data\nindex. These mappings will be translated into a component template\nand used in the index template for the index."
|
|
],
|
|
"signature": [
|
|
"ComponentTemplateSpec"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.shouldWrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "shouldWrite",
|
|
"description": [
|
|
"\nOptional flag to opt into writing alerts as data. When not specified\ndefaults to false. We need this because we needed all previous rule\nregistry rules to register with the framework in order to install\nElasticsearch assets but we don't want to migrate them to using\nthe framework for writing alerts as data until all the pieces are ready"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.useEcs",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useEcs",
|
|
"description": [
|
|
"\nOptional flag to include a reference to the ECS component template."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.useLegacyAlerts",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useLegacyAlerts",
|
|
"description": [
|
|
"\nOptional flag to include a reference to the legacy alert component template.\nAny rule type that is migrating from the rule registry should set this\nflag to true to ensure their alerts-as-data indices are backwards compatible."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.isSpaceAware",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isSpaceAware",
|
|
"description": [
|
|
"\nOptional flag to indicate that resources should be space-aware. When set to\ntrue, alerts-as-data resources will be created for every space where a rule\nof this type runs."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.secondaryAlias",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "secondaryAlias",
|
|
"description": [
|
|
"\nOptional secondary alias to use. This alias should not include the namespace."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.IRuleTypeAlerts.formatAlert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "formatAlert",
|
|
"description": [
|
|
"\nOptional function to format each alert in summarizedAlerts right after fetching them."
|
|
],
|
|
"signature": [
|
|
"FormatAlert",
|
|
"<AlertData> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginSetupContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.registerConnectorAdapter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerConnectorAdapter",
|
|
"description": [],
|
|
"signature": [
|
|
"<RuleActionParams extends ",
|
|
"ConnectorAdapterParams",
|
|
" = ",
|
|
"ConnectorAdapterParams",
|
|
", ConnectorParams extends ",
|
|
"ConnectorAdapterParams",
|
|
" = ",
|
|
"ConnectorAdapterParams",
|
|
">(adapter: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ConnectorAdapter",
|
|
"text": "ConnectorAdapter"
|
|
},
|
|
"<RuleActionParams, ConnectorParams>) => void"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.registerConnectorAdapter.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "adapter",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.ConnectorAdapter",
|
|
"text": "ConnectorAdapter"
|
|
},
|
|
"<RuleActionParams, ConnectorParams>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.registerType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerType",
|
|
"description": [],
|
|
"signature": [
|
|
"<Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
", ExtractedParams extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
", State extends ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleTypeState",
|
|
"text": "RuleTypeState"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleTypeState",
|
|
"text": "RuleTypeState"
|
|
},
|
|
", InstanceState extends Record<string, any> = Record<string, any>, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = never, RecoveryActionGroupId extends string = never, AlertData extends ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleAlertData",
|
|
"text": "RuleAlertData"
|
|
},
|
|
" = never>(ruleType: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleType",
|
|
"text": "RuleType"
|
|
},
|
|
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId, AlertData>) => void"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.registerType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ruleType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleType",
|
|
"text": "RuleType"
|
|
},
|
|
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.getSecurityHealth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSecurityHealth",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"SecurityHealth",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingRulesConfig",
|
|
"text": "AlertingRulesConfig"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.frameworkAlerts",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "frameworkAlerts",
|
|
"description": [],
|
|
"signature": [
|
|
"PublicAlertsService",
|
|
" & { enabled: () => boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginSetupContract.getDataStreamAdapter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDataStreamAdapter",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.DataStreamAdapter",
|
|
"text": "DataStreamAdapter"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginStartContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.listTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "listTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Set<",
|
|
"RegistryRuleType",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getAllTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getType",
|
|
"description": [],
|
|
"signature": [
|
|
"<Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
", ExtractedParams extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
", State extends ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleTypeState",
|
|
"text": "RuleTypeState"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleTypeState",
|
|
"text": "RuleTypeState"
|
|
},
|
|
", InstanceState extends Record<string, any> = Record<string, any>, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = string, RecoveryActionGroupId extends string = string, AlertData extends ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleAlertData",
|
|
"text": "RuleAlertData"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleAlertData",
|
|
"text": "RuleAlertData"
|
|
},
|
|
">(id: string) => ",
|
|
"NormalizedRuleType",
|
|
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/rule_type_registry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getAlertIndicesAlias",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAlertIndicesAlias",
|
|
"description": [],
|
|
"signature": [
|
|
"(rulesTypes: string[], spaceId?: string | undefined) => string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getAlertIndicesAlias.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "rulesTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/lib/create_get_alert_indices_alias.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getAlertIndicesAlias.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/lib/create_get_alert_indices_alias.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getRulesClientWithRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRulesClientWithRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
"RulesClientApi"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getRulesClientWithRequest.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAlertingAuthorizationWithRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.PublicMethodsOf",
|
|
"text": "PublicMethodsOf"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorization",
|
|
"text": "AlertingAuthorization"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PluginStartContract.getFrameworkHealth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFrameworkHealth",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsHealth",
|
|
"text": "AlertsHealth"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Rule",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.tags",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "tags",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.alertTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "alertTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.consumer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "consumer",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.schedule",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schedule",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly interval: string; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.actions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "actions",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ frequency?: Readonly<{} & { throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; summary: boolean; }> | undefined; alertsFilter?: Readonly<{ query?: Readonly<{ dsl?: string | undefined; } & { kql: string; filters: Readonly<{ query?: Record<string, any> | undefined; $state?: Readonly<{} & { store: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.FilterStateStore",
|
|
"text": "FilterStateStore"
|
|
},
|
|
"; }> | undefined; } & { meta: Record<string, any>; }>[]; }> | undefined; timeframe?: Readonly<{} & { days: (2 | 1 | 7 | 6 | 5 | 4 | 3)[]; hours: Readonly<{} & { start: string; end: string; }>; timezone: string; }> | undefined; } & {}> | undefined; uuid?: string | undefined; useAlertDataForTemplate?: boolean | undefined; } & { params: Record<string, any>; id: string; actionTypeId: string; group: string; }>[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.systemActions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "systemActions",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ uuid?: string | undefined; } & { params: Record<string, any>; id: string; actionTypeId: string; }>[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.mapped_params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mapped_params",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.scheduledTaskId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "scheduledTaskId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.createdBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "createdBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.updatedBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "updatedBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.createdAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "createdAt",
|
|
"description": [],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.updatedAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.apiKeyOwner",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "apiKeyOwner",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.apiKeyCreatedByUser",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "apiKeyCreatedByUser",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.throttle",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "throttle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.muteAll",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "muteAll",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.notifyWhen",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "notifyWhen",
|
|
"description": [],
|
|
"signature": [
|
|
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.mutedInstanceIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "mutedInstanceIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.executionStatus",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"RuleExecutionStatus",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.monitoring",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "monitoring",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{} & { run: Readonly<{} & { history: Readonly<{ outcome?: Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"timeout\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | undefined; duration?: number | undefined; } & { timestamp: number; success: boolean; }>[]; calculated_metrics: Readonly<{ p50?: number | undefined; p95?: number | undefined; p99?: number | undefined; } & { success_ratio: number; }>; last_run: Readonly<{} & { timestamp: string; metrics: Readonly<{ duration?: number | undefined; total_search_duration_ms?: number | null | undefined; total_indexing_duration_ms?: number | null | undefined; total_alerts_detected?: number | null | undefined; total_alerts_created?: number | null | undefined; gap_duration_s?: number | null | undefined; } & {}>; }>; }>; }> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.snoozeSchedule",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "snoozeSchedule",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ id?: string | undefined; skipRecurrences?: string[] | undefined; } & { duration: number; rRule: Readonly<{ count?: number | undefined; interval?: number | undefined; freq?: 0 | 2 | 1 | 6 | 5 | 4 | 3 | undefined; until?: string | undefined; byweekday?: (string | number)[] | undefined; bymonthday?: number[] | undefined; bymonth?: number[] | undefined; wkst?: \"MO\" | \"TU\" | \"WE\" | \"TH\" | \"FR\" | \"SA\" | \"SU\" | undefined; bysetpos?: number[] | undefined; byyearday?: number[] | undefined; byweekno?: number[] | undefined; byhour?: number[] | undefined; byminute?: number[] | undefined; bysecond?: number[] | undefined; } & { dtstart: string; tzid: string; }>; }>[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.activeSnoozes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "activeSnoozes",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.isSnoozedUntil",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isSnoozedUntil",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.lastRun",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "lastRun",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ warning?: \"execute\" | \"validate\" | \"unknown\" | \"license\" | \"timeout\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | \"maxQueuedActions\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.nextRun",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "nextRun",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.running",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "running",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.viewInAppRelativeUrl",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "viewInAppRelativeUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.alertDelay",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alertDelay",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{} & { active: number; }> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.Rule.legacyId",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "legacyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleExecutorOptions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleExecutorOptions",
|
|
"text": "RuleExecutorOptions"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.executionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "executionId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "common",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-common.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.previousStartedAt",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "previousStartedAt",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.rule",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rule",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<never>, \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\" | \"revision\" | \"alertDelay\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleExecutorServices",
|
|
"text": "RuleExecutorServices"
|
|
},
|
|
"<InstanceState, InstanceContext, ActionGroupIds, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.spaceId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.startedAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "startedAt",
|
|
"description": [],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.startedAtOverridden",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "startedAtOverridden",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.state",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
"State"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.flappingSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "flappingSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsFlappingProperties",
|
|
"text": "RulesSettingsFlappingProperties"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.maintenanceWindowIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "maintenanceWindowIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.getTimeRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTimeRange",
|
|
"description": [],
|
|
"signature": [
|
|
"(timeWindow?: string | undefined) => ",
|
|
"GetTimeRangeResult"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorOptions.getTimeRange.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeWindow",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleExecutorServices",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleExecutorServices",
|
|
"text": "RuleExecutorServices"
|
|
},
|
|
"<State, Context, ActionGroupIds, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.searchSourceClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSourceClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchStartSearchSource",
|
|
"text": "ISearchStartSearchSource"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.savedObjectsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-api-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
|
|
"section": "def-server.SavedObjectsClientContract",
|
|
"text": "SavedObjectsClientContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.uiSettingsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettingsClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-ui-settings-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreUiSettingsServerPluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.scopedClusterClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "scopedClusterClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-elasticsearch-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreElasticsearchServerPluginApi",
|
|
"section": "def-server.IScopedClusterClient",
|
|
"text": "IScopedClusterClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.alertFactory",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "alertFactory",
|
|
"description": [
|
|
"\nDeprecate alertFactory and remove when all rules are onboarded to\nthe alertsClient"
|
|
],
|
|
"signature": [
|
|
"Pick<",
|
|
"AlertFactory",
|
|
"<State, Context, ActionGroupIds>, \"create\" | \"done\"> & { alertLimit: Pick<{ getValue: () => number; setLimitReached: (reached: boolean) => void; checkLimitUsage: () => void; }, \"getValue\" | \"setLimitReached\">; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "ruleRegistry",
|
|
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts"
|
|
},
|
|
{
|
|
"plugin": "ruleRegistry",
|
|
"path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts"
|
|
},
|
|
{
|
|
"plugin": "ruleRegistry",
|
|
"path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts"
|
|
},
|
|
{
|
|
"plugin": "synthetics",
|
|
"path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/message_utils.ts"
|
|
},
|
|
{
|
|
"plugin": "synthetics",
|
|
"path": "x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/tls_rule.ts"
|
|
},
|
|
{
|
|
"plugin": "ruleRegistry",
|
|
"path": "x-pack/plugins/rule_registry/server/utils/rule_executor.test_helpers.ts"
|
|
},
|
|
{
|
|
"plugin": "slo",
|
|
"path": "x-pack/plugins/observability_solution/slo/server/lib/rules/slo_burn_rate/executor.test.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.alertsClient",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "alertsClient",
|
|
"description": [
|
|
"\nOnly available when framework alerts are enabled and rule\ntype has registered alert context with the framework with shouldWrite set to true"
|
|
],
|
|
"signature": [
|
|
"PublicAlertsClient",
|
|
"<AlertData, State, Context, ActionGroupIds> | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.shouldWriteAlerts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shouldWriteAlerts",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.shouldStopExecution",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shouldStopExecution",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.ruleMonitoringService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ruleMonitoringService",
|
|
"description": [],
|
|
"signature": [
|
|
"PublicMetricsSetters",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.share",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "share",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "server",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-server.SharePublicStart",
|
|
"text": "SharePublicStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.dataViews",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViews",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: (spec: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
", skipFetchFields?: boolean, displayErrors?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
">; get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
">; delete: (indexPatternId: string) => Promise<void>; find: (search: string, size?: number) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[]>; getCanSave: () => Promise<boolean>; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; findLazy: (search: string, size?: number) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
"[]>; getIdsWithTitle: (refresh?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewListItem",
|
|
"text": "DataViewListItem"
|
|
},
|
|
"[]>; getAllDataViewLazy: (refresh?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
"[]>; clearCache: () => void; clearInstanceCache: (id?: string | undefined) => void; getCache: () => Promise<",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSavedObjectAttrs",
|
|
"text": "DataViewSavedObjectAttrs"
|
|
},
|
|
">[] | null | undefined>; getDefault: (displayErrors?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
" | null>; getDefaultId: () => Promise<string | null>; setDefault: (id: string | null, force?: boolean) => Promise<void>; hasUserDataView: () => Promise<boolean>; getMetaFields: () => Promise<string[] | undefined>; getShortDotsEnable: () => Promise<boolean | undefined>; getFieldsForWildcard: (options: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.GetFieldsOptions",
|
|
"text": "GetFieldsOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[]>; getFieldsForIndexPattern: (indexPattern: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
", options?: Omit<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.GetFieldsOptions",
|
|
"text": "GetFieldsOptions"
|
|
},
|
|
", \"allowNoIndex\"> | undefined) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[]>; refreshFields: (dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
", displayErrors?: boolean, forceRefresh?: boolean) => Promise<void>; fieldArrayToMap: (fields: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[], fieldAttrs?: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.FieldAttrs",
|
|
"text": "FieldAttrs"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewFieldMap",
|
|
"text": "DataViewFieldMap"
|
|
},
|
|
"; savedObjectToSpec: (savedObject: ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewAttributes",
|
|
"text": "DataViewAttributes"
|
|
},
|
|
">) => ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
"; getDataViewLazy: (id: string) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
">; createDataViewLazy: (spec: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
">; createAndSaveDataViewLazy: (spec: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
", overwrite?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
">; createAndSave: (spec: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
">; createSavedObject: (dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.AbstractDataView",
|
|
"text": "AbstractDataView"
|
|
},
|
|
", overwrite?: boolean) => Promise<void>; updateSavedObject: (indexPattern: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.AbstractDataView",
|
|
"text": "AbstractDataView"
|
|
},
|
|
", saveAttempts?: number, ignoreErrors?: boolean, displayErrors?: boolean) => Promise<void>; defaultDataViewExists: () => Promise<boolean>; getDefaultDataViewLazy: () => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
" | null>; getDefaultDataView: (options?: { displayErrors?: boolean | undefined; refreshFields?: boolean | undefined; }) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
" | null>; toDataView: (dataViewLazy: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
">; toDataViewLazy: (dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewLazy",
|
|
"text": "DataViewLazy"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleExecutorServices.ruleResultService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ruleResultService",
|
|
"description": [],
|
|
"signature": [
|
|
"PublicLastRunSetters",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleParamsAndRefs",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleParamsAndRefs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleParamsAndRefs",
|
|
"text": "RuleParamsAndRefs"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleParamsAndRefs.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleParamsAndRefs.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleType",
|
|
"text": "RuleType"
|
|
},
|
|
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.validate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [],
|
|
"signature": [
|
|
"{ params: ",
|
|
"RuleTypeParamsValidator",
|
|
"<Params>; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.schemas",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schemas",
|
|
"description": [],
|
|
"signature": [
|
|
"{ params?: { type: \"zod\"; schema: Zod.ZodObject<Zod.ZodRawShape, Zod.UnknownKeysParam, Zod.ZodTypeAny, { [x: string]: any; }, { [x: string]: any; }> | Zod.ZodIntersection<Zod.ZodTypeAny, Zod.ZodTypeAny>; } | { type: \"config-schema\"; schema: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<any>; } | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.actionGroups",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "actionGroups",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.defaultActionGroupId",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultActionGroupId",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.recoveryActionGroup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "recoveryActionGroup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.executor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "executor",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleExecutorOptions",
|
|
"text": "RuleExecutorOptions"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.WithoutReservedActionGroups",
|
|
"text": "WithoutReservedActionGroups"
|
|
},
|
|
"<ActionGroupIds, RecoveryActionGroupId>, AlertData>) => Promise<{ state: State; }>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.executor.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleExecutorOptions",
|
|
"text": "RuleExecutorOptions"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.category",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.producer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "producer",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.actionVariables",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actionVariables",
|
|
"description": [],
|
|
"signature": [
|
|
"{ context?: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[] | undefined; state?: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[] | undefined; params?: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[] | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.useSavedObjectReferences",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "useSavedObjectReferences",
|
|
"description": [],
|
|
"signature": [
|
|
"{ extractReferences: (params: Params) => ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleParamsAndRefs",
|
|
"text": "RuleParamsAndRefs"
|
|
},
|
|
"<ExtractedParams>; injectReferences: (params: ExtractedParams, references: ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
"[]) => Params; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.isExportable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isExportable",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.defaultScheduleInterval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "defaultScheduleInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.ruleTaskTimeout",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ruleTaskTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.cancelAlertsOnRuleTimeout",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "cancelAlertsOnRuleTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.doesSetRecoveryContext",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "doesSetRecoveryContext",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.alerts",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alerts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.IRuleTypeAlerts",
|
|
"text": "IRuleTypeAlerts"
|
|
},
|
|
"<AlertData> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.autoRecoverAlerts",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "autoRecoverAlerts",
|
|
"description": [
|
|
"\nDetermines whether framework should\nautomatically make recovery determination. Defaults to true."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.getViewInAppRelativeUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getViewInAppRelativeUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"GetViewInAppRelativeUrlFn",
|
|
"<Params> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleType.fieldsForAAD",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldsForAAD",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.SummarizedAlertsChunk",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SummarizedAlertsChunk",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.SummarizedAlertsChunk.count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.SummarizedAlertsChunk.data",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"AlertHit",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorizationEntity",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "AlertingAuthorizationEntity",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingAuthorizationFilterType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "AlertingAuthorizationFilterType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization_kuery.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ReadOperations",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "ReadOperations",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleNotifyWhen",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RuleNotifyWhen",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_notify_when_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.WriteOperations",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "WriteOperations",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ActionGroupIdsOf",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionGroupIdsOf",
|
|
"description": [],
|
|
"signature": [
|
|
"T extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<infer groups extends string> ? groups : T extends Readonly<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<infer groups extends string>> ? groups : never"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertingRulesConfig",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AlertingRulesConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Readonly<{ overwriteProducer?: \"siem\" | \"observability\" | \"stackAlerts\" | undefined; } & { minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; maxScheduledPerMinute: number; run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; }>, \"minimumScheduleInterval\" | \"maxScheduledPerMinute\" | \"run\"> & { isUsingSecurity: boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.AlertInstanceContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AlertInstanceContext",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.API_KEY_PENDING_INVALIDATION_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "API_KEY_PENDING_INVALIDATION_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"api_key_pending_invalidation\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/saved_objects/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.BulkEditOperation",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "BulkEditOperation",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{} & { value: string[]; operation: \"delete\" | \"add\" | \"set\"; field: \"tags\"; }> | Readonly<{} & { value: (Readonly<{ actionTypeId?: string | undefined; frequency?: Readonly<{} & { throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; summary: boolean; }> | undefined; alertsFilter?: Readonly<{ query?: Readonly<{ dsl?: string | undefined; } & { kql: string; filters: Readonly<{ query?: Record<string, any> | undefined; $state?: Readonly<{} & { store: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.FilterStateStore",
|
|
"text": "FilterStateStore"
|
|
},
|
|
"; }> | undefined; } & { meta: Record<string, any>; }>[]; }> | undefined; timeframe?: Readonly<{} & { days: (2 | 1 | 7 | 6 | 5 | 4 | 3)[]; hours: Readonly<{} & { start: string; end: string; }>; timezone: string; }> | undefined; } & {}> | undefined; uuid?: string | undefined; useAlertDataForTemplate?: boolean | undefined; } & { params: Record<string, any>; id: string; group: string; }> | Readonly<{ actionTypeId?: string | undefined; uuid?: string | undefined; } & { params: Record<string, any>; id: string; }>)[]; operation: \"add\" | \"set\"; field: \"actions\"; }> | Readonly<{} & { value: Readonly<{} & { interval: string; }>; operation: \"set\"; field: \"schedule\"; }> | Readonly<{} & { value: string | null; operation: \"set\"; field: \"throttle\"; }> | Readonly<{} & { value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; operation: \"set\"; field: \"notifyWhen\"; }> | Readonly<{} & { value: Readonly<{ id?: string | undefined; } & { duration: number; rRule: Readonly<{ count?: number | undefined; interval?: number | undefined; freq?: 0 | 2 | 1 | 3 | undefined; until?: string | undefined; byweekday?: string[] | undefined; bymonthday?: number[] | undefined; bymonth?: number[] | undefined; } & { dtstart: string; tzid: string; }>; }>; operation: \"set\"; field: \"snoozeSchedule\"; }> | Readonly<{ value?: string[] | undefined; } & { operation: \"delete\"; field: \"snoozeSchedule\"; }> | Readonly<{} & { operation: \"set\"; field: \"apiKey\"; }>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/application/rule/methods/bulk_edit/types/bulk_edit_rules_options.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY_NAME",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DEFAULT_ALERTS_ILM_POLICY_NAME",
|
|
"description": [
|
|
"\nDefault alert index ILM policy\n- _meta.managed: notify users this is a managed policy and should be modified\n at their own risk\n- no delete phase as we want to keep these indices around indefinitely\n\nThis should be used by all alerts-as-data indices"
|
|
],
|
|
"signature": [
|
|
"\".alerts-ilm-policy\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT",
|
|
"description": [],
|
|
"signature": [
|
|
"10"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ECS_COMPONENT_TEMPLATE_NAME",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ECS_COMPONENT_TEMPLATE_NAME",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ECS_CONTEXT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ECS_CONTEXT",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ecs\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ExecutorType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExecutorType",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleExecutorOptions",
|
|
"text": "RuleExecutorOptions"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, AlertData>) => Promise<{ state: State; }>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ExecutorType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.RuleExecutorOptions",
|
|
"text": "RuleExecutorOptions"
|
|
},
|
|
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, AlertData>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.LatestAlertInstanceStateSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LatestAlertInstanceStateSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PartialRule",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PartialRule",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<Params>, \"id\"> & Partial<Omit<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<Params>, \"id\">>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PublicAlert",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicAlert",
|
|
"description": [],
|
|
"signature": [
|
|
"{ getContext: () => Context; getState: () => State; getUuid: () => string; getStart: () => string | null; hasContext: () => boolean; replaceState: (state: State) => ",
|
|
"Alert",
|
|
"<State, Context, ActionGroupIds, ",
|
|
{
|
|
"pluginId": "@kbn/alerts-as-data-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
|
|
"section": "def-common.AADAlert",
|
|
"text": "AADAlert"
|
|
},
|
|
">; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ",
|
|
"Alert",
|
|
"<State, Context, ActionGroupIds, ",
|
|
{
|
|
"pluginId": "@kbn/alerts-as-data-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
|
|
"section": "def-common.AADAlert",
|
|
"text": "AADAlert"
|
|
},
|
|
">; setContext: (context: Context) => ",
|
|
"Alert",
|
|
"<State, Context, ActionGroupIds, ",
|
|
{
|
|
"pluginId": "@kbn/alerts-as-data-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
|
|
"section": "def-common.AADAlert",
|
|
"text": "AADAlert"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alert/alert.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.PublicFrameworkAlertsService",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicFrameworkAlertsService",
|
|
"description": [],
|
|
"signature": [
|
|
"PublicAlertsService",
|
|
" & { enabled: () => boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RULE_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RULE_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"alert\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/saved_objects/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleActionParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleActionParams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RulesClient",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RulesClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: <Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = never>(params: ",
|
|
"CreateRuleParams",
|
|
"<Params>) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<Params>>; update: <Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = never>(params: ",
|
|
"UpdateRuleParams",
|
|
"<Params>) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<Params>>; get: <Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = never>(params: Readonly<{ includeLegacyId?: boolean | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; } & { id: string; }>) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<Params> | ",
|
|
"SanitizedRuleWithLegacyId",
|
|
"<Params>>; delete: (params: Readonly<{} & { id: string; }>) => Promise<{}>; getGlobalExecutionLogWithAuth: (params: ",
|
|
"GetGlobalExecutionLogParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.IExecutionLogResult",
|
|
"text": "IExecutionLogResult"
|
|
},
|
|
">; getGlobalExecutionKpiWithAuth: (params: ",
|
|
"GetGlobalExecutionKPIParams",
|
|
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; find: <Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = never>(params?: Readonly<{ options?: Readonly<{ page?: number | undefined; filter?: string | Record<string, any> | undefined; search?: string | undefined; perPage?: number | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; hasReference?: Readonly<{} & { id: string; type: string; }> | undefined; fields?: string[] | undefined; filterConsumers?: string[] | undefined; } & {}> | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; featureIds?: string[] | undefined; } & {}> | undefined) => Promise<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.FindResult",
|
|
"text": "FindResult"
|
|
},
|
|
"<Params>>; muteAll: (options: { id: string; }) => Promise<void>; aggregate: <T = Record<string, unknown>>(params: ",
|
|
"AggregateParams",
|
|
"<T>) => Promise<T>; clone: <Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = never>(params: Readonly<{ newId?: string | undefined; } & { id: string; }>) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<Params>>; resolve: <Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
" = never>(params: ",
|
|
"ResolveParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ResolvedSanitizedRule",
|
|
"text": "ResolvedSanitizedRule"
|
|
},
|
|
"<Params>>; getAlertState: (params: ",
|
|
"GetAlertStateParams",
|
|
") => Promise<void | Readonly<{ alertTypeState?: Record<string, any> | undefined; alertInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; alertRecoveredInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; previousStartedAt?: string | null | undefined; summaryActions?: Record<string, Readonly<{} & { date: string; }>> | undefined; } & {}>>; getAlertSummary: (params: ",
|
|
"GetAlertSummaryParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.AlertSummary",
|
|
"text": "AlertSummary"
|
|
},
|
|
">; getExecutionLogForRule: (params: ",
|
|
"GetExecutionLogByIdParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.IExecutionLogResult",
|
|
"text": "IExecutionLogResult"
|
|
},
|
|
">; getRuleExecutionKPI: (params: ",
|
|
"GetRuleExecutionKPIParams",
|
|
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; getActionErrorLog: (params: ",
|
|
"GetActionErrorLogByIdParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.IExecutionErrorsResult",
|
|
"text": "IExecutionErrorsResult"
|
|
},
|
|
">; getActionErrorLogWithAuth: (params: ",
|
|
"GetActionErrorLogByIdParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.IExecutionErrorsResult",
|
|
"text": "IExecutionErrorsResult"
|
|
},
|
|
">; bulkDeleteRules: (options: Readonly<{ filter?: string | undefined; ids?: string[] | undefined; } & {}>) => Promise<",
|
|
"BulkDeleteRulesResult",
|
|
"<Record<string, any>>>; bulkEdit: <Params extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
">(options: ",
|
|
"BulkEditOptions",
|
|
"<Params>) => Promise<",
|
|
"BulkEditResult",
|
|
"<Params>>; bulkEnableRules: (params: ",
|
|
"BulkEnableRulesParams",
|
|
") => Promise<",
|
|
"BulkEnableRulesResult",
|
|
"<Record<string, any>>>; bulkDisableRules: (options: Readonly<{ filter?: string | undefined; ids?: string[] | undefined; untrack?: boolean | undefined; } & {}>) => Promise<",
|
|
"BulkDisableRulesResult",
|
|
"<Record<string, any>>>; updateRuleApiKey: (params: { id: string; }) => Promise<void>; disableRule: (params: Readonly<{ untrack?: boolean | undefined; } & { id: string; }>) => Promise<void>; enableRule: (params: Readonly<{} & { id: string; }>) => Promise<void>; snooze: (options: ",
|
|
"SnoozeRuleOptions",
|
|
") => Promise<void>; unsnooze: (options: ",
|
|
"UnsnoozeParams",
|
|
") => Promise<void>; clearExpiredSnoozes: (options: { rule: Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleTypeParams",
|
|
"text": "RuleTypeParams"
|
|
},
|
|
">, \"id\" | \"snoozeSchedule\">; version?: string | undefined; }) => Promise<void>; unmuteAll: (options: { id: string; }) => Promise<void>; muteInstance: (options: Readonly<{} & { alertId: string; alertInstanceId: string; }>) => Promise<void>; unmuteInstance: (options: Readonly<{} & { alertId: string; alertInstanceId: string; }>) => Promise<void>; bulkUntrackAlerts: (options: Readonly<{ indices?: string[] | undefined; featureIds?: string[] | undefined; alertUuids?: string[] | undefined; query?: any[] | undefined; } & { isUsingQuery: boolean; }>) => Promise<void>; runSoon: (options: { id: string; }) => Promise<string | undefined>; listRuleTypes: () => Promise<Set<",
|
|
"RegistryAlertTypeWithAuth",
|
|
">>; scheduleBackfill: (params: Readonly<{ end?: string | undefined; } & { start: string; ruleId: string; }>[]) => Promise<(Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; runAt: string; }>[]; createdAt: string; duration: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; }> | Readonly<{} & { error: Readonly<{ status?: number | undefined; } & { message: string; rule: Readonly<{ name?: string | undefined; } & { id: string; }>; }>; }>)[]>; getBackfill: (id: string) => Promise<Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; runAt: string; }>[]; createdAt: string; duration: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; }>>; findBackfill: (params: Readonly<{ start?: string | undefined; end?: string | undefined; sortField?: \"start\" | \"createdAt\" | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; ruleIds?: string | undefined; } & { page: number; perPage: number; }>) => Promise<Readonly<{} & { page: number; perPage: number; total: number; data: Readonly<{ end?: string | undefined; } & { id: string; spaceId: string; start: string; rule: Readonly<{ apiKeyCreatedByUser?: boolean | null | undefined; } & { params: Record<string, any>; id: string; consumer: string; name: string; tags: string[]; enabled: boolean; alertTypeId: string; schedule: Readonly<{} & { interval: string; }>; createdBy: string | null; updatedBy: string | null; createdAt: string; updatedAt: string; apiKeyOwner: string | null; revision: number; }>; enabled: boolean; schedule: Readonly<{} & { interval: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; runAt: string; }>[]; createdAt: string; duration: string; status: \"error\" | \"running\" | \"complete\" | \"pending\" | \"timeout\"; }>[]; }>>; deleteBackfill: (id: string) => Promise<{}>; getSpaceId: () => string | undefined; getAuthorization: () => ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "server",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-server.AlertingAuthorization",
|
|
"text": "AlertingAuthorization"
|
|
},
|
|
"; getAuditLogger: () => ",
|
|
{
|
|
"pluginId": "@kbn/core-security-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreSecurityServerPluginApi",
|
|
"section": "def-server.AuditLogger",
|
|
"text": "AuditLogger"
|
|
},
|
|
" | undefined; getTags: (params: Readonly<{ search?: string | undefined; perPage?: number | undefined; } & { page: number; }>) => Promise<Readonly<{} & { page: number; perPage: number; total: number; data: string[]; }>>; getScheduleFrequency: () => Promise<Readonly<{} & { totalScheduledPerMinute: number; remainingSchedulesPerMinute: number; }>>; getAlertFromRaw: (params: ",
|
|
"GetAlertFromRawParams",
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<never> | ",
|
|
"RuleWithLegacyId",
|
|
"<never>; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleTypeParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleTypeParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.RuleTypeState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleTypeState",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.ScopedQueryAlerts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ScopedQueryAlerts",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: string[]; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.TOTAL_FIELDS_LIMIT",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "TOTAL_FIELDS_LIMIT",
|
|
"description": [],
|
|
"signature": [
|
|
"2500"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.VALID_ALERT_INDEX_PREFIXES",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "VALID_ALERT_INDEX_PREFIXES",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/resource_installer_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_AAD_CONFIG",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_AAD_CONFIG",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_AAD_CONFIG.context",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_AAD_CONFIG.mappings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mappings",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_AAD_CONFIG.mappings.fieldMap",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fieldMap",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_AAD_CONFIG.shouldWrite",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "shouldWrite",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "x-pack/plugins/alerting/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_ALERTS_ILM_POLICY",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "_meta",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta.managed",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "managed",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "phases",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "hot",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "rollover",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover.max_age",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "max_age",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover.max_primary_shard_size",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "max_primary_shard_size",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.contextToSchemaName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "contextToSchemaName",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.contextToSchemaName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.convertDurationToFrequency",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "convertDurationToFrequency",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: string, denomination: number) => number"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.convertDurationToFrequency.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.convertDurationToFrequency.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "denomination",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.formatDuration",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "formatDuration",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: string, fullUnit: boolean | undefined) => string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.formatDuration.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.formatDuration.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "fullUnit",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.formatRuleTagsAggregationResult",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "formatRuleTagsAggregationResult",
|
|
"description": [],
|
|
"signature": [
|
|
"(aggregations: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleTagsAggregationResult",
|
|
"text": "RuleTagsAggregationResult"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleTagsAggregationFormattedResult",
|
|
"text": "RuleTagsAggregationFormattedResult"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.formatRuleTagsAggregationResult.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aggregations",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleTagsAggregationResult",
|
|
"text": "RuleTagsAggregationResult"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getBuiltinActionGroups",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getBuiltinActionGroups",
|
|
"description": [],
|
|
"signature": [
|
|
"(customRecoveryGroup: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId> | undefined) => [",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.ReservedActionGroups",
|
|
"text": "ReservedActionGroups"
|
|
},
|
|
"<RecoveryActionGroupId>>]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getBuiltinActionGroups.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "customRecoveryGroup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getComponentTemplateFromFieldMap",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getComponentTemplateFromFieldMap",
|
|
"description": [],
|
|
"signature": [
|
|
"({ name, fieldMap, dynamic, includeSettings, }: ",
|
|
"GetComponentTemplateFromFieldMapOpts",
|
|
") => ",
|
|
"ClusterPutComponentTemplateRequest"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getComponentTemplateFromFieldMap.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n name,\n fieldMap,\n dynamic,\n includeSettings,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"GetComponentTemplateFromFieldMapOpts"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getDurationNumberInItsUnit",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDurationNumberInItsUnit",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: string) => number"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getDurationNumberInItsUnit.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getDurationUnitValue",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDurationUnitValue",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getDurationUnitValue.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleCircuitBreakerErrorMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRuleCircuitBreakerErrorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"({ name, interval, intervalAvailable, action, rules, }: { name?: string | undefined; interval: number; intervalAvailable: number; action: \"create\" | \"update\" | \"bulkEdit\" | \"enable\" | \"bulkEnable\"; rules?: number | undefined; }) => string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleCircuitBreakerErrorMessage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n name = '',\n interval,\n intervalAvailable,\n action,\n rules = 1,\n}",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleCircuitBreakerErrorMessage.$1.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleCircuitBreakerErrorMessage.$1.interval",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleCircuitBreakerErrorMessage.$1.intervalAvailable",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "intervalAvailable",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleCircuitBreakerErrorMessage.$1.action",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "action",
|
|
"description": [],
|
|
"signature": [
|
|
"\"create\" | \"update\" | \"bulkEdit\" | \"enable\" | \"bulkEnable\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleCircuitBreakerErrorMessage.$1.rules",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "rules",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleTagsAggregation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRuleTagsAggregation",
|
|
"description": [],
|
|
"signature": [
|
|
"(params?: GetRuleTagsAggregationParams | undefined) => Record<string, ",
|
|
"AggregationsAggregationContainer",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getRuleTagsAggregation.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"GetRuleTagsAggregationParams | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getScopedQueryErrorMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getScopedQueryErrorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"(errorMessage: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.getScopedQueryErrorMessage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "errorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.isActionGroupDisabledForActionTypeId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isActionGroupDisabledForActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"(actionGroup: string, actionTypeId: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/disabled_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.isActionGroupDisabledForActionTypeId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionGroup",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/disabled_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.isActionGroupDisabledForActionTypeId.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/disabled_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.isScopedQueryError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isScopedQueryError",
|
|
"description": [],
|
|
"signature": [
|
|
"(errorMessage: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.isScopedQueryError.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "errorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window_scoped_query_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.mappingFromFieldMap",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mappingFromFieldMap",
|
|
"description": [],
|
|
"signature": [
|
|
"(fieldMap: ",
|
|
{
|
|
"pluginId": "@kbn/alerts-as-data-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
|
|
"section": "def-common.FieldMap",
|
|
"text": "FieldMap"
|
|
},
|
|
", dynamic: boolean | \"strict\") => ",
|
|
"MappingTypeMapping"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.mappingFromFieldMap.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fieldMap",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerts-as-data-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
|
|
"section": "def-common.FieldMap",
|
|
"text": "FieldMap"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.mappingFromFieldMap.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "dynamic",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | \"strict\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.parseDuration",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "parseDuration",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: string) => number"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.parseDuration.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.parseRuleCircuitBreakerErrorMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "parseRuleCircuitBreakerErrorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"(message: string) => { summary: string; details?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.parseRuleCircuitBreakerErrorMessage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_circuit_breaker_error_message.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.validateBackfillSchedule",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateBackfillSchedule",
|
|
"description": [],
|
|
"signature": [
|
|
"(start: string, end: string | undefined) => string | void"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/lib/validate_backfill_schedule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.validateBackfillSchedule.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/lib/validate_backfill_schedule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.validateBackfillSchedule.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "end",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/lib/validate_backfill_schedule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.validateDurationSchema",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateDurationSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: string) => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.validateDurationSchema.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.validateNotifyWhenType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateNotifyWhenType",
|
|
"description": [],
|
|
"signature": [
|
|
"(notifyWhen: string) => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.validateNotifyWhenType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "notifyWhen",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionGroup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionGroup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionGroup.id",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionGroup.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionGroup.severity",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "severity",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroupSeverity",
|
|
"text": "ActionGroupSeverity"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionVariable",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionVariable",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/action_variable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionVariable.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/action_variable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionVariable.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/action_variable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionVariable.deprecated",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "deprecated",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_variable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionVariable.useWithTripleBracesInTemplates",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useWithTripleBracesInTemplates",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_variable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionVariable.usesPublicBaseUrl",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "usesPublicBaseUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/action_variable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertDelay",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertDelay",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertDelay",
|
|
"text": "AlertDelay"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertDelay.active",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "active",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertingFrameworkHealth",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertingFrameworkHealth",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertingFrameworkHealth.isSufficientlySecure",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isSufficientlySecure",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasPermanentEncryptionKey",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertingFrameworkHealth.alertingFrameworkHealth",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alertingFrameworkHealth",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsHealth",
|
|
"text": "AlertsHealth"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsFilter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertsFilter",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsFilter",
|
|
"text": "AlertsFilter"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsFilter.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ kql: string; filters: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]; dsl?: string | undefined; } | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsFilter.timeframe",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeframe",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsFilterTimeframe",
|
|
"text": "AlertsFilterTimeframe"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsFilterTimeframe",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertsFilterTimeframe",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsFilterTimeframe",
|
|
"text": "AlertsFilterTimeframe"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsFilterTimeframe.days",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "days",
|
|
"description": [],
|
|
"signature": [
|
|
"(2 | 1 | 7 | 6 | 5 | 4 | 3)[]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsFilterTimeframe.timezone",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timezone",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsFilterTimeframe.hours",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "hours",
|
|
"description": [],
|
|
"signature": [
|
|
"{ start: string; end: string; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsHealth",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertsHealth",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsHealth.decryptionHealth",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "decryptionHealth",
|
|
"description": [],
|
|
"signature": [
|
|
"{ status: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.HealthStatus",
|
|
"text": "HealthStatus"
|
|
},
|
|
"; timestamp: string; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsHealth.executionHealth",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionHealth",
|
|
"description": [],
|
|
"signature": [
|
|
"{ status: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.HealthStatus",
|
|
"text": "HealthStatus"
|
|
},
|
|
"; timestamp: string; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertsHealth.readHealth",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "readHealth",
|
|
"description": [],
|
|
"signature": [
|
|
"{ status: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.HealthStatus",
|
|
"text": "HealthStatus"
|
|
},
|
|
"; timestamp: string; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertStatus",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uuid",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"OK\" | \"Active\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.muted",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "muted",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.actionGroupId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionGroupId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.activeStartDate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "activeStartDate",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.flapping",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "flapping",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.maintenanceWindowIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "maintenanceWindowIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatus.tracked",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "tracked",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AlertSummary",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.tags",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "tags",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.ruleTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ruleTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.consumer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "consumer",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.muteAll",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "muteAll",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.throttle",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "throttle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.statusStartDate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "statusStartDate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.statusEndDate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "statusEndDate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"OK\" | \"Active\" | \"Error\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.lastRun",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "lastRun",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.errorMessages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errorMessages",
|
|
"description": [],
|
|
"signature": [
|
|
"{ date: string; message: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.alerts",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alerts",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.AlertStatus",
|
|
"text": "AlertStatus"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.executionDuration",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionDuration",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.ExecutionDuration",
|
|
"text": "ExecutionDuration"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertSummary.revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.BulkActionSkipResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkActionSkipResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/bulk_edit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.BulkActionSkipResult.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/bulk_edit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.BulkActionSkipResult.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/bulk_edit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.BulkActionSkipResult.skip_reason",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "skip_reason",
|
|
"description": [],
|
|
"signature": [
|
|
"\"RULE_NOT_MODIFIED\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/bulk_edit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DateRange",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DateRange",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DateRange.gte",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "gte",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DateRange.lte",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "lte",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ExecutionDuration",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ExecutionDuration",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ExecutionDuration.average",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "average",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ExecutionDuration.valuesWithTimestamp",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "valuesWithTimestamp",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: number; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrors",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExecutionErrors",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrors.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrors.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrors.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrors.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrorsResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExecutionErrorsResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrorsResult.totalErrors",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "totalErrors",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionErrorsResult.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.IExecutionErrors",
|
|
"text": "IExecutionErrors"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExecutionLog",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.duration_ms",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "duration_ms",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.status",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.num_active_alerts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_active_alerts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.num_new_alerts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_new_alerts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.num_recovered_alerts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_recovered_alerts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.num_triggered_actions",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_triggered_actions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.num_generated_actions",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_generated_actions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.num_succeeded_actions",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_succeeded_actions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.num_errored_actions",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_errored_actions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.total_search_duration_ms",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total_search_duration_ms",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.es_search_duration_ms",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "es_search_duration_ms",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.schedule_delay_ms",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "schedule_delay_ms",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.timed_out",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "timed_out",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.rule_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "rule_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.space_ids",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "space_ids",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.rule_name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "rule_name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLog.maintenance_window_ids",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "maintenance_window_ids",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLogResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExecutionLogResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLogResult.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionLogResult.data",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.IExecutionLog",
|
|
"text": "IExecutionLog"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IntervalSchedule",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IntervalSchedule",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.IntervalSchedule",
|
|
"text": "IntervalSchedule"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IntervalSchedule.interval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowClientContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MaintenanceWindowClientContext",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowClientContext.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-ui-settings-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreUiSettingsServerPluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowClientContext.getModificationMetadata",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getModificationMetadata",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.MaintenanceWindowModificationMetadata",
|
|
"text": "MaintenanceWindowModificationMetadata"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowClientContext.savedObjectsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-api-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
|
|
"section": "def-server.SavedObjectsClientContract",
|
|
"text": "SavedObjectsClientContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowClientContext.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "common",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-common.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowModificationMetadata",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MaintenanceWindowModificationMetadata",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowModificationMetadata.createdBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "createdBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowModificationMetadata.updatedBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "updatedBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowModificationMetadata.createdAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "createdAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowModificationMetadata.updatedAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties",
|
|
"type": "Interface",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "MaintenanceWindowSOProperties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.duration",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.expirationDate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "expirationDate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.events",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "events",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.DateRange",
|
|
"text": "DateRange"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.rRule",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rRule",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleRecord",
|
|
"text": "RRuleRecord"
|
|
},
|
|
"> & Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleRecord",
|
|
"text": "RRuleRecord"
|
|
},
|
|
", \"dtstart\" | \"tzid\">"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.categoryIds",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "categoryIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOProperties.scopedQuery",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "scopedQuery",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.ScopedQueryAttributes",
|
|
"text": "ScopedQueryAttributes"
|
|
},
|
|
" | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MappedParamsProperties",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MappedParamsProperties",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MappedParamsProperties.risk_score",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "risk_score",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MappedParamsProperties.severity",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "severity",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Rule",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.tags",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "tags",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.alertTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "alertTypeId",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.consumer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "consumer",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.schedule",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schedule",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.IntervalSchedule",
|
|
"text": "IntervalSchedule"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.actions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "actions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleAction",
|
|
"text": "RuleAction"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.systemActions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "systemActions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleSystemAction",
|
|
"text": "RuleSystemAction"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.mapped_params",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "mapped_params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.MappedParams",
|
|
"text": "MappedParams"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.scheduledTaskId",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "scheduledTaskId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.createdBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "createdBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.updatedBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "updatedBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.createdAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "createdAt",
|
|
"description": [],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.updatedAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.apiKey",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "apiKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.apiKeyOwner",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "apiKeyOwner",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.apiKeyCreatedByUser",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "apiKeyCreatedByUser",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.throttle",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "throttle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.muteAll",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "muteAll",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.notifyWhen",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "notifyWhen",
|
|
"description": [],
|
|
"signature": [
|
|
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.mutedInstanceIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "mutedInstanceIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.executionStatus",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionStatus",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleExecutionStatus",
|
|
"text": "RuleExecutionStatus"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.monitoring",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "monitoring",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoring",
|
|
"text": "RuleMonitoring"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.snoozeSchedule",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "snoozeSchedule",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleSnooze",
|
|
"text": "RuleSnooze"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.activeSnoozes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "activeSnoozes",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.isSnoozedUntil",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isSnoozedUntil",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.lastRun",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "lastRun",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleLastRun",
|
|
"text": "RuleLastRun"
|
|
},
|
|
" | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.nextRun",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "nextRun",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.running",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "running",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.viewInAppRelativeUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "viewInAppRelativeUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.Rule.alertDelay",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "alertDelay",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertDelay",
|
|
"text": "AlertDelay"
|
|
},
|
|
" | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleAction",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uuid",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.group",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.actionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.frequency",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "frequency",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleActionFrequency",
|
|
"text": "RuleActionFrequency"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.alertsFilter",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alertsFilter",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsFilter",
|
|
"text": "AlertsFilter"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAction.useAlertDataForTemplate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useAlertDataForTemplate",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionFrequency",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleActionFrequency",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleActionFrequency",
|
|
"text": "RuleActionFrequency"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionFrequency.summary",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "summary",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionFrequency.notifyWhen",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "notifyWhen",
|
|
"description": [],
|
|
"signature": [
|
|
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionFrequency.throttle",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "throttle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatus",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleExecutionStatus",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatus.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"unknown\" | \"ok\" | \"error\" | \"pending\" | \"active\" | \"warning\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatus.lastExecutionDate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lastExecutionDate",
|
|
"description": [],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatus.lastDuration",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "lastDuration",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatus.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"{ reason: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleExecutionStatusErrorReasons",
|
|
"text": "RuleExecutionStatusErrorReasons"
|
|
},
|
|
"; message: string; } | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatus.warning",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "warning",
|
|
"description": [],
|
|
"signature": [
|
|
"{ reason: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleExecutionStatusWarningReasons",
|
|
"text": "RuleExecutionStatusWarningReasons"
|
|
},
|
|
"; message: string; } | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRun",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleLastRun",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRun.outcome",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "outcome",
|
|
"description": [],
|
|
"signature": [
|
|
"\"warning\" | \"succeeded\" | \"failed\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRun.outcomeOrder",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "outcomeOrder",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRun.warning",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "warning",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleExecutionStatusErrorReasons",
|
|
"text": "RuleExecutionStatusErrorReasons"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleExecutionStatusWarningReasons",
|
|
"text": "RuleExecutionStatusWarningReasons"
|
|
},
|
|
" | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRun.outcomeMsg",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "outcomeMsg",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | null | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRun.alertsCount",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alertsCount",
|
|
"description": [],
|
|
"signature": [
|
|
"{ active?: number | null | undefined; new?: number | null | undefined; recovered?: number | null | undefined; ignored?: number | null | undefined; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoring",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleMonitoring",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoring.run",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "run",
|
|
"description": [],
|
|
"signature": [
|
|
"{ history: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoringHistory",
|
|
"text": "RuleMonitoringHistory"
|
|
},
|
|
"[]; calculated_metrics: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoringCalculatedMetrics",
|
|
"text": "RuleMonitoringCalculatedMetrics"
|
|
},
|
|
"; last_run: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoringLastRun",
|
|
"text": "RuleMonitoringLastRun"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringCalculatedMetrics",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleMonitoringCalculatedMetrics",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoringCalculatedMetrics",
|
|
"text": "RuleMonitoringCalculatedMetrics"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringCalculatedMetrics.p50",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "p50",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringCalculatedMetrics.p95",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "p95",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringCalculatedMetrics.p99",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "p99",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringCalculatedMetrics.success_ratio",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "success_ratio",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringHistory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleMonitoringHistory",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoringHistory",
|
|
"text": "RuleMonitoringHistory"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringHistory.success",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "success",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringHistory.timestamp",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringHistory.duration",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringHistory.outcome",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "outcome",
|
|
"description": [],
|
|
"signature": [
|
|
"\"warning\" | \"succeeded\" | \"failed\" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRun",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleMonitoringLastRun",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoringLastRun",
|
|
"text": "RuleMonitoringLastRun"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRun.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRun.metrics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleMonitoringLastRunMetrics",
|
|
"text": "RuleMonitoringLastRunMetrics"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRunMetrics",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleMonitoringLastRunMetrics",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RuleMonitoringLastRunMetrics",
|
|
"text": "RuleMonitoringLastRunMetrics"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRunMetrics.duration",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRunMetrics.total_search_duration_ms",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "total_search_duration_ms",
|
|
"description": [],
|
|
"signature": [
|
|
"number | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRunMetrics.total_indexing_duration_ms",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "total_indexing_duration_ms",
|
|
"description": [],
|
|
"signature": [
|
|
"number | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_detected",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "total_alerts_detected",
|
|
"description": [],
|
|
"signature": [
|
|
"number | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_created",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "total_alerts_created",
|
|
"description": [],
|
|
"signature": [
|
|
"number | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleMonitoringLastRunMetrics.gap_duration_s",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "gap_duration_s",
|
|
"description": [],
|
|
"signature": [
|
|
"number | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSnoozeSchedule",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleSnoozeSchedule",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSnoozeSchedule.duration",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSnoozeSchedule.rRule",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rRule",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleRecord",
|
|
"text": "RRuleRecord"
|
|
},
|
|
"> & Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleRecord",
|
|
"text": "RRuleRecord"
|
|
},
|
|
", \"dtstart\" | \"tzid\">"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSnoozeSchedule.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSnoozeSchedule.skipRecurrences",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "skipRecurrences",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RulesSettings",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettings.flapping",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "flapping",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsFlapping",
|
|
"text": "RulesSettingsFlapping"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettings.queryDelay",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "queryDelay",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsQueryDelay",
|
|
"text": "RulesSettingsQueryDelay"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsFlappingProperties",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RulesSettingsFlappingProperties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsFlappingProperties.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsFlappingProperties.lookBackWindow",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "lookBackWindow",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsFlappingProperties.statusChangeThreshold",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusChangeThreshold",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsModificationMetadata",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RulesSettingsModificationMetadata",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsModificationMetadata.createdBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "createdBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsModificationMetadata.updatedBy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "updatedBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsModificationMetadata.createdAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "createdAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsModificationMetadata.updatedAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsProperties",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RulesSettingsProperties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsProperties.flapping",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "flapping",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsFlappingProperties",
|
|
"text": "RulesSettingsFlappingProperties"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsProperties.queryDelay",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "queryDelay",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsQueryDelayProperties",
|
|
"text": "RulesSettingsQueryDelayProperties"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsQueryDelayProperties",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RulesSettingsQueryDelayProperties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsQueryDelayProperties.delay",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "delay",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSystemAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleSystemAction",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSystemAction.uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uuid",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSystemAction.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSystemAction.actionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSystemAction.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTagsAggregationFormattedResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleTagsAggregationFormattedResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTagsAggregationFormattedResult.ruleTags",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "ruleTags",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTagsAggregationResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleTagsAggregationResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTagsAggregationResult.tags",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "tags",
|
|
"description": [],
|
|
"signature": [
|
|
"{ buckets: { key: { tags: string; }; doc_count: number; }[]; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RuleType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleType",
|
|
"text": "RuleType"
|
|
},
|
|
"<ActionGroupIds, RecoveryActionGroupId>"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.actionGroups",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "actionGroups",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<ActionGroupIds>[]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.recoveryActionGroup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "recoveryActionGroup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<RecoveryActionGroupId>"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.actionVariables",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actionVariables",
|
|
"description": [],
|
|
"signature": [
|
|
"{ context: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[]; state: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[]; params: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionVariable",
|
|
"text": "ActionVariable"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.defaultActionGroupId",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultActionGroupId",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionGroupIds"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.category",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.producer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "producer",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.isExportable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isExportable",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.ruleTaskTimeout",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ruleTaskTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.defaultScheduleInterval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "defaultScheduleInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.doesSetRecoveryContext",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "doesSetRecoveryContext",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.enabledInLicense",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabledInLicense",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleType.authorizedConsumers",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "authorizedConsumers",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: ConsumerPrivileges; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.SanitizedAlertsFilter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SanitizedAlertsFilter",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedAlertsFilter",
|
|
"text": "SanitizedAlertsFilter"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsFilter",
|
|
"text": "AlertsFilter"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.SanitizedAlertsFilter.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ kql: string; filters: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]; } | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.SanitizedAlertsFilter.timeframe",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeframe",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsFilterTimeframe",
|
|
"text": "AlertsFilterTimeframe"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ScopedQueryAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ScopedQueryAttributes",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ScopedQueryAttributes.kql",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kql",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ScopedQueryAttributes.filters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [],
|
|
"signature": [
|
|
"ScopeQueryFilter",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ScopedQueryAttributes.dsl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "dsl",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.HealthStatus",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "HealthStatus",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/alerting_framework_health_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowStatus",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "MaintenanceWindowStatus",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatusErrorReasons",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RuleExecutionStatusErrorReasons",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatusWarningReasons",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RuleExecutionStatusWarningReasons",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleNotifyWhen",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RuleNotifyWhen",
|
|
"description": [],
|
|
"path": "packages/kbn-alerting-types/rule_notify_when_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.actionErrorLogSortableColumns",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "actionErrorLogSortableColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionErrorLogSortFields",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionErrorLogSortFields",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ActionGroupIdsOf",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionGroupIdsOf",
|
|
"description": [],
|
|
"signature": [
|
|
"T extends ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<infer groups extends string> ? groups : T extends Readonly<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroup",
|
|
"text": "ActionGroup"
|
|
},
|
|
"<infer groups extends string>> ? groups : never"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ALERTING_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ALERTING_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"alerts\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertInstanceContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AlertInstanceContext",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.AlertStatusValues",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AlertStatusValues",
|
|
"description": [],
|
|
"signature": [
|
|
"\"OK\" | \"Active\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"allFlappingSettings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ALL_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ALL_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"allQueryDelaySettings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.BASE_ALERTING_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "BASE_ALERTING_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/api/alerting\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.BulkEditSkipReason",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "BulkEditSkipReason",
|
|
"description": [],
|
|
"signature": [
|
|
"\"RULE_NOT_MODIFIED\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/bulk_edit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_LOOK_BACK_WINDOW",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DEFAULT_LOOK_BACK_WINDOW",
|
|
"description": [],
|
|
"signature": [
|
|
"20"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_QUERY_DELAY",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DEFAULT_QUERY_DELAY",
|
|
"description": [],
|
|
"signature": [
|
|
"0"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_SERVERLESS_QUERY_DELAY",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DEFAULT_SERVERLESS_QUERY_DELAY",
|
|
"description": [],
|
|
"signature": [
|
|
"15"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_STATUS_CHANGE_THRESHOLD",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DEFAULT_STATUS_CHANGE_THRESHOLD",
|
|
"description": [],
|
|
"signature": [
|
|
"4"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DefaultActionGroupId",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DefaultActionGroupId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"default\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ENABLE_MAINTENANCE_WINDOWS",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "ENABLE_MAINTENANCE_WINDOWS",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ExecutionLogSortFields",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExecutionLogSortFields",
|
|
"description": [],
|
|
"signature": [
|
|
"\"timestamp\" | \"execution_duration\" | \"schedule_delay\" | \"total_search_duration\" | \"es_search_duration\" | \"num_triggered_actions\" | \"num_generated_actions\" | \"num_active_alerts\" | \"num_recovered_alerts\" | \"num_new_alerts\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IExecutionKPIResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IExecutionKPIResult",
|
|
"description": [],
|
|
"signature": [
|
|
"{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_ALERTING_API_FIND_RULES_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_ALERTING_API_FIND_RULES_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting/rules/_find\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting/rules/maintenance_window/_active\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting/rules/maintenance_window\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_ALERTING_BACKFILL_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_ALERTING_BACKFILL_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting/rules/backfill\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_ALERTING_BACKFILL_FIND_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_ALERTING_BACKFILL_FIND_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting/rules/backfill/_find\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_ALERTING_BACKFILL_SCHEDULE_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_ALERTING_BACKFILL_SCHEDULE_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting/rules/backfill/_schedule\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_ALERTING_SNOOZE_RULE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_ALERTING_SNOOZE_RULE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting/rule/{id}/_snooze\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.INTERNAL_BASE_ALERTING_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_BASE_ALERTING_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/alerting\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.IsoWeekday",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IsoWeekday",
|
|
"description": [],
|
|
"signature": [
|
|
"2 | 1 | 7 | 6 | 5 | 4 | 3"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.LatestAlertInstanceMetaSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LatestAlertInstanceMetaSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly uuid?: string | undefined; readonly lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; readonly flappingHistory?: boolean[] | undefined; readonly flapping?: boolean | undefined; readonly maintenanceWindowIds?: string[] | undefined; readonly pendingRecoveredCount?: number | undefined; readonly activeCount?: number | undefined; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.LatestAlertInstanceStateSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LatestAlertInstanceStateSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.LatestLastScheduledActionsSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LatestLastScheduledActionsSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; readonly subgroup?: string | undefined; readonly date: string; readonly group: string; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.LatestRawAlertInstanceSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LatestRawAlertInstanceSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; readonly state?: Record<string, any> | undefined; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.LatestTaskStateSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LatestTaskStateSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly alertTypeState?: Record<string, any> | undefined; readonly alertInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; readonly alertRecoveredInstances?: Record<string, Readonly<{ meta?: Readonly<{ uuid?: string | undefined; lastScheduledActions?: Readonly<{ actions?: Record<string, Readonly<{} & { date: string; }>> | undefined; subgroup?: string | undefined; } & { date: string; group: string; }> | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; activeCount?: number | undefined; } & {}> | undefined; state?: Record<string, any> | undefined; } & {}>> | undefined; readonly previousStartedAt?: string | null | undefined; readonly summaryActions?: Record<string, Readonly<{} & { date: string; }>> | undefined; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.LatestThrottledActionSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LatestThrottledActionSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: Readonly<{} & { date: string; }>; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/task_state/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.LEGACY_BASE_ALERT_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LEGACY_BASE_ALERT_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/api/alerts\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_DATE_FORMAT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MAINTENANCE_WINDOW_DATE_FORMAT",
|
|
"description": [],
|
|
"signature": [
|
|
"\"MM/DD/YY hh:mm A\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MAINTENANCE_WINDOW_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"maintenanceWindow\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"maintenance-window\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOWS_APP_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MAINTENANCE_WINDOWS_APP_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"maintenanceWindows\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindow",
|
|
"type": "Type",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "MaintenanceWindow",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.MaintenanceWindowSOProperties",
|
|
"text": "MaintenanceWindowSOProperties"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.MaintenanceWindowModificationMetadata",
|
|
"text": "MaintenanceWindowModificationMetadata"
|
|
},
|
|
" & { status: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.MaintenanceWindowStatus",
|
|
"text": "MaintenanceWindowStatus"
|
|
},
|
|
"; eventStartTime: string | null; eventEndTime: string | null; id: string; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/apis/bulk_get_maintenance_windows.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/apis/bulk_get_maintenance_windows.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/apis/bulk_get_maintenance_windows.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/apis/bulk_get_maintenance_windows.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/apis/bulk_get_maintenance_windows.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_get_maintenance_windows.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_get_maintenance_windows.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/tooltip_content.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/tooltip_content.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/cell.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/cell.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/cell.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/cell.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_alert_list.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_alert_list.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_alert_list.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_alert_list.tsx"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/index.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "triggersActionsUi",
|
|
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/maintenance_windows/index.mock.ts"
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowCreateBody",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MaintenanceWindowCreateBody",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title: string; duration: number; rRule: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleParams",
|
|
"text": "RRuleParams"
|
|
},
|
|
"; categoryIds?: string[] | null | undefined; scopedQuery?: ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.ScopedQueryAttributes",
|
|
"text": "ScopedQueryAttributes"
|
|
},
|
|
" | null | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowDeepLinkIds",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MaintenanceWindowDeepLinkIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MaintenanceWindowSOAttributes",
|
|
"type": "Type",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "MaintenanceWindowSOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.MaintenanceWindowSOProperties",
|
|
"text": "MaintenanceWindowSOProperties"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.MaintenanceWindowModificationMetadata",
|
|
"text": "MaintenanceWindowModificationMetadata"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MANAGEMENT_APP_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MANAGEMENT_APP_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"management\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MappedParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MappedParams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.MappedParamsProperties",
|
|
"text": "MappedParamsProperties"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAX_LOOK_BACK_WINDOW",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MAX_LOOK_BACK_WINDOW",
|
|
"description": [],
|
|
"signature": [
|
|
"20"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAX_QUERY_DELAY",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MAX_QUERY_DELAY",
|
|
"description": [],
|
|
"signature": [
|
|
"60"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAX_STATUS_CHANGE_THRESHOLD",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MAX_STATUS_CHANGE_THRESHOLD",
|
|
"description": [],
|
|
"signature": [
|
|
"20"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MIN_LOOK_BACK_WINDOW",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MIN_LOOK_BACK_WINDOW",
|
|
"description": [],
|
|
"signature": [
|
|
"2"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MIN_QUERY_DELAY",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MIN_QUERY_DELAY",
|
|
"description": [],
|
|
"signature": [
|
|
"0"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MIN_STATUS_CHANGE_THRESHOLD",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MIN_STATUS_CHANGE_THRESHOLD",
|
|
"description": [],
|
|
"signature": [
|
|
"2"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MONITORING_HISTORY_LIMIT",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MONITORING_HISTORY_LIMIT",
|
|
"description": [],
|
|
"signature": [
|
|
"200"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.preconfiguredConnectorActionRefPrefix",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "preconfiguredConnectorActionRefPrefix",
|
|
"description": [],
|
|
"signature": [
|
|
"\"preconfigured:\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/action_ref_prefix.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.READ_FLAPPING_SETTINGS_SUB_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "READ_FLAPPING_SETTINGS_SUB_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"readFlappingSettings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.READ_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "READ_QUERY_DELAY_SETTINGS_SUB_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"readQueryDelaySettings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RecoveredActionGroupId",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RecoveredActionGroupId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"recovered\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ReservedActionGroups",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ReservedActionGroups",
|
|
"description": [],
|
|
"signature": [
|
|
"RecoveryActionGroupId | \"recovered\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ResolvedSanitizedRule",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ResolvedSanitizedRule",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<Params>, \"actions\" | \"apiKey\"> & { actions: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRuleAction",
|
|
"text": "SanitizedRuleAction"
|
|
},
|
|
"[]; } & Omit<",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-api-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
|
|
"section": "def-server.SavedObjectsResolveResponse",
|
|
"text": "SavedObjectsResolveResponse"
|
|
},
|
|
"<unknown>, \"saved_object\"> & { outcome: string; alias_target_id?: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RRuleParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RRuleParams",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleRecord",
|
|
"text": "RRuleRecord"
|
|
},
|
|
"> & Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleRecord",
|
|
"text": "RRuleRecord"
|
|
},
|
|
", \"dtstart\" | \"tzid\">"
|
|
],
|
|
"path": "packages/kbn-alerting-types/r_rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RRuleRecord",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RRuleRecord",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
"Options",
|
|
", \"dtstart\" | \"until\" | \"byweekday\" | \"wkst\"> & { dtstart: string; byweekday?: (string | number)[] | undefined; wkst?: ",
|
|
{
|
|
"pluginId": "@kbn/rrule",
|
|
"scope": "common",
|
|
"docId": "kibKbnRrulePluginApi",
|
|
"section": "def-common.WeekdayStr",
|
|
"text": "WeekdayStr"
|
|
},
|
|
" | undefined; until?: string | undefined; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/r_rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionAlertsFilterProperty",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleActionAlertsFilterProperty",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttribute",
|
|
"text": "SavedObjectAttribute"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.AlertsFilterTimeframe",
|
|
"text": "AlertsFilterTimeframe"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionKey",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleActionKey",
|
|
"description": [],
|
|
"signature": [
|
|
"keyof ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleAction",
|
|
"text": "RuleAction"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionParam",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleActionParam",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributeSingle",
|
|
"text": "SavedObjectAttributeSingle"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributeSingle",
|
|
"text": "SavedObjectAttributeSingle"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleActionParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleActionParams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "SavedObjectAttributes"
|
|
}
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAlertData",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleAlertData",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleAlertingOutcome",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleAlertingOutcome",
|
|
"description": [],
|
|
"signature": [
|
|
"\"unknown\" | \"warning\" | \"success\" | \"failure\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatuses",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleExecutionStatuses",
|
|
"description": [],
|
|
"signature": [
|
|
"\"unknown\" | \"ok\" | \"error\" | \"pending\" | \"active\" | \"warning\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRunOutcomes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleLastRunOutcomes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"warning\" | \"succeeded\" | \"failed\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleNotifyWhenType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleNotifyWhenType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_notify_when_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RULES_SETTINGS_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RULES_SETTINGS_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"rulesSettings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RULES_SETTINGS_FLAPPING_SAVED_OBJECT_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RULES_SETTINGS_FLAPPING_SAVED_OBJECT_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"rules-settings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RULES_SETTINGS_QUERY_DELAY_SAVED_OBJECT_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RULES_SETTINGS_QUERY_DELAY_SAVED_OBJECT_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"query-delay-settings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RULES_SETTINGS_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RULES_SETTINGS_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"rules-settings\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSnooze",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleSnooze",
|
|
"description": [],
|
|
"signature": [
|
|
"{ duration: number; rRule: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RRuleParams",
|
|
"text": "RRuleParams"
|
|
},
|
|
"; id?: string | undefined; skipRecurrences?: string[] | undefined; }[]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsFlapping",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RulesSettingsFlapping",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsFlappingProperties",
|
|
"text": "RulesSettingsFlappingProperties"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsModificationMetadata",
|
|
"text": "RulesSettingsModificationMetadata"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RulesSettingsQueryDelay",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RulesSettingsQueryDelay",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsQueryDelayProperties",
|
|
"text": "RulesSettingsQueryDelayProperties"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.RulesSettingsModificationMetadata",
|
|
"text": "RulesSettingsModificationMetadata"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleStatusValues",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleStatusValues",
|
|
"description": [],
|
|
"signature": [
|
|
"\"OK\" | \"Active\" | \"Error\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/alert_summary.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleSystemActionKey",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleSystemActionKey",
|
|
"description": [],
|
|
"signature": [
|
|
"keyof ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleSystemAction",
|
|
"text": "RuleSystemAction"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTagsAggregationOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleTagsAggregationOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"AggregateOptions",
|
|
", \"filter\" | \"search\"> & { after?: ",
|
|
"AggregationsCompositeAggregateKey",
|
|
" | undefined; maxTags?: number | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTaskParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleTaskParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ alertId: string; } & { spaceId?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTypeMetaData",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleTypeMetaData",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTypeParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleTypeParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleTypeState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RuleTypeState",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.SanitizedRule",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SanitizedRule",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.Rule",
|
|
"text": "Rule"
|
|
},
|
|
"<Params>, \"actions\" | \"apiKey\"> & { actions: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRuleAction",
|
|
"text": "SanitizedRuleAction"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.SanitizedRuleAction",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SanitizedRuleAction",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.RuleAction",
|
|
"text": "RuleAction"
|
|
},
|
|
", \"alertsFilter\"> & { alertsFilter?: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedAlertsFilter",
|
|
"text": "SanitizedAlertsFilter"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.SanitizedRuleConfig",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SanitizedRuleConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.SanitizedRule",
|
|
"text": "SanitizedRule"
|
|
},
|
|
"<never>, \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\" | \"revision\" | \"alertDelay\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.systemConnectorActionRefPrefix",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "systemConnectorActionRefPrefix",
|
|
"description": [],
|
|
"signature": [
|
|
"\"system_action:\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/action_ref_prefix.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.TrackedLifecycleAlertState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TrackedLifecycleAlertState",
|
|
"description": [],
|
|
"signature": [
|
|
"{ alertId: string; alertUuid: string; started: string; flappingHistory: boolean[]; flapping: boolean; pendingRecoveredCount: number; activeCount: number; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.WithoutReservedActionGroups",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "WithoutReservedActionGroups",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionGroupIds extends ",
|
|
{
|
|
"pluginId": "alerting",
|
|
"scope": "common",
|
|
"docId": "kibAlertingPluginApi",
|
|
"section": "def-common.ReservedActionGroups",
|
|
"text": "ReservedActionGroups"
|
|
},
|
|
"<RecoveryActionGroupId> ? never : ActionGroupIds"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.WrappedLifecycleRuleState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "WrappedLifecycleRuleState",
|
|
"description": [
|
|
"\nThis is redefined instead of derived from above `wrappedStateRt` because\nthere's no easy way to instantiate generic values such as the runtime type\nfactory function."
|
|
],
|
|
"signature": [
|
|
"RuleTypeState & { wrapped: State; trackedAlerts: Record<string, { alertId: string; alertUuid: string; started: string; flappingHistory: boolean[]; flapping: boolean; pendingRecoveredCount: number; activeCount: number; }>; trackedAlertsRecovered: Record<string, { alertId: string; alertUuid: string; started: string; flappingHistory: boolean[]; flapping: boolean; pendingRecoveredCount: number; activeCount: number; }>; }"
|
|
],
|
|
"path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alertMappings",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.dynamic",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "dynamic",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.enabled",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.enabled.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.name",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.name.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"text\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.name.fields",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fields",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.name.fields.keyword",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "keyword",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.name.fields.keyword.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.name.fields.keyword.normalizer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "normalizer",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.tags",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "tags",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.tags.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.alertTypeId",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alertTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.alertTypeId.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.schedule",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schedule",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.schedule.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.schedule.properties.interval",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.schedule.properties.interval.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.consumer",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "consumer",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.consumer.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.legacyId",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "legacyId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.legacyId.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.dynamic",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "dynamic",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"nested\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.properties.group",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.properties.group.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.properties.actionRef",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actionRef",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.properties.actionRef.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.properties.actionTypeId",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.actions.properties.actionTypeId.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.params.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"flattened\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.params.ignore_above",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "ignore_above",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mapped_params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mapped_params",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mapped_params.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mapped_params.properties.risk_score",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "risk_score",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mapped_params.properties.risk_score.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mapped_params.properties.severity",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "severity",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mapped_params.properties.severity.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.scheduledTaskId",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "scheduledTaskId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.scheduledTaskId.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.createdBy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "createdBy",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.createdBy.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.updatedBy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updatedBy",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.updatedBy.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.createdAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "createdAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.createdAt.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"date\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.updatedAt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.updatedAt.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"date\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.throttle",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "throttle",
|
|
"description": [
|
|
"// NEED TO CHECK WITH KIBANA SECURITY\n// apiKey: {\n// type: 'binary',\n// },\n// NO NEED TO BE INDEXED\n// apiKeyOwner: {\n// type: 'keyword',\n// },"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.throttle.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.notifyWhen",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "notifyWhen",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.notifyWhen.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.muteAll",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "muteAll",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.muteAll.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mutedInstanceIds",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mutedInstanceIds",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.mutedInstanceIds.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "monitoring",
|
|
"description": [
|
|
"// NO NEED TO BE INDEXED\n// meta: {\n// properties: {\n// versionApiKeyLastmodified: {\n// type: 'keyword',\n// },\n// },\n// },"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "run",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "calculated_metrics",
|
|
"description": [
|
|
"// history: {\n// properties: {\n// duration: {\n// type: 'long',\n// },\n// success: {\n// type: 'boolean',\n// },\n// timestamp: {\n// type: 'date',\n// },\n// outcome: {\n// type: 'keyword',\n// },\n// },\n// },"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p50",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "p50",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p50.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p95",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "p95",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p95.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p99",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "p99",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p99.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.success_ratio",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "success_ratio",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.success_ratio.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "last_run",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.timestamp",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.timestamp.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"date\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.duration",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.duration.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_search_duration_ms",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "total_search_duration_ms",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_search_duration_ms.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_indexing_duration_ms",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "total_indexing_duration_ms",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_indexing_duration_ms.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_detected",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "total_alerts_detected",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_detected.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_created",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "total_alerts_created",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_created.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.gap_duration_s",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "gap_duration_s",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.gap_duration_s.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.revision",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [
|
|
"// There is need to query for a rule by a specific revision"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.revision.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "snoozeSchedule",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"nested\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties.id",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties.id.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties.duration",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties.duration.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties.skipRecurrences",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "skipRecurrences",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties.skipRecurrences.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"date\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.snoozeSchedule.properties.skipRecurrences.format",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionStatus",
|
|
"description": [
|
|
"// NO NEED TO BE INDEXED\n// nextRun: {\n// type: 'date',\n// },\n// Deprecated, if you need to add new property please do it in `last_run`"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.numberOfTriggeredActions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "numberOfTriggeredActions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.numberOfTriggeredActions.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.status",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.status.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.lastExecutionDate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lastExecutionDate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.lastExecutionDate.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"date\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.lastDuration",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lastDuration",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.lastDuration.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"long\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.error.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.reason",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "reason",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.reason.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.message",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.message.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.warning",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "warning",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.reason",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "reason",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.reason.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.message",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.message.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lastRun",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.outcome",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "outcome",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.outcome.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"keyword\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.outcomeOrder",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "outcomeOrder",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.outcomeOrder.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alertsCount",
|
|
"description": [
|
|
"// NO NEED TO BE INDEXED\n// warning: {\n// type: 'text',\n// },\n// outcomeMsg: {\n// type: 'text',\n// },"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.active",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "active",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.active.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.new",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "new",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.new.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.recovered",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "recovered",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.recovered.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.ignored",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ignored",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.ignored.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"float\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.running",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "running",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.alertMappings.properties.running.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\""
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.API_PRIVILEGES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "API_PRIVILEGES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.API_PRIVILEGES.READ_FLAPPING_SETTINGS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "READ_FLAPPING_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.API_PRIVILEGES.WRITE_FLAPPING_SETTINGS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "WRITE_FLAPPING_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.API_PRIVILEGES.READ_QUERY_DELAY_SETTINGS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "READ_QUERY_DELAY_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.API_PRIVILEGES.WRITE_QUERY_DELAY_SETTINGS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "WRITE_QUERY_DELAY_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_FLAPPING_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_FLAPPING_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_FLAPPING_SETTINGS.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_FLAPPING_SETTINGS.lookBackWindow",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "lookBackWindow",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_FLAPPING_SETTINGS.statusChangeThreshold",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusChangeThreshold",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_QUERY_DELAY_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_QUERY_DELAY_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_QUERY_DELAY_SETTINGS.delay",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "delay",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_SERVERLESS_QUERY_DELAY_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_SERVERLESS_QUERY_DELAY_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DEFAULT_SERVERLESS_QUERY_DELAY_SETTINGS.delay",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "delay",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DISABLE_FLAPPING_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DISABLE_FLAPPING_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DISABLE_FLAPPING_SETTINGS.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DISABLE_FLAPPING_SETTINGS.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/rules_settings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.DisabledActionTypeIdsForActionGroup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DisabledActionTypeIdsForActionGroup",
|
|
"description": [],
|
|
"signature": [
|
|
"Map<string, string[]>"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/disabled_action_groups.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "EMPTY_EXECUTION_KPI_RESULT",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.success",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "success",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.unknown",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "unknown",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.failure",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "failure",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.warning",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "warning",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.activeAlerts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "activeAlerts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.newAlerts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "newAlerts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.recoveredAlerts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "recoveredAlerts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.erroredActions",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "erroredActions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.EMPTY_EXECUTION_KPI_RESULT.triggeredActions",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "triggeredActions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.executionLogSortableColumns",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionLogSortableColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\", \"num_generated_actions\", \"num_active_alerts\", \"num_recovered_alerts\", \"num_new_alerts\"]"
|
|
],
|
|
"path": "x-pack/plugins/alerting/common/execution_log_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.ISO_WEEKDAYS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ISO_WEEKDAYS",
|
|
"description": [],
|
|
"signature": [
|
|
"readonly [1, 2, 3, 4, 5, 6, 7]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_API_PRIVILEGES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "MAINTENANCE_WINDOW_API_PRIVILEGES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_API_PRIVILEGES.READ_MAINTENANCE_WINDOW",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "READ_MAINTENANCE_WINDOW",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_API_PRIVILEGES.WRITE_MAINTENANCE_WINDOW",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "WRITE_MAINTENANCE_WINDOW",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_DEEP_LINK_IDS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "MAINTENANCE_WINDOW_DEEP_LINK_IDS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_DEEP_LINK_IDS.maintenanceWindows",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "maintenanceWindows",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_DEEP_LINK_IDS.maintenanceWindowsCreate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "maintenanceWindowsCreate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_DEEP_LINK_IDS.maintenanceWindowsEdit",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "maintenanceWindowsEdit",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_PATHS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "MAINTENANCE_WINDOW_PATHS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_PATHS.alerting",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "alerting",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_PATHS.alerting.maintenanceWindows",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "maintenanceWindows",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_PATHS.alerting.maintenanceWindowsCreate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "maintenanceWindowsCreate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.MAINTENANCE_WINDOW_PATHS.alerting.maintenanceWindowsEdit",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "maintenanceWindowsEdit",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/maintenance_window.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RecoveredActionGroup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "RecoveredActionGroup",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly id: \"recovered\"; readonly name: string; readonly severity?: ",
|
|
{
|
|
"pluginId": "@kbn/alerting-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnAlertingTypesPluginApi",
|
|
"section": "def-common.ActionGroupSeverity",
|
|
"text": "ActionGroupSeverity"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"path": "packages/kbn-alerting-types/builtin_action_groups_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleExecutionStatusValues",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "RuleExecutionStatusValues",
|
|
"description": [],
|
|
"signature": [
|
|
"readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\", \"warning\"]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRunOutcomeOrderMap",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "RuleLastRunOutcomeOrderMap",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRunOutcomeOrderMap.succeeded",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "succeeded",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRunOutcomeOrderMap.warning",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "warning",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRunOutcomeOrderMap.failed",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "failed",
|
|
"description": [],
|
|
"path": "x-pack/plugins/alerting/common/rule.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleLastRunOutcomeValues",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "RuleLastRunOutcomeValues",
|
|
"description": [],
|
|
"signature": [
|
|
"readonly [\"succeeded\", \"warning\", \"failed\"]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "alerting",
|
|
"id": "def-common.RuleNotifyWhenTypeValues",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "RuleNotifyWhenTypeValues",
|
|
"description": [],
|
|
"signature": [
|
|
"readonly [\"onActionGroupChange\", \"onActiveAlert\", \"onThrottleInterval\"]"
|
|
],
|
|
"path": "packages/kbn-alerting-types/rule_notify_when_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |