{ "id": "alerting", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "alerting", "id": "def-public.AlertNavigationHandler", "type": "Type", "tags": [], "label": "AlertNavigationHandler", "description": [ "\nReturns information that can be used to navigate to a specific page to view the given rule.\n" ], "signature": [ "(alert: Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.Alert", "text": "Alert" }, ", \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.JsonObject", "text": "JsonObject" } ], "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts", "deprecated": false, "returnComment": [ "A URL that is meant to be relative to your application id, or a state object that your application uses to render\nthe rule. This information is intended to be used with cores NavigateToApp function, along with the application id that was\noriginally registered to {@link PluginSetupContract.registerNavigation}." ], "children": [ { "parentPluginId": "alerting", "id": "def-public.AlertNavigationHandler.$1", "type": "Object", "tags": [], "label": "alert", "description": [], "signature": [ "{ id: string; name: string; tags: string[]; enabled: boolean; params: never; actions: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertAction", "text": "AlertAction" }, "[]; alertTypeId: string; consumer: string; schedule: ", { "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; throttle: 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 } ], "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract", "type": "Interface", "tags": [], "label": "PluginSetupContract", "description": [], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerNavigation", "type": "Function", "tags": [ "throws" ], "label": "registerNavigation", "description": [ "\nRegister a customized view of the particular rule type. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule details view in Stack Management.\n" ], "signature": [ "(applicationId: string, ruleType: string, handler: ", { "pluginId": "alerting", "scope": "public", "docId": "kibAlertingPluginApi", "section": "def-public.AlertNavigationHandler", "text": "AlertNavigationHandler" }, ") => void" ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerNavigation.$1", "type": "string", "tags": [], "label": "applicationId", "description": [ "The application id that the user should be navigated to, to view a particular alert in a custom way." ], "signature": [ "string" ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerNavigation.$2", "type": "string", "tags": [], "label": "ruleType", "description": [ "The rule type that has been registered with Alerting.Server.PluginSetupContract.registerType. If\nno such rule with that id exists, a warning is output to the console log. It used to throw an error, but that was temporarily moved\nbecause it was causing flaky test failures with https://github.com/elastic/kibana/issues/59229 and needs to be\ninvestigated more." ], "signature": [ "string" ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerNavigation.$3", "type": "Function", "tags": [], "label": "handler", "description": [ "The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details." ], "signature": [ { "pluginId": "alerting", "scope": "public", "docId": "kibAlertingPluginApi", "section": "def-public.AlertNavigationHandler", "text": "AlertNavigationHandler" } ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerDefaultNavigation", "type": "Function", "tags": [], "label": "registerDefaultNavigation", "description": [ "\nRegister a customized view for all rule types with this application id. Stack Management provides a generic overview, but a developer can register a\ncustom navigation to provide the user an extra link to a more curated view. The alerting plugin doesn't actually do\nanything with this information, but it can be used by other plugins via the `getNavigation` functionality. Currently\nthe trigger_actions_ui plugin uses it to expose the link from the generic rule details view in Stack Management.\n" ], "signature": [ "(applicationId: string, handler: ", { "pluginId": "alerting", "scope": "public", "docId": "kibAlertingPluginApi", "section": "def-public.AlertNavigationHandler", "text": "AlertNavigationHandler" }, ") => void" ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerDefaultNavigation.$1", "type": "string", "tags": [], "label": "applicationId", "description": [ "The application id that the user should be navigated to, to view a particular alert in a custom way." ], "signature": [ "string" ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-public.PluginSetupContract.registerDefaultNavigation.$2", "type": "Function", "tags": [], "label": "handler", "description": [ "The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details." ], "signature": [ { "pluginId": "alerting", "scope": "public", "docId": "kibAlertingPluginApi", "section": "def-public.AlertNavigationHandler", "text": "AlertNavigationHandler" } ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "alerting", "id": "def-public.PluginStartContract", "type": "Interface", "tags": [], "label": "PluginStartContract", "description": [], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-public.PluginStartContract.getNavigation", "type": "Function", "tags": [], "label": "getNavigation", "description": [], "signature": [ "(alertId: string) => Promise<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertUrlNavigation", "text": "AlertUrlNavigation" }, " | ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertStateNavigation", "text": "AlertStateNavigation" }, " | undefined>" ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-public.PluginStartContract.getNavigation.$1", "type": "string", "tags": [], "label": "alertId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [ { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization", "type": "Class", "tags": [], "label": "AlertingAuthorization", "description": [], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.Unnamed.$1", "type": "Object", "tags": [], "label": "{\n ruleTypeRegistry,\n request,\n authorization,\n features,\n getSpace,\n getSpaceId,\n }", "description": [], "signature": [ "ConstructorOptions" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getSpaceId", "type": "Function", "tags": [], "label": "getSpaceId", "description": [], "signature": [ "() => string | undefined" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization", "type": "Function", "tags": [], "label": "getAugmentedRuleTypesWithAuthorization", "description": [], "signature": [ "(featureIds: readonly string[], operations: (", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.ReadOperations", "text": "ReadOperations" }, " | ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.WriteOperations", "text": "WriteOperations" }, ")[], authorizationEntity: ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertingAuthorizationEntity", "text": "AlertingAuthorizationEntity" }, ") => Promise<{ username?: string | undefined; hasAllRequested: boolean; authorizedRuleTypes: Set<", "RegistryAlertTypeWithAuth", ">; }>" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization.$1", "type": "Object", "tags": [], "label": "featureIds", "description": [], "signature": [ "readonly string[]" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization.$2", "type": "Array", "tags": [], "label": "operations", "description": [], "signature": [ "(", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.ReadOperations", "text": "ReadOperations" }, " | ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.WriteOperations", "text": "WriteOperations" }, ")[]" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getAugmentedRuleTypesWithAuthorization.$3", "type": "Enum", "tags": [], "label": "authorizationEntity", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertingAuthorizationEntity", "text": "AlertingAuthorizationEntity" } ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.ensureAuthorized", "type": "Function", "tags": [], "label": "ensureAuthorized", "description": [], "signature": [ "({ ruleTypeId, consumer, operation, entity }: ", "EnsureAuthorizedOpts", ") => Promise" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.ensureAuthorized.$1", "type": "Object", "tags": [], "label": "{ ruleTypeId, consumer, operation, entity }", "description": [], "signature": [ "EnsureAuthorizedOpts" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getFindAuthorizationFilter", "type": "Function", "tags": [], "label": "getFindAuthorizationFilter", "description": [], "signature": [ "(authorizationEntity: ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertingAuthorizationEntity", "text": "AlertingAuthorizationEntity" }, ", filterOpts: ", "AlertingAuthorizationFilterOpts", ") => Promise<{ filter?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.KueryNode", "text": "KueryNode" }, " | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.JsonObject", "text": "JsonObject" }, " | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "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" } ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getFindAuthorizationFilter.$2", "type": "Object", "tags": [], "label": "filterOpts", "description": [], "signature": [ "AlertingAuthorizationFilterOpts" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.getAuthorizationFilter", "type": "Function", "tags": [], "label": "getAuthorizationFilter", "description": [], "signature": [ "(authorizationEntity: ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertingAuthorizationEntity", "text": "AlertingAuthorizationEntity" }, ", filterOpts: ", "AlertingAuthorizationFilterOpts", ", operation: ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.ReadOperations", "text": "ReadOperations" }, " | ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.WriteOperations", "text": "WriteOperations" }, ") => Promise<{ filter?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.KueryNode", "text": "KueryNode" }, " | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.JsonObject", "text": "JsonObject" }, " | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => 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": [] }, { "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>" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization.$1", "type": "Object", "tags": [], "label": "ruleTypes", "description": [], "signature": [ "Set<", "RegistryRuleType", ">" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization.$2", "type": "Array", "tags": [], "label": "operations", "description": [], "signature": [ "(", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.ReadOperations", "text": "ReadOperations" }, " | ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.WriteOperations", "text": "WriteOperations" }, ")[]" ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorization.filterByRuleTypeAuthorization.$3", "type": "Enum", "tags": [], "label": "authorizationEntity", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertingAuthorizationEntity", "text": "AlertingAuthorizationEntity" } ], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "alerting", "id": "def-server.getEsErrorMessage", "type": "Function", "tags": [], "label": "getEsErrorMessage", "description": [], "signature": [ "(error: ", "ElasticsearchError", ") => string" ], "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.getEsErrorMessage.$1", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ "ElasticsearchError" ], "path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.parseDuration", "type": "Function", "tags": [], "label": "parseDuration", "description": [], "signature": [ "(duration: string) => number" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.parseDuration.$1", "type": "string", "tags": [], "label": "duration", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "alerting", "id": "def-server.ActionGroup", "type": "Interface", "tags": [], "label": "ActionGroup", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.ActionGroup.id", "type": "Uncategorized", "tags": [], "label": "id", "description": [], "signature": [ "ActionGroupIds" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.ActionGroup.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions", "type": "Interface", "tags": [], "label": "AlertExecutorOptions", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertExecutorOptions", "text": "AlertExecutorOptions" }, "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.alertId", "type": "string", "tags": [], "label": "alertId", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.startedAt", "type": "Object", "tags": [], "label": "startedAt", "description": [], "signature": [ "Date" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.previousStartedAt", "type": "CompoundType", "tags": [], "label": "previousStartedAt", "description": [], "signature": [ "Date | null" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.services", "type": "Object", "tags": [], "label": "services", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertServices", "text": "AlertServices" }, "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.params", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.state", "type": "Uncategorized", "tags": [], "label": "state", "description": [], "signature": [ "State" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.rule", "type": "CompoundType", "tags": [], "label": "rule", "description": [], "signature": [ "Pick, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.spaceId", "type": "string", "tags": [], "label": "spaceId", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.tags", "type": "Array", "tags": [], "label": "tags", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.createdBy", "type": "CompoundType", "tags": [], "label": "createdBy", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertExecutorOptions.updatedBy", "type": "CompoundType", "tags": [], "label": "updatedBy", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext", "type": "Interface", "tags": [], "label": "AlertingApiRequestHandlerContext", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext.getRulesClient", "type": "Function", "tags": [], "label": "getRulesClient", "description": [], "signature": [ "() => ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.RulesClient", "text": "RulesClient" } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext.listTypes", "type": "Function", "tags": [], "label": "listTypes", "description": [], "signature": [ "() => Set<", "RegistryRuleType", ">" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext.getFrameworkHealth", "type": "Function", "tags": [], "label": "getFrameworkHealth", "description": [], "signature": [ "() => Promise<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertsHealth", "text": "AlertsHealth" }, ">" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.AlertingApiRequestHandlerContext.areApiKeysEnabled", "type": "Function", "tags": [], "label": "areApiKeysEnabled", "description": [], "signature": [ "() => Promise" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertingPlugin", "type": "Interface", "tags": [], "label": "AlertingPlugin", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertingPlugin.setup", "type": "Object", "tags": [], "label": "setup", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertingPlugin.start", "type": "Object", "tags": [], "label": "start", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.PluginStartContract", "text": "PluginStartContract" } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertServices", "type": "Interface", "tags": [], "label": "AlertServices", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertServices", "text": "AlertServices" }, " extends ", "Services" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertServices.alertInstanceFactory", "type": "Function", "tags": [], "label": "alertInstanceFactory", "description": [], "signature": [ "(id: string) => Pick<", "AlertInstance", ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertServices.alertInstanceFactory.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType", "type": "Interface", "tags": [], "label": "AlertType", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertType", "text": "AlertType" }, "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertType.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.validate", "type": "Object", "tags": [], "label": "validate", "description": [], "signature": [ "{ params?: ", "AlertTypeParamsValidator", " | undefined; } | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.actionGroups", "type": "Array", "tags": [], "label": "actionGroups", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "[]" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.defaultActionGroupId", "type": "Uncategorized", "tags": [], "label": "defaultActionGroupId", "description": [], "signature": [ "ActionGroupIds" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.recoveryActionGroup", "type": "Object", "tags": [], "label": "recoveryActionGroup", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.executor", "type": "Function", "tags": [], "label": "executor", "description": [], "signature": [ "(options: ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertExecutorOptions", "text": "AlertExecutorOptions" }, ">) => Promise" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "alerting", "id": "def-server.AlertType.executor.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertExecutorOptions", "text": "AlertExecutorOptions" }, "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false } ] }, { "parentPluginId": "alerting", "id": "def-server.AlertType.producer", "type": "string", "tags": [], "label": "producer", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.actionVariables", "type": "Object", "tags": [], "label": "actionVariables", "description": [], "signature": [ "{ context?: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionVariable", "text": "ActionVariable" }, "[] | undefined; state?: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionVariable", "text": "ActionVariable" }, "[] | undefined; params?: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionVariable", "text": "ActionVariable" }, "[] | undefined; } | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.minimumLicenseRequired", "type": "CompoundType", "tags": [], "label": "minimumLicenseRequired", "description": [], "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ], "path": "x-pack/plugins/alerting/server/types.ts", "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" }, "; injectReferences: (params: ExtractedParams, references: ", "SavedObjectReference", "[]) => Params; } | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.isExportable", "type": "boolean", "tags": [], "label": "isExportable", "description": [], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.defaultScheduleInterval", "type": "string", "tags": [], "label": "defaultScheduleInterval", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.AlertType.minimumScheduleInterval", "type": "string", "tags": [], "label": "minimumScheduleInterval", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "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 } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.FindResult", "type": "Interface", "tags": [], "label": "FindResult", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.FindResult", "text": "FindResult" }, "" ], "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.FindResult.page", "type": "number", "tags": [], "label": "page", "description": [], "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.FindResult.perPage", "type": "number", "tags": [], "label": "perPage", "description": [], "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.FindResult.total", "type": "number", "tags": [], "label": "total", "description": [], "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.FindResult.data", "type": "Array", "tags": [], "label": "data", "description": [], "signature": [ "Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.Alert", "text": "Alert" }, ", \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]" ], "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.PluginSetupContract", "type": "Interface", "tags": [], "label": "PluginSetupContract", "description": [], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.PluginSetupContract.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ " = Record, ExtractedParams extends Record = Record, State extends Record = Record, InstanceState extends { [x: string]: unknown; } = { [x: string]: unknown; }, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = never, RecoveryActionGroupId extends string = never>(alertType: ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertType", "text": "AlertType" }, ") => void" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.PluginSetupContract.registerType.$1", "type": "Object", "tags": [], "label": "alertType", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertType", "text": "AlertType" }, "" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.PluginStartContract", "type": "Interface", "tags": [], "label": "PluginStartContract", "description": [], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.PluginStartContract.listTypes", "type": "Function", "tags": [], "label": "listTypes", "description": [], "signature": [ "() => Set<", "RegistryRuleType", ">" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "alerting", "id": "def-server.PluginStartContract.getRulesClientWithRequest", "type": "Function", "tags": [], "label": "getRulesClientWithRequest", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => Pick<", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.RulesClient", "text": "RulesClient" }, ", \"create\" | \"delete\" | \"find\" | \"get\" | \"resolve\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\" | \"getSpaceId\">" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.PluginStartContract.getRulesClientWithRequest.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "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" }, ") => Pick<", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertingAuthorization", "text": "AlertingAuthorization" }, ", \"ensureAuthorized\" | \"getSpaceId\" | \"getAugmentedRuleTypesWithAuthorization\" | \"getFindAuthorizationFilter\" | \"getAuthorizationFilter\" | \"filterByRuleTypeAuthorization\">" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "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" }, "" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "alerting", "id": "def-server.PluginStartContract.getFrameworkHealth", "type": "Function", "tags": [], "label": "getFrameworkHealth", "description": [], "signature": [ "() => Promise<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertsHealth", "text": "AlertsHealth" }, ">" ], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.RuleParamsAndRefs", "type": "Interface", "tags": [], "label": "RuleParamsAndRefs", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.RuleParamsAndRefs", "text": "RuleParamsAndRefs" }, "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-server.RuleParamsAndRefs.references", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ "SavedObjectReference", "[]" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-server.RuleParamsAndRefs.params", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorizationEntity", "type": "Enum", "tags": [], "label": "AlertingAuthorizationEntity", "description": [], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertingAuthorizationFilterType", "type": "Enum", "tags": [], "label": "AlertingAuthorizationFilterType", "description": [], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization_kuery.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.ReadOperations", "type": "Enum", "tags": [], "label": "ReadOperations", "description": [], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.WriteOperations", "type": "Enum", "tags": [], "label": "WriteOperations", "description": [], "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "alerting", "id": "def-server.ActionGroupIdsOf", "type": "Type", "tags": [], "label": "ActionGroupIdsOf", "description": [], "signature": [ "T extends ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " ? groups : T extends Readonly<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "> ? groups : never" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertActionParams", "type": "Type", "tags": [], "label": "AlertActionParams", "description": [], "signature": [ "SavedObjectAttributes" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertInstanceContext", "type": "Type", "tags": [], "label": "AlertInstanceContext", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertInstanceState", "type": "Type", "tags": [], "label": "AlertInstanceState", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertTypeParams", "type": "Type", "tags": [], "label": "AlertTypeParams", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.AlertTypeState", "type": "Type", "tags": [], "label": "AlertTypeState", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", "type": "number", "tags": [], "label": "DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", "description": [], "signature": [ "10" ], "path": "x-pack/plugins/alerting/server/config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.PartialAlert", "type": "Type", "tags": [], "label": "PartialAlert", "description": [], "signature": [ "Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.Alert", "text": "Alert" }, ", \"id\"> & Partial, \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.PublicAlertInstance", "type": "Type", "tags": [], "label": "PublicAlertInstance", "description": [], "signature": [ "{ getState: () => State; replaceState: (state: State) => ", "AlertInstance", "; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ", "AlertInstance", "; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => ", "AlertInstance", "; }" ], "path": "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-server.RulesClient", "type": "Type", "tags": [], "label": "RulesClient", "description": [], "signature": [ "{ create: = never>({ data, options, }: ", "CreateOptions", ") => Promise, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; find: = never>({ options: { fields, ...options }, }?: { options?: ", "FindOptions", " | undefined; }) => Promise<", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.FindResult", "text": "FindResult" }, ">; get: = never>({ id, includeLegacyId, }: { id: string; includeLegacyId?: boolean | undefined; }) => Promise, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> | Pick<", "AlertWithLegacyId", ", \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\" | \"legacyId\">>; resolve: = never>({ id, }: { id: string; }) => Promise<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ResolvedSanitizedRule", "text": "ResolvedSanitizedRule" }, ">; update: = never>({ id, data, }: ", "UpdateOptions", ") => Promise<", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.PartialAlert", "text": "PartialAlert" }, ">; aggregate: ({ options: { fields, ...options }, }?: { options?: ", "AggregateOptions", " | undefined; }) => Promise<", "AggregateResult", ">; enable: ({ id }: { id: string; }) => Promise; disable: ({ id }: { id: string; }) => Promise; muteAll: ({ id }: { id: string; }) => Promise; getAlertState: ({ id }: { id: string; }) => Promise; getAlertInstanceSummary: ({ id, dateStart, }: ", "GetAlertInstanceSummaryParams", ") => Promise<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertInstanceSummary", "text": "AlertInstanceSummary" }, ">; updateApiKey: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; listAlertTypes: () => Promise>; getSpaceId: () => string | undefined; }" ], "path": "x-pack/plugins/alerting/server/index.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "alerting", "id": "def-common.formatDuration", "type": "Function", "tags": [], "label": "formatDuration", "description": [], "signature": [ "(duration: string) => string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.formatDuration.$1", "type": "string", "tags": [], "label": "duration", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.getBuiltinActionGroups", "type": "Function", "tags": [], "label": "getBuiltinActionGroups", "description": [], "signature": [ "(customRecoveryGroup: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " | undefined) => [", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ReservedActionGroups", "text": "ReservedActionGroups" }, ">]" ], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.getBuiltinActionGroups.$1", "type": "Object", "tags": [], "label": "customRecoveryGroup", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " | undefined" ], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.getDurationNumberInItsUnit", "type": "Function", "tags": [], "label": "getDurationNumberInItsUnit", "description": [], "signature": [ "(duration: string) => number" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.getDurationNumberInItsUnit.$1", "type": "string", "tags": [], "label": "duration", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.getDurationUnitValue", "type": "Function", "tags": [], "label": "getDurationUnitValue", "description": [], "signature": [ "(duration: string) => string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.getDurationUnitValue.$1", "type": "string", "tags": [], "label": "duration", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.isActionGroupDisabledForActionTypeId", "type": "Function", "tags": [], "label": "isActionGroupDisabledForActionTypeId", "description": [], "signature": [ "(actionGroup: string, actionTypeId: string) => boolean" ], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.isActionGroupDisabledForActionTypeId.$1", "type": "string", "tags": [], "label": "actionGroup", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "alerting", "id": "def-common.isActionGroupDisabledForActionTypeId.$2", "type": "string", "tags": [], "label": "actionTypeId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.parseDuration", "type": "Function", "tags": [], "label": "parseDuration", "description": [], "signature": [ "(duration: string) => number" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.parseDuration.$1", "type": "string", "tags": [], "label": "duration", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.validateDurationSchema", "type": "Function", "tags": [], "label": "validateDurationSchema", "description": [], "signature": [ "(duration: string) => string | undefined" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.validateDurationSchema.$1", "type": "string", "tags": [], "label": "duration", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.validateNotifyWhenType", "type": "Function", "tags": [], "label": "validateNotifyWhenType", "description": [], "signature": [ "(notifyWhen: string) => string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.validateNotifyWhenType.$1", "type": "string", "tags": [], "label": "notifyWhen", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "alerting", "id": "def-common.ActionGroup", "type": "Interface", "tags": [], "label": "ActionGroup", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.ActionGroup.id", "type": "Uncategorized", "tags": [], "label": "id", "description": [], "signature": [ "ActionGroupIds" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.ActionGroup.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.ActionVariable", "type": "Interface", "tags": [], "label": "ActionVariable", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.ActionVariable.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.ActionVariable.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.ActionVariable.deprecated", "type": "CompoundType", "tags": [], "label": "deprecated", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.ActionVariable.useWithTripleBracesInTemplates", "type": "CompoundType", "tags": [], "label": "useWithTripleBracesInTemplates", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.Alert", "type": "Interface", "tags": [], "label": "Alert", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.Alert", "text": "Alert" }, "" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.Alert.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.enabled", "type": "boolean", "tags": [], "label": "enabled", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.tags", "type": "Array", "tags": [], "label": "tags", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.alertTypeId", "type": "string", "tags": [], "label": "alertTypeId", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.consumer", "type": "string", "tags": [], "label": "consumer", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.schedule", "type": "Object", "tags": [], "label": "schedule", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.IntervalSchedule", "text": "IntervalSchedule" } ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.actions", "type": "Array", "tags": [], "label": "actions", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertAction", "text": "AlertAction" }, "[]" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.params", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.scheduledTaskId", "type": "string", "tags": [], "label": "scheduledTaskId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.createdBy", "type": "CompoundType", "tags": [], "label": "createdBy", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.updatedBy", "type": "CompoundType", "tags": [], "label": "updatedBy", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.createdAt", "type": "Object", "tags": [], "label": "createdAt", "description": [], "signature": [ "Date" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.updatedAt", "type": "Object", "tags": [], "label": "updatedAt", "description": [], "signature": [ "Date" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.apiKey", "type": "CompoundType", "tags": [], "label": "apiKey", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.apiKeyOwner", "type": "CompoundType", "tags": [], "label": "apiKeyOwner", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.throttle", "type": "CompoundType", "tags": [], "label": "throttle", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.notifyWhen", "type": "CompoundType", "tags": [], "label": "notifyWhen", "description": [], "signature": [ "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.muteAll", "type": "boolean", "tags": [], "label": "muteAll", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.mutedInstanceIds", "type": "Array", "tags": [], "label": "mutedInstanceIds", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.Alert.executionStatus", "type": "Object", "tags": [], "label": "executionStatus", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertExecutionStatus", "text": "AlertExecutionStatus" } ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertAction", "type": "Interface", "tags": [], "label": "AlertAction", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertAction.group", "type": "string", "tags": [], "label": "group", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertAction.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertAction.actionTypeId", "type": "string", "tags": [], "label": "actionTypeId", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertAction.params", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "SavedObjectAttributes" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertAggregations", "type": "Interface", "tags": [], "label": "AlertAggregations", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertAggregations.alertExecutionStatus", "type": "Object", "tags": [], "label": "alertExecutionStatus", "description": [], "signature": [ "{ [status: string]: number; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus", "type": "Interface", "tags": [], "label": "AlertExecutionStatus", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus.status", "type": "CompoundType", "tags": [], "label": "status", "description": [], "signature": [ "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus.lastExecutionDate", "type": "Object", "tags": [], "label": "lastExecutionDate", "description": [], "signature": [ "Date" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus.lastDuration", "type": "number", "tags": [], "label": "lastDuration", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatus.error", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ "{ reason: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertExecutionStatusErrorReasons", "text": "AlertExecutionStatusErrorReasons" }, "; message: string; } | undefined" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth", "type": "Interface", "tags": [], "label": "AlertingFrameworkHealth", "description": [], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", "type": "boolean", "tags": [], "label": "isSufficientlySecure", "description": [], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", "type": "boolean", "tags": [], "label": "hasPermanentEncryptionKey", "description": [], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHeath", "type": "Object", "tags": [], "label": "alertingFrameworkHeath", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertsHealth", "text": "AlertsHealth" } ], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus", "type": "Interface", "tags": [], "label": "AlertInstanceStatus", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.status", "type": "CompoundType", "tags": [], "label": "status", "description": [], "signature": [ "\"OK\" | \"Active\"" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.muted", "type": "boolean", "tags": [], "label": "muted", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.actionGroupId", "type": "string", "tags": [], "label": "actionGroupId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.actionSubgroup", "type": "string", "tags": [], "label": "actionSubgroup", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatus.activeStartDate", "type": "string", "tags": [], "label": "activeStartDate", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary", "type": "Interface", "tags": [], "label": "AlertInstanceSummary", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.tags", "type": "Array", "tags": [], "label": "tags", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.alertTypeId", "type": "string", "tags": [], "label": "alertTypeId", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.consumer", "type": "string", "tags": [], "label": "consumer", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.muteAll", "type": "boolean", "tags": [], "label": "muteAll", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.throttle", "type": "CompoundType", "tags": [], "label": "throttle", "description": [], "signature": [ "string | null" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.enabled", "type": "boolean", "tags": [], "label": "enabled", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.statusStartDate", "type": "string", "tags": [], "label": "statusStartDate", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.statusEndDate", "type": "string", "tags": [], "label": "statusEndDate", "description": [], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.status", "type": "CompoundType", "tags": [], "label": "status", "description": [], "signature": [ "\"OK\" | \"Active\" | \"Error\"" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.lastRun", "type": "string", "tags": [], "label": "lastRun", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.errorMessages", "type": "Array", "tags": [], "label": "errorMessages", "description": [], "signature": [ "{ date: string; message: string; }[]" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.instances", "type": "Object", "tags": [], "label": "instances", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertInstanceStatus", "text": "AlertInstanceStatus" }, "; }" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceSummary.executionDuration", "type": "Object", "tags": [], "label": "executionDuration", "description": [], "signature": [ "{ average: number; values: number[]; }" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertsHealth", "type": "Interface", "tags": [], "label": "AlertsHealth", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertsHealth.decryptionHealth", "type": "Object", "tags": [], "label": "decryptionHealth", "description": [], "signature": [ "{ status: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.HealthStatus", "text": "HealthStatus" }, "; timestamp: string; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertsHealth.executionHealth", "type": "Object", "tags": [], "label": "executionHealth", "description": [], "signature": [ "{ status: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.HealthStatus", "text": "HealthStatus" }, "; timestamp: string; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertsHealth.readHealth", "type": "Object", "tags": [], "label": "readHealth", "description": [], "signature": [ "{ status: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.HealthStatus", "text": "HealthStatus" }, "; timestamp: string; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertStateNavigation", "type": "Interface", "tags": [], "label": "AlertStateNavigation", "description": [], "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertStateNavigation.state", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.JsonObject", "text": "JsonObject" } ], "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType", "type": "Interface", "tags": [], "label": "AlertType", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertType", "text": "AlertType" }, "" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertType.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.actionGroups", "type": "Array", "tags": [], "label": "actionGroups", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "[]" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.recoveryActionGroup", "type": "Object", "tags": [], "label": "recoveryActionGroup", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.actionVariables", "type": "Array", "tags": [], "label": "actionVariables", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.defaultActionGroupId", "type": "Uncategorized", "tags": [], "label": "defaultActionGroupId", "description": [], "signature": [ "ActionGroupIds" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.producer", "type": "string", "tags": [], "label": "producer", "description": [], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.minimumLicenseRequired", "type": "CompoundType", "tags": [], "label": "minimumLicenseRequired", "description": [], "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.isExportable", "type": "boolean", "tags": [], "label": "isExportable", "description": [], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.ruleTaskTimeout", "type": "string", "tags": [], "label": "ruleTaskTimeout", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.defaultScheduleInterval", "type": "string", "tags": [], "label": "defaultScheduleInterval", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false }, { "parentPluginId": "alerting", "id": "def-common.AlertType.minimumScheduleInterval", "type": "string", "tags": [], "label": "minimumScheduleInterval", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertUrlNavigation", "type": "Interface", "tags": [], "label": "AlertUrlNavigation", "description": [], "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.AlertUrlNavigation.path", "type": "string", "tags": [], "label": "path", "description": [], "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.IntervalSchedule", "type": "Interface", "tags": [], "label": "IntervalSchedule", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.IntervalSchedule", "text": "IntervalSchedule" }, " extends ", "SavedObjectAttributes" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "children": [ { "parentPluginId": "alerting", "id": "def-common.IntervalSchedule.interval", "type": "string", "tags": [], "label": "interval", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatusErrorReasons", "type": "Enum", "tags": [], "label": "AlertExecutionStatusErrorReasons", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.HealthStatus", "type": "Enum", "tags": [], "label": "HealthStatus", "description": [], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "alerting", "id": "def-common.ActionGroupIdsOf", "type": "Type", "tags": [], "label": "ActionGroupIdsOf", "description": [], "signature": [ "T extends ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " ? groups : T extends Readonly<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "> ? groups : never" ], "path": "x-pack/plugins/alerting/common/alert_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertActionParam", "type": "Type", "tags": [], "label": "AlertActionParam", "description": [], "signature": [ "string | number | boolean | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", "[] | null | undefined" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertActionParams", "type": "Type", "tags": [], "label": "AlertActionParams", "description": [], "signature": [ "SavedObjectAttributes" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatuses", "type": "Type", "tags": [], "label": "AlertExecutionStatuses", "description": [], "signature": [ "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceContext", "type": "Type", "tags": [], "label": "AlertInstanceContext", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceMeta", "type": "Type", "tags": [], "label": "AlertInstanceMeta", "description": [], "signature": [ "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }" ], "path": "x-pack/plugins/alerting/common/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceState", "type": "Type", "tags": [], "label": "AlertInstanceState", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertInstanceStatusValues", "type": "Type", "tags": [], "label": "AlertInstanceStatusValues", "description": [], "signature": [ "\"OK\" | \"Active\"" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertNavigation", "type": "Type", "tags": [], "label": "AlertNavigation", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertUrlNavigation", "text": "AlertUrlNavigation" }, " | ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertStateNavigation", "text": "AlertStateNavigation" } ], "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertNotifyWhenType", "type": "Type", "tags": [], "label": "AlertNotifyWhenType", "description": [], "signature": [ "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" ], "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.ALERTS_FEATURE_ID", "type": "string", "tags": [], "label": "ALERTS_FEATURE_ID", "description": [], "signature": [ "\"alerts\"" ], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertStatusValues", "type": "Type", "tags": [], "label": "AlertStatusValues", "description": [], "signature": [ "\"OK\" | \"Active\" | \"Error\"" ], "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertTaskParams", "type": "Type", "tags": [], "label": "AlertTaskParams", "description": [], "signature": [ "{ alertId: string; } & { spaceId?: string | undefined; }" ], "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertTaskState", "type": "Type", "tags": [], "label": "AlertTaskState", "description": [], "signature": [ "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }" ], "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertTypeParams", "type": "Type", "tags": [], "label": "AlertTypeParams", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.AlertTypeState", "type": "Type", "tags": [], "label": "AlertTypeState", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.BASE_ALERTING_API_PATH", "type": "string", "tags": [], "label": "BASE_ALERTING_API_PATH", "description": [], "signature": [ "\"/api/alerting\"" ], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.DefaultActionGroupId", "type": "Type", "tags": [], "label": "DefaultActionGroupId", "description": [], "signature": [ "\"default\"" ], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.INTERNAL_BASE_ALERTING_API_PATH", "type": "string", "tags": [], "label": "INTERNAL_BASE_ALERTING_API_PATH", "description": [], "signature": [ "\"/internal/alerting\"" ], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.LEGACY_BASE_ALERT_API_PATH", "type": "string", "tags": [], "label": "LEGACY_BASE_ALERT_API_PATH", "description": [], "signature": [ "\"/api/alerts\"" ], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.RawAlertInstance", "type": "Type", "tags": [], "label": "RawAlertInstance", "description": [], "signature": [ "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }" ], "path": "x-pack/plugins/alerting/common/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.RecoveredActionGroupId", "type": "Type", "tags": [], "label": "RecoveredActionGroupId", "description": [], "signature": [ "\"recovered\"" ], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.ReservedActionGroups", "type": "Type", "tags": [], "label": "ReservedActionGroups", "description": [], "signature": [ "RecoveryActionGroupId | \"recovered\"" ], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "initialIsOpen": false }, { "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" }, ", \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\"> & Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsResolveResponse", "text": "SavedObjectsResolveResponse" }, ", \"outcome\" | \"alias_target_id\">" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.SanitizedAlert", "type": "Type", "tags": [], "label": "SanitizedAlert", "description": [], "signature": [ "{ id: string; name: string; tags: string[]; enabled: boolean; params: Params; actions: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertAction", "text": "AlertAction" }, "[]; alertTypeId: string; consumer: string; schedule: ", { "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; throttle: 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/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.SanitizedRuleConfig", "type": "Type", "tags": [], "label": "SanitizedRuleConfig", "description": [], "signature": [ "Pick, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.WithoutReservedActionGroups", "type": "Type", "tags": [], "label": "WithoutReservedActionGroups", "description": [], "signature": [ "ActionGroupIds extends ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ReservedActionGroups", "text": "ReservedActionGroups" }, " ? never : ActionGroupIds" ], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "alerting", "id": "def-common.AlertExecutionStatusValues", "type": "Object", "tags": [], "label": "AlertExecutionStatusValues", "description": [], "signature": [ "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]" ], "path": "x-pack/plugins/alerting/common/alert.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.alertParamsSchema", "type": "Object", "tags": [], "label": "alertParamsSchema", "description": [], "signature": [ "IntersectionC", "<[", "TypeC", "<{ alertId: ", "StringC", "; }>, ", "PartialC", "<{ spaceId: ", "StringC", "; }>]>" ], "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.alertStateSchema", "type": "Object", "tags": [], "label": "alertStateSchema", "description": [], "signature": [ "PartialC", "<{ alertTypeState: ", "RecordC", "<", "StringC", ", ", "UnknownC", ">; alertInstances: ", "RecordC", "<", "StringC", ", ", "PartialC", "<{ state: ", "RecordC", "<", "StringC", ", ", "UnknownC", ">; meta: ", "PartialC", "<{ lastScheduledActions: ", "IntersectionC", "<[", "PartialC", "<{ subgroup: ", "StringC", "; }>, ", "TypeC", "<{ group: ", "StringC", "; date: ", "Type", "; }>]>; }>; }>>; previousStartedAt: ", "UnionC", "<[", "NullC", ", ", "Type", "]>; }>" ], "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.DisabledActionTypeIdsForActionGroup", "type": "Object", "tags": [], "label": "DisabledActionTypeIdsForActionGroup", "description": [], "signature": [ "Map" ], "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.rawAlertInstance", "type": "Object", "tags": [], "label": "rawAlertInstance", "description": [], "signature": [ "PartialC", "<{ state: ", "RecordC", "<", "StringC", ", ", "UnknownC", ">; meta: ", "PartialC", "<{ lastScheduledActions: ", "IntersectionC", "<[", "PartialC", "<{ subgroup: ", "StringC", "; }>, ", "TypeC", "<{ group: ", "StringC", "; date: ", "Type", "; }>]>; }>; }>" ], "path": "x-pack/plugins/alerting/common/alert_instance.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "alerting", "id": "def-common.RecoveredActionGroup", "type": "Object", "tags": [], "label": "RecoveredActionGroup", "description": [], "signature": [ "{ readonly id: \"recovered\"; readonly name: string; }" ], "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "initialIsOpen": false } ] } }