2021-03-04 02:12:24 +01:00
{
2021-03-06 03:38:33 +01:00
"id" : "alerting" ,
2021-03-04 02:12:24 +01:00
"client" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
2021-06-14 23:51:30 +02:00
"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" : [
"(alert: Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
2021-08-30 17:02:04 +02:00
"<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/utility-types" ,
"scope" : "server" ,
"docId" : "kibKbnUtilityTypesPluginApi" ,
"section" : "def-server.JsonObject" ,
"text" : "JsonObject"
}
2021-06-14 23:51:30 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts" ,
2021-06-14 23:51:30 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"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" ,
2021-09-14 16:44:20 +02:00
"id" : "def-public.AlertNavigationHandler.$1" ,
2021-08-09 18:51:00 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "alert" ,
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"{ enabled: boolean; id: string; name: string; tags: string[]; params: never; actions: " ,
2021-08-09 18:51:00 +02:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertAction" ,
"text" : "AlertAction"
} ,
2021-08-30 17:02:04 +02:00
"[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: " ,
2021-08-09 18:51:00 +02:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.IntervalSchedule" ,
"text" : "IntervalSchedule"
} ,
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertExecutionStatus" ,
"text" : "AlertExecutionStatus"
} ,
"; }"
] ,
"path" : "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts" ,
"deprecated" : false
}
] ,
2021-06-14 23:51:30 +02:00
"initialIsOpen" : false
}
] ,
2021-03-04 02:12:24 +01:00
"objects" : [ ] ,
"setup" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.PluginSetupContract" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "PluginSetupContract" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.PluginSetupContract.registerNavigation" ,
"type" : "Function" ,
2021-06-14 23:51:30 +02:00
"tags" : [
"throws"
] ,
2021-03-04 02:12:24 +01:00
"label" : "registerNavigation" ,
2021-06-14 23:51:30 +02:00
"description" : [
2021-06-30 19:04:59 +02:00
"\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"
2021-06-14 23:51:30 +02:00
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-06-14 23:51:30 +02:00
"(applicationId: string, ruleType: string, handler: " ,
{
"pluginId" : "alerting" ,
"scope" : "public" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-public.AlertNavigationHandler" ,
"text" : "AlertNavigationHandler"
} ,
2021-03-04 02:12:24 +01:00
") => void"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.PluginSetupContract.registerNavigation.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
2021-06-14 23:51:30 +02:00
"label" : "applicationId" ,
"description" : [
"The application id that the user should be navigated to, to view a particular alert in a custom way."
] ,
2021-08-09 18:51:00 +02:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
} ,
{
"parentPluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.PluginSetupContract.registerNavigation.$2" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
2021-06-14 23:51:30 +02:00
"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."
] ,
2021-08-09 18:51:00 +02:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
} ,
{
"parentPluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.PluginSetupContract.registerNavigation.$3" ,
2021-05-20 22:11:31 +02:00
"type" : "Function" ,
"tags" : [ ] ,
"label" : "handler" ,
2021-06-14 23:51:30 +02:00
"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."
] ,
2021-05-20 22:11:31 +02:00
"signature" : [
{
"pluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"scope" : "public" ,
2021-05-20 22:11:31 +02:00
"docId" : "kibAlertingPluginApi" ,
2021-08-09 18:51:00 +02:00
"section" : "def-public.AlertNavigationHandler" ,
"text" : "AlertNavigationHandler"
}
2021-05-20 22:11:31 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
}
2021-08-09 18:51:00 +02:00
] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.PluginSetupContract.registerDefaultNavigation" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "registerDefaultNavigation" ,
2021-06-14 23:51:30 +02:00
"description" : [
2021-06-30 19:04:59 +02:00
"\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"
2021-06-14 23:51:30 +02:00
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-06-14 23:51:30 +02:00
"(applicationId: string, handler: " ,
{
"pluginId" : "alerting" ,
"scope" : "public" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-public.AlertNavigationHandler" ,
"text" : "AlertNavigationHandler"
} ,
2021-03-04 02:12:24 +01:00
") => void"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.PluginSetupContract.registerDefaultNavigation.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
2021-06-14 23:51:30 +02:00
"label" : "applicationId" ,
"description" : [
"The application id that the user should be navigated to, to view a particular alert in a custom way."
] ,
2021-08-09 18:51:00 +02:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
} ,
{
"parentPluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.PluginSetupContract.registerDefaultNavigation.$2" ,
2021-05-20 22:11:31 +02:00
"type" : "Function" ,
"tags" : [ ] ,
"label" : "handler" ,
2021-06-14 23:51:30 +02:00
"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."
] ,
2021-05-20 22:11:31 +02:00
"signature" : [
{
"pluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"scope" : "public" ,
2021-05-20 22:11:31 +02:00
"docId" : "kibAlertingPluginApi" ,
2021-08-09 18:51:00 +02:00
"section" : "def-public.AlertNavigationHandler" ,
"text" : "AlertNavigationHandler"
}
2021-05-20 22:11:31 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
}
2021-08-09 18:51:00 +02:00
] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.PluginStartContract" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "PluginStartContract" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.PluginStartContract.getNavigation" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getNavigation" ,
"description" : [ ] ,
"signature" : [
"(alertId: string) => Promise<" ,
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.AlertUrlNavigation" ,
"text" : "AlertUrlNavigation"
} ,
" | " ,
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.AlertStateNavigation" ,
"text" : "AlertStateNavigation"
} ,
" | undefined>"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.PluginStartContract.getNavigation.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
"label" : "alertId" ,
"description" : [ ] ,
2021-08-09 18:51:00 +02:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/public/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
}
2021-08-09 18:51:00 +02:00
] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
2021-08-02 22:44:47 +02:00
"classes" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "AlertingAuthorization" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization.Unnamed" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "Constructor" ,
"description" : [ ] ,
"signature" : [
"any"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization.Unnamed.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n auditLogger,\n getSpace,\n getSpaceId,\n }" ,
2021-08-02 22:44:47 +02:00
"description" : [ ] ,
"signature" : [
"ConstructorOptions"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization.getSpaceId" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getSpaceId" ,
"description" : [ ] ,
"signature" : [
"() => string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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" ,
">; }>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "featureIds" ,
"description" : [ ] ,
"signature" : [
"readonly string[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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"
} ,
")[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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"
}
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization.ensureAuthorized.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{ ruleTypeId, consumer, operation, entity }" ,
"description" : [ ] ,
"signature" : [
"EnsureAuthorizedOpts"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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?: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/es-query" ,
"scope" : "common" ,
"docId" : "kibKbnEsQueryPluginApi" ,
"section" : "def-common.KueryNode" ,
"text" : "KueryNode"
} ,
2021-08-02 22:44:47 +02:00
" | " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/utility-types" ,
"scope" : "server" ,
"docId" : "kibKbnUtilityTypesPluginApi" ,
"section" : "def-server.JsonObject" ,
"text" : "JsonObject"
} ,
2021-08-02 22:44:47 +02:00
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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"
}
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization.getFindAuthorizationFilter.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "filterOpts" ,
"description" : [ ] ,
"signature" : [
"AlertingAuthorizationFilterOpts"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
2021-08-30 17:02:04 +02:00
{
"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?: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/es-query" ,
"scope" : "common" ,
"docId" : "kibKbnEsQueryPluginApi" ,
"section" : "def-common.KueryNode" ,
"text" : "KueryNode"
} ,
2021-08-30 17:02:04 +02:00
" | " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/utility-types" ,
"scope" : "server" ,
"docId" : "kibKbnUtilityTypesPluginApi" ,
"section" : "def-server.JsonObject" ,
"text" : "JsonObject"
} ,
2021-08-30 17:02:04 +02:00
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
] ,
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
"deprecated" : 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 ,
"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 ,
"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 ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
2021-08-02 22:44:47 +02:00
{
"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" ,
">>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorization.filterByRuleTypeAuthorization.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "ruleTypes" ,
"description" : [ ] ,
"signature" : [
"Set<" ,
"RegistryRuleType" ,
">"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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"
} ,
")[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : 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"
}
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
}
] ,
2021-03-04 02:12:24 +01:00
"functions" : [
2021-04-15 22:47:21 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.getEsErrorMessage" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
"label" : "getEsErrorMessage" ,
"description" : [ ] ,
"signature" : [
"(error: " ,
"ElasticsearchError" ,
") => string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-15 22:47:21 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.getEsErrorMessage.$1" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-15 22:47:21 +02:00
"label" : "error" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-04-15 22:47:21 +02:00
"signature" : [
"ElasticsearchError"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-04-15 22:47:21 +02:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.parseDuration" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "parseDuration" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(duration: string) => number"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.parseDuration.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "duration" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
2021-03-06 16:05:27 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.ActionGroup" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "ActionGroup" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<ActionGroupIds>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.ActionGroup.id" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "id" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"ActionGroupIds"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.ActionGroup.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "name" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertExecutorOptions" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-server.AlertExecutorOptions" ,
"text" : "AlertExecutorOptions"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.alertId" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "alertId" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.startedAt" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "startedAt" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Date"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.previousStartedAt" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "previousStartedAt" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Date | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.services" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "services" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-server.AlertServices" ,
"text" : "AlertServices"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<InstanceState, InstanceContext, ActionGroupIds>"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.params" ,
2021-03-04 02:12:24 +01:00
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "params" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Params"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.state" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "state" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"State"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-24 18:19:21 +02:00
"deprecated" : false
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertExecutorOptions.rule" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "rule" ,
"description" : [ ] ,
"signature" : [
2021-05-31 19:33:12 +02:00
"Pick<Pick<" ,
2021-05-24 18:19:21 +02:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
2021-05-31 19:33:12 +02:00
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
2021-08-30 17:02:04 +02:00
"<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"tags\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
2021-05-24 18:19:21 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.spaceId" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "spaceId" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.namespace" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "namespace" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.name" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "name" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.tags" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "tags" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.createdBy" ,
2021-03-04 02:12:24 +01:00
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "createdBy" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertExecutorOptions.updatedBy" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "updatedBy" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertingApiRequestHandlerContext" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertingApiRequestHandlerContext" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-07-22 22:47:56 +02:00
"id" : "def-server.AlertingApiRequestHandlerContext.getRulesClient" ,
2021-03-06 16:05:27 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-07-22 22:47:56 +02:00
"label" : "getRulesClient" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
"() => " ,
2021-03-04 02:12:24 +01:00
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-07-22 22:47:56 +02:00
"section" : "def-server.RulesClient" ,
"text" : "RulesClient"
2021-03-04 02:12:24 +01:00
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertingApiRequestHandlerContext.listTypes" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "listTypes" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
"() => Set<" ,
2021-07-28 19:19:08 +02:00
"RegistryRuleType" ,
2021-03-06 16:05:27 +01:00
">"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [ ]
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertingApiRequestHandlerContext.getFrameworkHealth" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "getFrameworkHealth" ,
"description" : [ ] ,
"signature" : [
"() => Promise<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertsHealth" ,
"text" : "AlertsHealth"
} ,
">"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-05-06 21:08:20 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-05-06 21:08:20 +02:00
"id" : "def-server.AlertingApiRequestHandlerContext.areApiKeysEnabled" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-06 21:08:20 +02:00
"label" : "areApiKeysEnabled" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"() => Promise<boolean>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertingPlugin" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertingPlugin" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertingPlugin.setup" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "setup" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.PluginSetupContract" ,
"text" : "PluginSetupContract"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertingPlugin.start" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "start" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-server.PluginStartContract" ,
"text" : "PluginStartContract"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.AlertServices" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "AlertServices" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-server.AlertServices" ,
"text" : "AlertServices"
} ,
"<InstanceState, InstanceContext, ActionGroupIds> extends " ,
"Services"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.AlertServices.alertInstanceFactory" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "alertInstanceFactory" ,
"description" : [ ] ,
"signature" : [
"(id: string) => Pick<" ,
2021-04-15 22:47:21 +02:00
"AlertInstance" ,
2021-03-04 02:12:24 +01:00
"<InstanceState, InstanceContext, ActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
2021-08-09 18:51:00 +02:00
"id" : "def-server.AlertServices.alertInstanceFactory.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
"label" : "id" ,
"description" : [ ] ,
2021-08-09 18:51:00 +02:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
}
2021-08-09 18:51:00 +02:00
] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertType" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertType" ,
"text" : "AlertType"
} ,
2021-08-02 22:44:47 +02:00
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId>"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.id" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "id" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "name" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.validate" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "validate" ,
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"{ params?: " ,
2021-04-15 22:47:21 +02:00
"AlertTypeParamsValidator" ,
2021-03-06 16:05:27 +01:00
"<Params> | undefined; } | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.actionGroups" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionGroups" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<ActionGroupIds>[]"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.defaultActionGroupId" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "defaultActionGroupId" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"ActionGroupIds"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.recoveryActionGroup" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "recoveryActionGroup" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<RecoveryActionGroupId> | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.executor" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "executor" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-05-20 22:11:31 +02:00
"(options: " ,
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertExecutorOptions" ,
"text" : "AlertExecutorOptions"
} ,
2021-03-06 16:05:27 +01:00
"<Params, State, InstanceState, InstanceContext, " ,
2021-03-04 02:12:24 +01:00
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.WithoutReservedActionGroups" ,
"text" : "WithoutReservedActionGroups"
2021-03-04 02:12:24 +01:00
} ,
2021-05-20 22:11:31 +02:00
"<ActionGroupIds, RecoveryActionGroupId>>) => Promise<void | State>"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "alerting" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertType.executor.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "options" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertExecutorOptions" ,
"text" : "AlertExecutorOptions"
} ,
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false
}
]
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.producer" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "producer" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.actionVariables" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionVariables" ,
"description" : [ ] ,
"signature" : [
"{ context?: " ,
{
"pluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"scope" : "common" ,
2021-03-06 16:05:27 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-09 16:02:55 +01:00
"section" : "def-common.ActionVariable" ,
2021-03-06 16:05:27 +01:00
"text" : "ActionVariable"
} ,
"[] | undefined; state?: " ,
{
"pluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"scope" : "common" ,
2021-03-06 16:05:27 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-09 16:02:55 +01:00
"section" : "def-common.ActionVariable" ,
2021-03-06 16:05:27 +01:00
"text" : "ActionVariable"
} ,
"[] | undefined; params?: " ,
{
"pluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"scope" : "common" ,
2021-03-06 16:05:27 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-09 16:02:55 +01:00
"section" : "def-common.ActionVariable" ,
2021-03-06 16:05:27 +01:00
"text" : "ActionVariable"
} ,
"[] | undefined; } | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertType.minimumLicenseRequired" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "minimumLicenseRequired" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertType.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: " ,
"SavedObjectReference" ,
"[]) => Params; } | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-06-30 19:04:59 +02:00
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertType.isExportable" ,
"type" : "boolean" ,
"tags" : [ ] ,
"label" : "isExportable" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-06-30 19:04:59 +02:00
"deprecated" : false
2021-10-11 19:58:18 +02:00
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertType.ruleTaskTimeout" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "ruleTaskTimeout" ,
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
"path" : "x-pack/plugins/alerting/server/types.ts" ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.FindResult" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "FindResult" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.FindResult" ,
"text" : "FindResult"
} ,
"<Params>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/rules_client/rules_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.FindResult.page" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "page" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/rules_client/rules_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.FindResult.perPage" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "perPage" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/rules_client/rules_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.FindResult.total" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "total" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/rules_client/rules_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.FindResult.data" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "data" ,
"description" : [ ] ,
"signature" : [
"Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
2021-08-30 17:02:04 +02:00
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/rules_client/rules_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.PluginSetupContract" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "PluginSetupContract" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.PluginSetupContract.registerType" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "registerType" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-08-02 22:44:47 +02:00
"<Params extends Record<string, unknown> = Record<string, unknown>, ExtractedParams extends Record<string, unknown> = Record<string, unknown>, State extends Record<string, unknown> = Record<string, unknown>, InstanceState extends { [x: string]: unknown; } = { [x: string]: unknown; }, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = never, RecoveryActionGroupId extends string = never>(alertType: " ,
2021-03-04 02:12:24 +01:00
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-server.AlertType" ,
"text" : "AlertType"
} ,
2021-08-02 22:44:47 +02:00
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId>) => void"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.PluginSetupContract.registerType.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "alertType" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-server.AlertType" ,
"text" : "AlertType"
} ,
2021-08-02 22:44:47 +02:00
"<Params, ExtractedParams, State, InstanceState, InstanceContext, ActionGroupIds, RecoveryActionGroupId>"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.PluginStartContract" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "PluginStartContract" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.PluginStartContract.listTypes" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "listTypes" ,
"description" : [ ] ,
"signature" : [
"() => Set<" ,
2021-07-28 19:19:08 +02:00
"RegistryRuleType" ,
2021-03-04 02:12:24 +01:00
">"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-07-22 22:47:56 +02:00
"id" : "def-server.PluginStartContract.getRulesClientWithRequest" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-07-22 22:47:56 +02:00
"label" : "getRulesClientWithRequest" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => Pick<" ,
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "server" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-07-22 22:47:56 +02:00
"section" : "def-server.RulesClient" ,
"text" : "RulesClient"
2021-03-04 02:12:24 +01:00
} ,
2021-08-30 17:02:04 +02:00
", \"get\" | \"delete\" | \"create\" | \"find\" | \"resolve\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\" | \"getSpaceId\">"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-07-22 22:47:56 +02:00
"id" : "def-server.PluginStartContract.getRulesClientWithRequest.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "request" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.PluginStartContract.getAlertingAuthorizationWithRequest" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getAlertingAuthorizationWithRequest" ,
"description" : [ ] ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => Pick<" ,
2021-08-02 22:44:47 +02:00
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertingAuthorization" ,
"text" : "AlertingAuthorization"
} ,
2021-08-30 17:02:04 +02:00
", \"ensureAuthorized\" | \"getSpaceId\" | \"getAugmentedRuleTypesWithAuthorization\" | \"getFindAuthorizationFilter\" | \"getAuthorizationFilter\" | \"filterByRuleTypeAuthorization\">"
2021-05-20 22:11:31 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.PluginStartContract.getAlertingAuthorizationWithRequest.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "request" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.PluginStartContract.getFrameworkHealth" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getFrameworkHealth" ,
"description" : [ ] ,
"signature" : [
"() => Promise<" ,
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.AlertsHealth" ,
"text" : "AlertsHealth"
} ,
">"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
2021-08-02 22:44:47 +02:00
} ,
{
"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>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.RuleParamsAndRefs.references" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "references" ,
"description" : [ ] ,
"signature" : [
"SavedObjectReference" ,
"[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.RuleParamsAndRefs.params" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [ ] ,
"signature" : [
"Params"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorizationEntity" ,
"type" : "Enum" ,
"tags" : [ ] ,
"label" : "AlertingAuthorizationEntity" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.AlertingAuthorizationFilterType" ,
"type" : "Enum" ,
"tags" : [ ] ,
"label" : "AlertingAuthorizationFilterType" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization_kuery.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.ReadOperations" ,
"type" : "Enum" ,
"tags" : [ ] ,
"label" : "ReadOperations" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.WriteOperations" ,
"type" : "Enum" ,
"tags" : [ ] ,
"label" : "WriteOperations" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"initialIsOpen" : false
2021-03-06 16:05:27 +01:00
}
] ,
"misc" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.ActionGroupIdsOf" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "ActionGroupIdsOf" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"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"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertActionParams" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertActionParams" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"SavedObjectAttributes"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertInstanceContext" ,
"type" : "Type" ,
2021-03-04 02:12:24 +01:00
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertInstanceContext" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
"signature" : [
"{ [x: string]: unknown; }"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.AlertInstanceState" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertInstanceState" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ [x: string]: unknown; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
2021-03-06 16:05:27 +01:00
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-08-02 22:44:47 +02:00
"id" : "def-server.AlertTypeParams" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-08-02 22:44:47 +02:00
"label" : "AlertTypeParams" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-08-02 22:44:47 +02:00
"{ [x: string]: unknown; }"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-08-02 22:44:47 +02:00
"id" : "def-server.AlertTypeState" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-08-02 22:44:47 +02:00
"label" : "AlertTypeState" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ [x: string]: unknown; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-08-02 22:44:47 +02:00
"id" : "def-server.DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT" ,
"type" : "number" ,
2021-03-04 02:12:24 +01:00
"tags" : [ ] ,
2021-08-02 22:44:47 +02:00
"label" : "DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-08-02 22:44:47 +02:00
"10"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/config.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.PartialAlert" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "PartialAlert" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
"<Params>, \"id\"> & Partial<Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
2021-08-30 17:02:04 +02:00
"<Params>, \"enabled\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.PublicAlertInstance" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "PublicAlertInstance" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"{ getState: () => State; replaceState: (state: State) => " ,
"AlertInstance" ,
"<State, Context, ActionGroupIds>; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => " ,
"AlertInstance" ,
"<State, Context, ActionGroupIds>; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => " ,
"AlertInstance" ,
"<State, Context, ActionGroupIds>; }"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
2021-08-02 22:44:47 +02:00
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-server.RulesClient" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "RulesClient" ,
"description" : [ ] ,
"signature" : [
"{ get: <Params extends Record<string, unknown> = never>({ id, }: { id: string; }) => Promise<Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
2021-08-30 17:02:04 +02:00
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: <Params extends Record<string, unknown> = never>({ data, options, }: " ,
2021-08-02 22:44:47 +02:00
"CreateOptions" ,
"<Params>) => Promise<Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
2021-08-30 17:02:04 +02:00
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: <Params extends Record<string, unknown> = never>({ options: { fields, ...options }, }?: { options?: " ,
2021-08-02 22:44:47 +02:00
"FindOptions" ,
" | undefined; }) => Promise<" ,
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.FindResult" ,
"text" : "FindResult"
} ,
2021-08-30 17:02:04 +02:00
"<Params>>; resolve: <Params extends Record<string, unknown> = never>({ id, }: { id: string; }) => Promise<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ResolvedSanitizedRule" ,
"text" : "ResolvedSanitizedRule"
} ,
2021-08-02 22:44:47 +02:00
"<Params>>; update: <Params extends Record<string, unknown> = never>({ id, data, }: " ,
"UpdateOptions" ,
"<Params>) => Promise<" ,
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.PartialAlert" ,
"text" : "PartialAlert"
} ,
"<Params>>; aggregate: ({ options: { fields, ...options }, }?: { options?: " ,
"AggregateOptions" ,
" | undefined; }) => Promise<" ,
"AggregateResult" ,
">; enable: ({ id }: { id: string; }) => Promise<void>; disable: ({ id }: { id: string; }) => Promise<void>; 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; }>; getAlertInstanceSummary: ({ id, dateStart, }: " ,
"GetAlertInstanceSummaryParams" ,
") => Promise<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertInstanceSummary" ,
"text" : "AlertInstanceSummary"
} ,
">; updateApiKey: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: " ,
"MuteOptions" ,
") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: " ,
"MuteOptions" ,
") => Promise<void>; listAlertTypes: () => Promise<Set<" ,
"RegistryAlertTypeWithAuth" ,
2021-08-30 17:02:04 +02:00
">>; getSpaceId: () => string | undefined; }"
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/server/index.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"initialIsOpen" : false
2021-03-04 02:12:24 +01:00
}
] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.getBuiltinActionGroups" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getBuiltinActionGroups" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(customRecoveryGroup: " ,
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<RecoveryActionGroupId> | undefined) => [" ,
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<" ,
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.ReservedActionGroups" ,
"text" : "ReservedActionGroups"
} ,
"<RecoveryActionGroupId>>]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/builtin_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.getBuiltinActionGroups.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "customRecoveryGroup" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<RecoveryActionGroupId> | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/builtin_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : false
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.getDurationNumberInItsUnit" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "getDurationNumberInItsUnit" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"(duration: string) => number"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.getDurationNumberInItsUnit.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "duration" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.getDurationUnitValue" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "getDurationUnitValue" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"(duration: string) => string"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.getDurationUnitValue.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "duration" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.isActionGroupDisabledForActionTypeId" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "isActionGroupDisabledForActionTypeId" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"(actionGroup: string, actionTypeId: string) => boolean"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/disabled_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.isActionGroupDisabledForActionTypeId.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionGroup" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/disabled_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.isActionGroupDisabledForActionTypeId.$2" ,
2021-03-06 16:05:27 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionTypeId" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/disabled_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.parseDuration" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "parseDuration" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(duration: string) => number"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.parseDuration.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "duration" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.validateDurationSchema" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "validateDurationSchema" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"(duration: string) => string | undefined"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.validateDurationSchema.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "duration" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/parse_duration.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.validateNotifyWhenType" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "validateNotifyWhenType" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"(notifyWhen: string) => string | undefined"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_notify_when_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.validateNotifyWhenType.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "notifyWhen" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"string"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_notify_when_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.ActionGroup" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "ActionGroup" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<ActionGroupIds>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.ActionGroup.id" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "id" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"ActionGroupIds"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.ActionGroup.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "name" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
2021-03-09 16:02:55 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"id" : "def-common.ActionVariable" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-09 16:02:55 +01:00
"label" : "ActionVariable" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-09 16:02:55 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"id" : "def-common.ActionVariable.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-09 16:02:55 +01:00
"label" : "name" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-09 16:02:55 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"id" : "def-common.ActionVariable.description" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-09 16:02:55 +01:00
"label" : "description" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-09 16:02:55 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"id" : "def-common.ActionVariable.deprecated" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-09 16:02:55 +01:00
"label" : "deprecated" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-09 16:02:55 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-09 16:02:55 +01:00
"id" : "def-common.ActionVariable.useWithTripleBracesInTemplates" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-09 16:02:55 +01:00
"label" : "useWithTripleBracesInTemplates" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-09 16:02:55 +01:00
}
] ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "Alert" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
"<Params>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.id" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "id" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.enabled" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "enabled" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "name" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.tags" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "tags" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.alertTypeId" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "alertTypeId" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.consumer" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "consumer" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.schedule" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
"label" : "schedule" ,
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.IntervalSchedule" ,
"text" : "IntervalSchedule"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.actions" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "actions" ,
"description" : [ ] ,
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.AlertAction" ,
"text" : "AlertAction"
} ,
"[]"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.params" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "params" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Params"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.scheduledTaskId" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "scheduledTaskId" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.createdBy" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "createdBy" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.updatedBy" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "updatedBy" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.createdAt" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "createdAt" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Date"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.updatedAt" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "updatedAt" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Date"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.apiKey" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "apiKey" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.apiKeyOwner" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "apiKeyOwner" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.throttle" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "throttle" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.notifyWhen" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "notifyWhen" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.muteAll" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "muteAll" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.mutedInstanceIds" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "mutedInstanceIds" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.Alert.executionStatus" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "executionStatus" ,
"description" : [ ] ,
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-04 02:12:24 +01:00
"section" : "def-common.AlertExecutionStatus" ,
"text" : "AlertExecutionStatus"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertAction" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertAction" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertAction.group" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "group" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertAction.id" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "id" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertAction.actionTypeId" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionTypeId" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertAction.params" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "params" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"SavedObjectAttributes"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertAggregations" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertAggregations" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertAggregations.alertExecutionStatus" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "alertExecutionStatus" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ [status: string]: number; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertExecutionStatus" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertExecutionStatus" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertExecutionStatus.status" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "status" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertExecutionStatus.lastExecutionDate" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "lastExecutionDate" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Date"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertExecutionStatus.error" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "error" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
"{ reason: " ,
2021-03-04 02:12:24 +01:00
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.AlertExecutionStatusErrorReasons" ,
"text" : "AlertExecutionStatusErrorReasons"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"; message: string; } | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertingFrameworkHealth" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertingFrameworkHealth" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertingFrameworkHealth.isSufficientlySecure" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "isSufficientlySecure" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "hasPermanentEncryptionKey" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertingFrameworkHealth.alertingFrameworkHeath" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "alertingFrameworkHeath" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertsHealth" ,
"text" : "AlertsHealth"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceStatus" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertInstanceStatus" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceStatus.status" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "status" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-05-20 22:11:31 +02:00
"\"OK\" | \"Active\""
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceStatus.muted" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "muted" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceStatus.actionGroupId" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionGroupId" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceStatus.actionSubgroup" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionSubgroup" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceStatus.activeStartDate" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "activeStartDate" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertInstanceSummary" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "AlertInstanceSummary" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertInstanceSummary.id" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "id" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertInstanceSummary.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "name" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertInstanceSummary.tags" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "tags" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertInstanceSummary.alertTypeId" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "alertTypeId" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertInstanceSummary.consumer" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "consumer" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertInstanceSummary.muteAll" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "muteAll" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.throttle" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "throttle" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.enabled" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "enabled" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.statusStartDate" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "statusStartDate" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.statusEndDate" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "statusEndDate" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.status" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "status" ,
"description" : [ ] ,
"signature" : [
2021-05-20 22:11:31 +02:00
"\"OK\" | \"Active\" | \"Error\""
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.lastRun" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "lastRun" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.errorMessages" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "errorMessages" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ date: string; message: string; }[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceSummary.instances" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "instances" ,
"description" : [ ] ,
"signature" : [
2021-05-20 22:11:31 +02:00
"{ [x: string]: " ,
2021-03-06 16:05:27 +01:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertInstanceStatus" ,
"text" : "AlertInstanceStatus"
} ,
2021-05-20 22:11:31 +02:00
"; }"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertsHealth" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertsHealth" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertsHealth.decryptionHealth" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "decryptionHealth" ,
"description" : [ ] ,
"signature" : [
"{ status: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.HealthStatus" ,
"text" : "HealthStatus"
} ,
"; timestamp: string; }"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertsHealth.executionHealth" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "executionHealth" ,
"description" : [ ] ,
"signature" : [
"{ status: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.HealthStatus" ,
"text" : "HealthStatus"
} ,
"; timestamp: string; }"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertsHealth.readHealth" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "readHealth" ,
"description" : [ ] ,
"signature" : [
"{ status: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.HealthStatus" ,
"text" : "HealthStatus"
} ,
"; timestamp: string; }"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertStateNavigation" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertStateNavigation" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_navigation.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertStateNavigation.state" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "state" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/utility-types" ,
"scope" : "server" ,
"docId" : "kibKbnUtilityTypesPluginApi" ,
"section" : "def-server.JsonObject" ,
"text" : "JsonObject"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_navigation.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertType" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
2021-03-04 02:12:24 +01:00
{
2021-03-06 16:05:27 +01:00
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertType" ,
"text" : "AlertType"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
"<ActionGroupIds, RecoveryActionGroupId>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.id" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "id" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.name" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "name" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.actionGroups" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionGroups" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
{
2021-03-06 03:38:33 +01:00
"pluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"scope" : "common" ,
2021-03-06 03:38:33 +01:00
"docId" : "kibAlertingPluginApi" ,
2021-03-06 16:05:27 +01:00
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<ActionGroupIds>[]"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.recoveryActionGroup" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "recoveryActionGroup" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<RecoveryActionGroupId>"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.actionVariables" ,
2021-03-04 02:12:24 +01:00
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "actionVariables" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string[]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.defaultActionGroupId" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "defaultActionGroupId" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"ActionGroupIds"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.producer" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "producer" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertType.minimumLicenseRequired" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "minimumLicenseRequired" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-06-30 19:04:59 +02:00
} ,
{
"parentPluginId" : "alerting" ,
"id" : "def-common.AlertType.isExportable" ,
"type" : "boolean" ,
"tags" : [ ] ,
"label" : "isExportable" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-06-30 19:04:59 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertUrlNavigation" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "AlertUrlNavigation" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_navigation.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertUrlNavigation.path" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "path" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_navigation.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.IntervalSchedule" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "IntervalSchedule" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.IntervalSchedule" ,
"text" : "IntervalSchedule"
2021-03-04 02:12:24 +01:00
} ,
2021-03-06 16:05:27 +01:00
" extends " ,
"SavedObjectAttributes"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.IntervalSchedule.interval" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "interval" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertExecutionStatusErrorReasons" ,
"type" : "Enum" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertExecutionStatusErrorReasons" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.HealthStatus" ,
"type" : "Enum" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "HealthStatus" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"misc" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.ActionGroupIdsOf" ,
"type" : "Type" ,
2021-03-04 02:12:24 +01:00
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "ActionGroupIdsOf" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"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"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertActionParam" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertActionParam" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-05-20 22:11:31 +02:00
"string | number | boolean | " ,
2021-03-06 16:05:27 +01:00
"SavedObjectAttributes" ,
" | " ,
"SavedObjectAttributeSingle" ,
2021-05-20 22:11:31 +02:00
"[] | null | undefined"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertActionParams" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertActionParams" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"SavedObjectAttributes"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertExecutionStatuses" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertExecutionStatuses" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceContext" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertInstanceContext" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ [x: string]: unknown; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceMeta" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertInstanceMeta" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceState" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertInstanceState" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ [x: string]: unknown; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertInstanceStatusValues" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertInstanceStatusValues" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"OK\" | \"Active\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertNavigation" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertNavigation" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertUrlNavigation" ,
"text" : "AlertUrlNavigation"
} ,
" | " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertStateNavigation" ,
"text" : "AlertStateNavigation"
}
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_navigation.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertNotifyWhenType" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertNotifyWhenType" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_notify_when_type.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.ALERTS_FEATURE_ID" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "ALERTS_FEATURE_ID" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"alerts\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertStatusValues" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertStatusValues" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"OK\" | \"Active\" | \"Error\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance_summary.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertTaskParams" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertTaskParams" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ alertId: string; } & { spaceId?: string | undefined; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_task_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertTaskState" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertTaskState" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"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; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_task_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertTypeParams" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertTypeParams" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ [x: string]: unknown; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.AlertTypeState" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "AlertTypeState" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ [x: string]: unknown; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-30 16:41:41 +02:00
"id" : "def-common.BASE_ALERTING_API_PATH" ,
2021-03-06 16:05:27 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-30 16:41:41 +02:00
"label" : "BASE_ALERTING_API_PATH" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"/api/alerting\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.DefaultActionGroupId" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "DefaultActionGroupId" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"default\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/builtin_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
2021-03-30 16:41:41 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-30 16:41:41 +02:00
"id" : "def-common.INTERNAL_BASE_ALERTING_API_PATH" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-30 16:41:41 +02:00
"label" : "INTERNAL_BASE_ALERTING_API_PATH" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"/internal/alerting\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-30 16:41:41 +02:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-30 16:41:41 +02:00
"id" : "def-common.LEGACY_BASE_ALERT_API_PATH" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-30 16:41:41 +02:00
"label" : "LEGACY_BASE_ALERT_API_PATH" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"/api/alerts\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/index.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-30 16:41:41 +02:00
"initialIsOpen" : false
} ,
2021-03-06 16:05:27 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.RawAlertInstance" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "RawAlertInstance" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.RecoveredActionGroupId" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "RecoveredActionGroupId" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"recovered\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/builtin_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.ReservedActionGroups" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "ReservedActionGroups" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-14 23:51:30 +02:00
"RecoveryActionGroupId | \"recovered\""
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/builtin_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
2021-08-30 17:02:04 +02:00
{
"parentPluginId" : "alerting" ,
"id" : "def-common.ResolvedSanitizedRule" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "ResolvedSanitizedRule" ,
"description" : [ ] ,
"signature" : [
"Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
"<Params>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> & Pick<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsResolveResponse" ,
"text" : "SavedObjectsResolveResponse"
} ,
"<unknown>, \"outcome\" | \"alias_target_id\">"
] ,
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.SanitizedAlert" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "SanitizedAlert" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"{ enabled: boolean; id: string; name: string; tags: string[]; params: Params; actions: " ,
2021-05-20 22:11:31 +02:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertAction" ,
"text" : "AlertAction"
} ,
2021-08-30 17:02:04 +02:00
"[]; throttle: string | null; alertTypeId: string; consumer: string; schedule: " ,
2021-05-20 22:11:31 +02:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.IntervalSchedule" ,
"text" : "IntervalSchedule"
} ,
2021-08-02 22:44:47 +02:00
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: " ,
2021-05-20 22:11:31 +02:00
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.AlertExecutionStatus" ,
"text" : "AlertExecutionStatus"
} ,
"; }"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
2021-05-24 18:19:21 +02:00
{
"parentPluginId" : "alerting" ,
"id" : "def-common.SanitizedRuleConfig" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "SanitizedRuleConfig" ,
"description" : [ ] ,
"signature" : [
2021-05-31 19:33:12 +02:00
"Pick<Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.Alert" ,
"text" : "Alert"
} ,
2021-08-30 17:02:04 +02:00
"<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"enabled\" | \"name\" | \"tags\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
2021-05-24 18:19:21 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-24 18:19:21 +02:00
"deprecated" : false ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.WithoutReservedActionGroups" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "WithoutReservedActionGroups" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"ActionGroupIds extends " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ReservedActionGroups" ,
"text" : "ReservedActionGroups"
} ,
"<RecoveryActionGroupId> ? never : ActionGroupIds"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/builtin_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.AlertExecutionStatusValues" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "AlertExecutionStatusValues" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.alertParamsSchema" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "alertParamsSchema" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-03-06 16:05:27 +01:00
"IntersectionC" ,
"<[" ,
"TypeC" ,
"<{ alertId: " ,
2021-03-04 02:12:24 +01:00
"StringC" ,
2021-03-06 16:05:27 +01:00
"; }>, " ,
"PartialC" ,
"<{ spaceId: " ,
2021-05-20 22:11:31 +02:00
"StringC" ,
"; }>]>"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_task_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.alertStateSchema" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "alertStateSchema" ,
"description" : [ ] ,
"signature" : [
"PartialC" ,
"<{ alertTypeState: " ,
"RecordC" ,
"<" ,
"StringC" ,
", " ,
"UnknownC" ,
">; alertInstances: " ,
2021-05-20 22:11:31 +02:00
"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>]>; }>"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_task_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.DisabledActionTypeIdsForActionGroup" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "DisabledActionTypeIdsForActionGroup" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"Map<string, string[]>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/disabled_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.rawAlertInstance" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "rawAlertInstance" ,
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"PartialC" ,
2021-03-06 16:05:27 +01:00
"<{ state: " ,
"RecordC" ,
"<" ,
"StringC" ,
", " ,
"UnknownC" ,
">; meta: " ,
2021-05-20 22:11:31 +02:00
"PartialC" ,
"<{ lastScheduledActions: " ,
"IntersectionC" ,
"<[" ,
"PartialC" ,
"<{ subgroup: " ,
"StringC" ,
"; }>, " ,
"TypeC" ,
"<{ group: " ,
"StringC" ,
"; date: " ,
"Type" ,
"<Date, string, unknown>; }>]>; }>; }>"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/alert_instance.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "alerting" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.RecoveredActionGroup" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "RecoveredActionGroup" ,
"description" : [ ] ,
"signature" : [
2021-05-20 22:11:31 +02:00
"{ readonly id: \"recovered\"; readonly name: string; }"
2021-03-04 02:12:24 +01:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/alerting/common/builtin_action_groups.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
]
}
}