github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/alerting.devdocs.json

7385 lines
No EOL
247 KiB
JSON
Raw Blame History

{
"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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<never>) => string | ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
}
],
"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": "Object",
"tags": [],
"label": "rule",
"description": [
"The rule to view"
],
"signature": [
"{ name: string; params: never; tags: string[]; id: string; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; enabled: boolean; actions: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleAction",
"text": "RuleAction"
},
"[]; throttle: string | null; consumer: string; alertTypeId: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
"; mapped_params?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.MappedParams",
"text": "MappedParams"
},
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleExecutionStatus",
"text": "RuleExecutionStatus"
},
"; snoozeSchedule?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleSnooze",
"text": "RuleSnooze"
},
" | undefined; activeSnoozes?: string[] | undefined; isSnoozedUntil?: Date | null | undefined; lastRun?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleLastRun",
"text": "RuleLastRun"
},
" | null | undefined; nextRun?: Date | null | undefined; }"
],
"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"
],
"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": false,
"trackAdoption": false,
"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": [],
"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": false,
"trackAdoption": false,
"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<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleNavigation",
"text": "RuleNavigation"
},
" | 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": []
}
],
"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, operation, entity }: ",
"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": "{ ruleTypeId, consumer, operation, entity }",
"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",
") => Promise<{ filter?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | 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
}
],
"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"
},
") => Promise<{ filter?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | 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
}
],
"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
}
],
"functions": [
{
"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.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.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
}
],
"interfaces": [
{
"parentPluginId": "alerting",
"id": "def-server.ActionGroup",
"type": "Interface",
"tags": [],
"label": "ActionGroup",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds>"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.ActionGroup.id",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [],
"signature": [
"ActionGroupIds"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.ActionGroup.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_type.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.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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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.BulkEditOptionsFilter",
"type": "Interface",
"tags": [],
"label": "BulkEditOptionsFilter",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkEditOptionsFilter",
"text": "BulkEditOptionsFilter"
},
"<Params>"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptionsFilter.filter",
"type": "CompoundType",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | undefined"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptionsFilter.operations",
"type": "Array",
"tags": [],
"label": "operations",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkEditOperation",
"text": "BulkEditOperation"
},
"[]"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptionsFilter.paramsModifier",
"type": "Function",
"tags": [],
"label": "paramsModifier",
"description": [],
"signature": [
"RuleParamsModifier<Params> | undefined"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptionsIds",
"type": "Interface",
"tags": [],
"label": "BulkEditOptionsIds",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkEditOptionsIds",
"text": "BulkEditOptionsIds"
},
"<Params>"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptionsIds.ids",
"type": "Array",
"tags": [],
"label": "ids",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptionsIds.operations",
"type": "Array",
"tags": [],
"label": "operations",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkEditOperation",
"text": "BulkEditOperation"
},
"[]"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptionsIds.paramsModifier",
"type": "Function",
"tags": [],
"label": "paramsModifier",
"description": [],
"signature": [
"RuleParamsModifier<Params> | undefined"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.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/rules_client.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/rules_client.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/rules_client.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/rules_client.ts",
"deprecated": false,
"trackAdoption": false
}
],
"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/rules_client/rules_client.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/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.FindResult.perPage",
"type": "number",
"tags": [],
"label": "perPage",
"description": [],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.FindResult.total",
"type": "number",
"tags": [],
"label": "total",
"description": [],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.FindResult.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>[]"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.GetSummarizedAlertsFnOpts",
"type": "Interface",
"tags": [],
"label": "GetSummarizedAlertsFnOpts",
"description": [],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.GetSummarizedAlertsFnOpts.start",
"type": "Object",
"tags": [],
"label": "start",
"description": [],
"signature": [
"Date | undefined"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.GetSummarizedAlertsFnOpts.end",
"type": "Object",
"tags": [],
"label": "end",
"description": [],
"signature": [
"Date | undefined"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.GetSummarizedAlertsFnOpts.executionUuid",
"type": "string",
"tags": [],
"label": "executionUuid",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.GetSummarizedAlertsFnOpts.ruleId",
"type": "string",
"tags": [],
"label": "ruleId",
"description": [],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.GetSummarizedAlertsFnOpts.spaceId",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"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.registerType",
"type": "Function",
"tags": [],
"label": "registerType",
"description": [],
"signature": [
"<Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
", ExtractedParams extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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 { [x: string]: unknown; } = { [x: string]: unknown; }, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = never, RecoveryActionGroupId extends string = never>(ruleType: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleType",
"text": "RuleType"
},
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId>) => 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>"
],
"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": []
}
],
"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.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": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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.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>"
],
"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": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<never>, \"name\" | \"tags\" | \"id\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { 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>"
],
"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.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
}
],
"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>"
],
"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": [],
"label": "alertFactory",
"description": [],
"signature": [
"Pick<",
"AlertFactory",
"<State, Context, ActionGroupIds>, \"done\" | \"create\"> & { alertLimit: Pick<{ getValue: () => number; setLimitReached: (reached: boolean) => void; checkLimitUsage: () => void; }, \"getValue\" | \"setLimitReached\">; }"
],
"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": [
"PublicRuleMonitoringService",
" | 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>"
],
"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> | 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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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>>) => Promise<void | 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>"
],
"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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; state?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; params?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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.getSummarizedAlerts",
"type": "Function",
"tags": [],
"label": "getSummarizedAlerts",
"description": [],
"signature": [
"GetSummarizedAlertsFn",
" | undefined"
],
"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.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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<infer groups> ? groups : T extends Readonly<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<infer groups>> ? groups : never"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.AlertingRulesConfig",
"type": "Type",
"tags": [],
"label": "AlertingRulesConfig",
"description": [],
"signature": [
"Pick<Readonly<{} & { 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: Readonly<{} & { value: string; enforce: boolean; }>; }>, \"minimumScheduleInterval\"> & { 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/plugins/alerting/common/alert_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.AlertInstanceState",
"type": "Type",
"tags": [],
"label": "AlertInstanceState",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "x-pack/plugins/alerting/common/alert_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOperation",
"type": "Type",
"tags": [],
"label": "BulkEditOperation",
"description": [],
"signature": [
"{ operation: \"delete\" | \"set\" | \"add\"; field: \"tags\"; value: string[]; } | { operation: \"set\" | \"add\"; field: \"actions\"; value: NormalizedAlertAction[]; } | { operation: \"set\"; field: \"schedule\"; value: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
"; } | { operation: \"set\"; field: \"throttle\"; value: string | null; } | { operation: \"set\"; field: \"notifyWhen\"; value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; } | { operation: \"set\"; field: \"snoozeSchedule\"; value: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleSnoozeSchedule",
"text": "RuleSnoozeSchedule"
},
"; } | { operation: \"delete\"; field: \"snoozeSchedule\"; value?: string[] | undefined; } | { operation: \"set\"; field: \"apiKey\"; value?: undefined; }"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.BulkEditOptions",
"type": "Type",
"tags": [],
"label": "BulkEditOptions",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkEditOptionsFilter",
"text": "BulkEditOptionsFilter"
},
"<Params> | ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkEditOptionsIds",
"text": "BulkEditOptionsIds"
},
"<Params>"
],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.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.PartialRule",
"type": "Type",
"tags": [],
"label": "PartialRule",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Rule",
"text": "Rule"
},
"<Params>, \"id\"> & Partial<Omit<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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": [
"{ getState: () => State; replaceState: (state: State) => ",
"Alert",
"<State, Context, ActionGroupIds>; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ",
"Alert",
"<State, Context, ActionGroupIds>; setContext: (context: Context) => ",
"Alert",
"<State, Context, ActionGroupIds>; getContext: () => Context; hasContext: () => boolean; }"
],
"path": "x-pack/plugins/alerting/server/alert/alert.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": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.RulesClient",
"type": "Type",
"tags": [],
"label": "RulesClient",
"description": [],
"signature": [
"{ get: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>({ id, includeLegacyId, includeSnoozeData, excludeFromPublicApi, }: { id: string; includeLegacyId?: boolean | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params> | ",
"SanitizedRuleWithLegacyId",
"<Params>>; delete: ({ id }: { id: string; }) => Promise<{}>; aggregate: ({ options: { fields, filter, ...options }, }?: { options?: ",
"AggregateOptions",
" | undefined; }) => Promise<",
"AggregateResult",
">; create: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>({ data, options, }: ",
"CreateOptions",
"<Params>) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>>; find: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>({ options: { fields, ...options }, excludeFromPublicApi, includeSnoozeData, }?: { options?: ",
"FindOptions",
" | undefined; excludeFromPublicApi?: boolean | undefined; includeSnoozeData?: boolean | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.FindResult",
"text": "FindResult"
},
"<Params>>; update: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>({ id, data, }: ",
"UpdateOptions",
"<Params>) => Promise<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.PartialRule",
"text": "PartialRule"
},
"<Params>>; resolve: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>({ id, includeLegacyId, includeSnoozeData, }: { id: string; includeLegacyId?: boolean | undefined; includeSnoozeData?: boolean | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ResolvedSanitizedRule",
"text": "ResolvedSanitizedRule"
},
"<Params>>; enable: ({ id }: { id: string; }) => Promise<void>; disable: ({ id }: { id: string; }) => Promise<void>; clone: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(id: string, { newId }: { newId?: string | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>>; muteAll: ({ id }: { id: string; }) => Promise<void>; getAlertState: ({ id }: { id: string; }) => Promise<void | { alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }>; getAlertSummary: ({ id, dateStart, numberOfExecutions, }: ",
"GetAlertSummaryParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.AlertSummary",
"text": "AlertSummary"
},
">; getExecutionLogForRule: ({ id, dateStart, dateEnd, filter, page, perPage, sort, }: ",
"GetExecutionLogByIdParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IExecutionLogResult",
"text": "IExecutionLogResult"
},
">; getGlobalExecutionLogWithAuth: ({ dateStart, dateEnd, filter, page, perPage, sort, namespaces, }: ",
"GetGlobalExecutionLogParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IExecutionLogResult",
"text": "IExecutionLogResult"
},
">; getActionErrorLog: ({ id, dateStart, dateEnd, filter, page, perPage, sort, }: ",
"GetActionErrorLogByIdParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IExecutionErrorsResult",
"text": "IExecutionErrorsResult"
},
">; getActionErrorLogWithAuth: ({ id, dateStart, dateEnd, filter, page, perPage, sort, namespace, }: ",
"GetActionErrorLogByIdParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IExecutionErrorsResult",
"text": "IExecutionErrorsResult"
},
">; getGlobalExecutionKpiWithAuth: ({ dateStart, dateEnd, filter, namespaces, }: ",
"GetGlobalExecutionKPIParams",
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; getRuleExecutionKPI: ({ id, dateStart, dateEnd, filter }: ",
"GetRuleExecutionKPIParams",
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; bulkDeleteRules: (options: ",
"BulkDeleteOptions",
") => Promise<{ errors: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkOperationError",
"text": "BulkOperationError"
},
"[]; total: number; taskIdsFailedToBeDeleted: string[]; }>; bulkEdit: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
">(options: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkEditOptions",
"text": "BulkEditOptions"
},
"<Params>) => Promise<{ rules: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>[]; errors: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.BulkOperationError",
"text": "BulkOperationError"
},
"[]; total: number; }>; updateApiKey: ({ id }: { id: string; }) => Promise<void>; snooze: ({ id, snoozeSchedule, }: { id: string; snoozeSchedule: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleSnoozeSchedule",
"text": "RuleSnoozeSchedule"
},
"; }) => Promise<void>; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise<void>; calculateIsSnoozedUntil: (rule: { muteAll: boolean; snoozeSchedule?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleSnooze",
"text": "RuleSnooze"
},
" | undefined; }) => string | null; clearExpiredSnoozes: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: ",
"MuteOptions",
") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: ",
"MuteOptions",
") => Promise<void>; runSoon: ({ id }: { id: string; }) => Promise<any>; listAlertTypes: () => Promise<Set<",
"RegistryAlertTypeWithAuth",
">>; getSpaceId: () => string | undefined; }"
],
"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": "x-pack/plugins/alerting/common/rule.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
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"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.getBuiltinActionGroups",
"type": "Function",
"tags": [],
"label": "getBuiltinActionGroups",
"description": [],
"signature": [
"(customRecoveryGroup: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<RecoveryActionGroupId> | undefined) => [",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"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.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.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.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.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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds>"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.ActionGroup.id",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [],
"signature": [
"ActionGroupIds"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ActionGroup.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ActionVariable",
"type": "Interface",
"tags": [],
"label": "ActionVariable",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.ActionVariable.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ActionVariable.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ActionVariable.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ActionVariable.useWithTripleBracesInTemplates",
"type": "CompoundType",
"tags": [],
"label": "useWithTripleBracesInTemplates",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertingFrameworkHealth",
"type": "Interface",
"tags": [],
"label": "AlertingFrameworkHealth",
"description": [],
"path": "x-pack/plugins/alerting/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.AlertingFrameworkHealth.isSufficientlySecure",
"type": "boolean",
"tags": [],
"label": "isSufficientlySecure",
"description": [],
"path": "x-pack/plugins/alerting/common/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey",
"type": "boolean",
"tags": [],
"label": "hasPermanentEncryptionKey",
"description": [],
"path": "x-pack/plugins/alerting/common/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertingFrameworkHealth.alertingFrameworkHealth",
"type": "Object",
"tags": [],
"label": "alertingFrameworkHealth",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.AlertsHealth",
"text": "AlertsHealth"
}
],
"path": "x-pack/plugins/alerting/common/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertsHealth",
"type": "Interface",
"tags": [],
"label": "AlertsHealth",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.AlertsHealth.decryptionHealth",
"type": "Object",
"tags": [],
"label": "decryptionHealth",
"description": [],
"signature": [
"{ status: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.HealthStatus",
"text": "HealthStatus"
},
"; timestamp: string; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertsHealth.executionHealth",
"type": "Object",
"tags": [],
"label": "executionHealth",
"description": [],
"signature": [
"{ status: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.HealthStatus",
"text": "HealthStatus"
},
"; timestamp: string; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertsHealth.readHealth",
"type": "Object",
"tags": [],
"label": "readHealth",
"description": [],
"signature": [
"{ status: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.HealthStatus",
"text": "HealthStatus"
},
"; timestamp: string; }"
],
"path": "x-pack/plugins/alerting/common/rule.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.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
}
],
"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"
],
"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
}
],
"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
}
],
"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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
" 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.IntervalSchedule.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.MappedParamsProperties",
"type": "Interface",
"tags": [],
"label": "MappedParamsProperties",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.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": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.MappedParamsProperties.severity",
"type": "string",
"tags": [],
"label": "severity",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord",
"type": "Interface",
"tags": [],
"label": "RRuleRecord",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.dtstart",
"type": "string",
"tags": [],
"label": "dtstart",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.tzid",
"type": "string",
"tags": [],
"label": "tzid",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.freq",
"type": "CompoundType",
"tags": [],
"label": "freq",
"description": [],
"signature": [
"0 | 2 | 1 | 3 | 4 | 5 | 6 | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.until",
"type": "string",
"tags": [],
"label": "until",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.interval",
"type": "number",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.wkst",
"type": "CompoundType",
"tags": [],
"label": "wkst",
"description": [],
"signature": [
"WeekdayStr",
" | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.byweekday",
"type": "Array",
"tags": [],
"label": "byweekday",
"description": [],
"signature": [
"(string | number)[] | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.bymonth",
"type": "Array",
"tags": [],
"label": "bymonth",
"description": [],
"signature": [
"number[] | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.bysetpos",
"type": "Array",
"tags": [],
"label": "bysetpos",
"description": [],
"signature": [
"number[] | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.bymonthday",
"type": "Array",
"tags": [],
"label": "bymonthday",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.byyearday",
"type": "Array",
"tags": [],
"label": "byyearday",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.byweekno",
"type": "Array",
"tags": [],
"label": "byweekno",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.byhour",
"type": "Array",
"tags": [],
"label": "byhour",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.byminute",
"type": "Array",
"tags": [],
"label": "byminute",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RRuleRecord.bysecond",
"type": "Array",
"tags": [],
"label": "bysecond",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule",
"type": "Interface",
"tags": [],
"label": "Rule",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Rule",
"text": "Rule"
},
"<Params>"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.Rule.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.alertTypeId",
"type": "string",
"tags": [],
"label": "alertTypeId",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.consumer",
"type": "string",
"tags": [],
"label": "consumer",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.schedule",
"type": "Object",
"tags": [],
"label": "schedule",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
}
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.actions",
"type": "Array",
"tags": [],
"label": "actions",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleAction",
"text": "RuleAction"
},
"[]"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.params",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"Params"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.mapped_params",
"type": "CompoundType",
"tags": [],
"label": "mapped_params",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.MappedParams",
"text": "MappedParams"
},
" | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.scheduledTaskId",
"type": "string",
"tags": [],
"label": "scheduledTaskId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.createdBy",
"type": "CompoundType",
"tags": [],
"label": "createdBy",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.updatedBy",
"type": "CompoundType",
"tags": [],
"label": "updatedBy",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.createdAt",
"type": "Object",
"tags": [],
"label": "createdAt",
"description": [],
"signature": [
"Date"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.updatedAt",
"type": "Object",
"tags": [],
"label": "updatedAt",
"description": [],
"signature": [
"Date"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.apiKey",
"type": "CompoundType",
"tags": [],
"label": "apiKey",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.apiKeyOwner",
"type": "CompoundType",
"tags": [],
"label": "apiKeyOwner",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.throttle",
"type": "CompoundType",
"tags": [],
"label": "throttle",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.muteAll",
"type": "boolean",
"tags": [],
"label": "muteAll",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.notifyWhen",
"type": "CompoundType",
"tags": [],
"label": "notifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.mutedInstanceIds",
"type": "Array",
"tags": [],
"label": "mutedInstanceIds",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.executionStatus",
"type": "Object",
"tags": [],
"label": "executionStatus",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleExecutionStatus",
"text": "RuleExecutionStatus"
}
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.monitoring",
"type": "Object",
"tags": [],
"label": "monitoring",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.snoozeSchedule",
"type": "Array",
"tags": [],
"label": "snoozeSchedule",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleSnooze",
"text": "RuleSnooze"
},
" | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.activeSnoozes",
"type": "Array",
"tags": [],
"label": "activeSnoozes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.isSnoozedUntil",
"type": "CompoundType",
"tags": [],
"label": "isSnoozedUntil",
"description": [],
"signature": [
"Date | null | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.lastRun",
"type": "CompoundType",
"tags": [],
"label": "lastRun",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleLastRun",
"text": "RuleLastRun"
},
" | null | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Rule.nextRun",
"type": "CompoundType",
"tags": [],
"label": "nextRun",
"description": [],
"signature": [
"Date | null | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAction",
"type": "Interface",
"tags": [],
"label": "RuleAction",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleAction.group",
"type": "string",
"tags": [],
"label": "group",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAction.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAction.actionTypeId",
"type": "string",
"tags": [],
"label": "actionTypeId",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.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": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAggregations",
"type": "Interface",
"tags": [],
"label": "RuleAggregations",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleAggregations.alertExecutionStatus",
"type": "Object",
"tags": [],
"label": "alertExecutionStatus",
"description": [],
"signature": [
"{ [status: string]: number; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAggregations.ruleLastRunOutcome",
"type": "Object",
"tags": [],
"label": "ruleLastRunOutcome",
"description": [],
"signature": [
"{ [status: string]: number; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAggregations.ruleEnabledStatus",
"type": "Object",
"tags": [],
"label": "ruleEnabledStatus",
"description": [],
"signature": [
"{ enabled: number; disabled: number; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAggregations.ruleMutedStatus",
"type": "Object",
"tags": [],
"label": "ruleMutedStatus",
"description": [],
"signature": [
"{ muted: number; unmuted: number; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAggregations.ruleSnoozedStatus",
"type": "Object",
"tags": [],
"label": "ruleSnoozedStatus",
"description": [],
"signature": [
"{ snoozed: number; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleAggregations.ruleTags",
"type": "Array",
"tags": [],
"label": "ruleTags",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus",
"type": "Interface",
"tags": [],
"label": "RuleExecutionStatus",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.lastExecutionDate",
"type": "Object",
"tags": [],
"label": "lastExecutionDate",
"description": [],
"signature": [
"Date"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.lastDuration",
"type": "number",
"tags": [],
"label": "lastDuration",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.error",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"{ reason: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleExecutionStatusErrorReasons",
"text": "RuleExecutionStatusErrorReasons"
},
"; message: string; } | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatus.warning",
"type": "Object",
"tags": [],
"label": "warning",
"description": [],
"signature": [
"{ reason: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleExecutionStatusWarningReasons",
"text": "RuleExecutionStatusWarningReasons"
},
"; message: string; } | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleLastRun",
"type": "Interface",
"tags": [],
"label": "RuleLastRun",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleLastRun.outcome",
"type": "CompoundType",
"tags": [],
"label": "outcome",
"description": [],
"signature": [
"\"warning\" | \"succeeded\" | \"failed\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleLastRun.warning",
"type": "CompoundType",
"tags": [],
"label": "warning",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleExecutionStatusErrorReasons",
"text": "RuleExecutionStatusErrorReasons"
},
" | ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleExecutionStatusWarningReasons",
"text": "RuleExecutionStatusWarningReasons"
},
" | null | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleLastRun.outcomeMsg",
"type": "CompoundType",
"tags": [],
"label": "outcomeMsg",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.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": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoring",
"type": "Interface",
"tags": [],
"label": "RuleMonitoring",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoring.run",
"type": "Object",
"tags": [],
"label": "run",
"description": [],
"signature": [
"{ history: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoringHistory",
"text": "RuleMonitoringHistory"
},
"[]; calculated_metrics: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoringCalculatedMetrics",
"text": "RuleMonitoringCalculatedMetrics"
},
"; last_run: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoringLastRun",
"text": "RuleMonitoringLastRun"
},
"; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringCalculatedMetrics",
"type": "Interface",
"tags": [],
"label": "RuleMonitoringCalculatedMetrics",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoringCalculatedMetrics",
"text": "RuleMonitoringCalculatedMetrics"
},
" 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.RuleMonitoringCalculatedMetrics.p50",
"type": "number",
"tags": [],
"label": "p50",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringCalculatedMetrics.p95",
"type": "number",
"tags": [],
"label": "p95",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringCalculatedMetrics.p99",
"type": "number",
"tags": [],
"label": "p99",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringCalculatedMetrics.success_ratio",
"type": "number",
"tags": [],
"label": "success_ratio",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringHistory",
"type": "Interface",
"tags": [],
"label": "RuleMonitoringHistory",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoringHistory",
"text": "RuleMonitoringHistory"
},
" 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.RuleMonitoringHistory.success",
"type": "boolean",
"tags": [],
"label": "success",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringHistory.timestamp",
"type": "number",
"tags": [],
"label": "timestamp",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringHistory.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.RuleMonitoringHistory.outcome",
"type": "CompoundType",
"tags": [],
"label": "outcome",
"description": [],
"signature": [
"\"warning\" | \"succeeded\" | \"failed\" | undefined"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringLastRun",
"type": "Interface",
"tags": [],
"label": "RuleMonitoringLastRun",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoringLastRun",
"text": "RuleMonitoringLastRun"
},
" 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.RuleMonitoringLastRun.timestamp",
"type": "string",
"tags": [],
"label": "timestamp",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringLastRun.metrics",
"type": "Object",
"tags": [],
"label": "metrics",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoringLastRunMetrics",
"text": "RuleMonitoringLastRunMetrics"
}
],
"path": "x-pack/plugins/alerting/common/rule.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": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleSnoozeSchedule.duration",
"type": "number",
"tags": [],
"label": "duration",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleSnoozeSchedule.rRule",
"type": "CompoundType",
"tags": [],
"label": "rRule",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RRuleRecord",
"text": "RRuleRecord"
},
"> & Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RRuleRecord",
"text": "RRuleRecord"
},
", \"dtstart\" | \"tzid\">"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleSnoozeSchedule.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleSnoozeSchedule.skipRecurrences",
"type": "Array",
"tags": [],
"label": "skipRecurrences",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleStateNavigation",
"type": "Interface",
"tags": [],
"label": "RuleStateNavigation",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_navigation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleStateNavigation.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
}
],
"path": "x-pack/plugins/alerting/common/rule_navigation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType",
"type": "Interface",
"tags": [],
"label": "RuleType",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleType",
"text": "RuleType"
},
"<ActionGroupIds, RecoveryActionGroupId>"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.actionGroups",
"type": "Array",
"tags": [],
"label": "actionGroups",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds>[]"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.recoveryActionGroup",
"type": "Object",
"tags": [],
"label": "recoveryActionGroup",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<RecoveryActionGroupId>"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.actionVariables",
"type": "Object",
"tags": [],
"label": "actionVariables",
"description": [],
"signature": [
"{ context: ActionVariable[]; state: ActionVariable[]; params: ActionVariable[]; }"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.defaultActionGroupId",
"type": "Uncategorized",
"tags": [],
"label": "defaultActionGroupId",
"description": [],
"signature": [
"ActionGroupIds"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.producer",
"type": "string",
"tags": [],
"label": "producer",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_type.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": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.isExportable",
"type": "boolean",
"tags": [],
"label": "isExportable",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.ruleTaskTimeout",
"type": "string",
"tags": [],
"label": "ruleTaskTimeout",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.defaultScheduleInterval",
"type": "string",
"tags": [],
"label": "defaultScheduleInterval",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.doesSetRecoveryContext",
"type": "CompoundType",
"tags": [],
"label": "doesSetRecoveryContext",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.enabledInLicense",
"type": "boolean",
"tags": [],
"label": "enabledInLicense",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleType.authorizedConsumers",
"type": "Object",
"tags": [],
"label": "authorizedConsumers",
"description": [],
"signature": [
"{ [x: string]: ConsumerPrivileges; }"
],
"path": "x-pack/plugins/alerting/common/rule_type.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleUrlNavigation",
"type": "Interface",
"tags": [],
"label": "RuleUrlNavigation",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_navigation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.RuleUrlNavigation.path",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_navigation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "alerting",
"id": "def-common.ActionsCompletion",
"type": "Enum",
"tags": [],
"label": "ActionsCompletion",
"description": [],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.HealthStatus",
"type": "Enum",
"tags": [],
"label": "HealthStatus",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatusErrorReasons",
"type": "Enum",
"tags": [],
"label": "RuleExecutionStatusErrorReasons",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleExecutionStatusWarningReasons",
"type": "Enum",
"tags": [],
"label": "RuleExecutionStatusWarningReasons",
"description": [],
"path": "x-pack/plugins/alerting/common/rule.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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<infer groups> ? groups : T extends Readonly<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<infer groups>> ? groups : never"
],
"path": "x-pack/plugins/alerting/common/rule_type.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/plugins/alerting/common/alert_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertInstanceMeta",
"type": "Type",
"tags": [],
"label": "AlertInstanceMeta",
"description": [],
"signature": [
"{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }"
],
"path": "x-pack/plugins/alerting/common/alert_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.AlertInstanceState",
"type": "Type",
"tags": [],
"label": "AlertInstanceState",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "x-pack/plugins/alerting/common/alert_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ALERTS_FEATURE_ID",
"type": "string",
"tags": [],
"label": "ALERTS_FEATURE_ID",
"description": [],
"signature": [
"\"alerts\""
],
"path": "x-pack/plugins/alerting/common/index.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.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.DefaultActionGroupId",
"type": "Type",
"tags": [],
"label": "DefaultActionGroupId",
"description": [],
"signature": [
"\"default\""
],
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ExecutionLogSortFields",
"type": "Type",
"tags": [],
"label": "ExecutionLogSortFields",
"description": [],
"signature": [
"\"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.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_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.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.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": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.MappedParamsProperties",
"text": "MappedParamsProperties"
}
],
"path": "x-pack/plugins/alerting/common/rule.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.RawAlertInstance",
"type": "Type",
"tags": [],
"label": "RawAlertInstance",
"description": [],
"signature": [
"{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }"
],
"path": "x-pack/plugins/alerting/common/alert_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RecoveredActionGroupId",
"type": "Type",
"tags": [],
"label": "RecoveredActionGroupId",
"description": [],
"signature": [
"\"recovered\""
],
"path": "x-pack/plugins/alerting/common/builtin_action_groups.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": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params> & Omit<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<unknown>, \"saved_object\">"
],
"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": "x-pack/plugins/alerting/common/rule.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": "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": [
"\"warning\" | \"success\" | \"unknown\" | \"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": [
"\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleLastRunOutcomes",
"type": "Type",
"tags": [],
"label": "RuleLastRunOutcomes",
"description": [],
"signature": [
"\"warning\" | \"succeeded\" | \"failed\""
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleNavigation",
"type": "Type",
"tags": [],
"label": "RuleNavigation",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleUrlNavigation",
"text": "RuleUrlNavigation"
},
" | ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleStateNavigation",
"text": "RuleStateNavigation"
}
],
"path": "x-pack/plugins/alerting/common/rule_navigation.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleNotifyWhenType",
"type": "Type",
"tags": [],
"label": "RuleNotifyWhenType",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
],
"path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleSnooze",
"type": "Type",
"tags": [],
"label": "RuleSnooze",
"description": [],
"signature": [
"{ duration: number; rRule: SnoozeRRule; id?: string | undefined; skipRecurrences?: string[] | undefined; }[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.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.RuleTaskParams",
"type": "Type",
"tags": [],
"label": "RuleTaskParams",
"description": [],
"signature": [
"{ alertId: string; } & { spaceId?: string | undefined; }"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleTaskState",
"type": "Type",
"tags": [],
"label": "RuleTaskState",
"description": [],
"signature": [
"{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleTypeParams",
"type": "Type",
"tags": [],
"label": "RuleTypeParams",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "x-pack/plugins/alerting/common/rule.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": [
"{ name: string; params: Params; tags: string[]; id: string; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; enabled: boolean; actions: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleAction",
"text": "RuleAction"
},
"[]; throttle: string | null; consumer: string; alertTypeId: string; schedule: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
},
"; mapped_params?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.MappedParams",
"text": "MappedParams"
},
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleExecutionStatus",
"text": "RuleExecutionStatus"
},
"; snoozeSchedule?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleSnooze",
"text": "RuleSnooze"
},
" | undefined; activeSnoozes?: string[] | undefined; isSnoozedUntil?: Date | null | undefined; lastRun?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleLastRun",
"text": "RuleLastRun"
},
" | null | undefined; nextRun?: Date | null | undefined; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.SanitizedRuleConfig",
"type": "Type",
"tags": [],
"label": "SanitizedRuleConfig",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<never>, \"name\" | \"tags\" | \"id\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { 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.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
}
],
"objects": [
{
"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.rawAlertInstance",
"type": "Object",
"tags": [],
"label": "rawAlertInstance",
"description": [],
"signature": [
"PartialC",
"<{ state: ",
"RecordC",
"<",
"StringC",
", ",
"UnknownC",
">; meta: ",
"PartialC",
"<{ lastScheduledActions: ",
"IntersectionC",
"<[",
"PartialC",
"<{ subgroup: ",
"StringC",
"; }>, ",
"TypeC",
"<{ group: ",
"StringC",
"; date: ",
"Type",
"<Date, string, unknown>; }>]>; }>; }>"
],
"path": "x-pack/plugins/alerting/common/alert_instance.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; }"
],
"path": "x-pack/plugins/alerting/common/builtin_action_groups.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": "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": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ruleParamsSchema",
"type": "Object",
"tags": [],
"label": "ruleParamsSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ alertId: ",
"StringC",
"; }>, ",
"PartialC",
"<{ spaceId: ",
"StringC",
"; }>]>"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.ruleStateSchema",
"type": "Object",
"tags": [],
"label": "ruleStateSchema",
"description": [],
"signature": [
"PartialC",
"<{ alertTypeState: ",
"RecordC",
"<",
"StringC",
", ",
"UnknownC",
">; alertInstances: ",
"RecordC",
"<",
"StringC",
", ",
"PartialC",
"<{ state: ",
"RecordC",
"<",
"StringC",
", ",
"UnknownC",
">; meta: ",
"PartialC",
"<{ lastScheduledActions: ",
"IntersectionC",
"<[",
"PartialC",
"<{ subgroup: ",
"StringC",
"; }>, ",
"TypeC",
"<{ group: ",
"StringC",
"; date: ",
"Type",
"<Date, string, unknown>; }>]>; }>; }>>; previousStartedAt: ",
"UnionC",
"<[",
"NullC",
", ",
"Type",
"<Date, string, unknown>]>; }>"
],
"path": "x-pack/plugins/alerting/common/rule_task_instance.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink