{ "id": "alerting", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [], "setup": { "id": "def-public.PluginSetupContract", "type": "Interface", "label": "PluginSetupContract", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.PluginSetupContract.registerNavigation", "type": "Function", "label": "registerNavigation", "description": [], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 15 }, "signature": [ "(consumer: string, alertType: string, handler: ", "AlertNavigationHandler", ") => void" ] }, { "tags": [], "id": "def-public.PluginSetupContract.registerDefaultNavigation", "type": "Function", "label": "registerDefaultNavigation", "description": [], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 20 }, "signature": [ "(consumer: string, handler: ", "AlertNavigationHandler", ") => void" ] } ], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 14 }, "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-public.PluginStartContract", "type": "Interface", "label": "PluginStartContract", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.PluginStartContract.getNavigation", "type": "Function", "label": "getNavigation", "description": [], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 23 }, "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>" ] } ], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", "lineNumber": 22 }, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [ { "id": "def-server.parseDuration", "type": "Function", "label": "parseDuration", "signature": [ "(duration: string) => number" ], "description": [], "children": [ { "id": "def-server.parseDuration.$1", "type": "string", "label": "duration", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 14 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 14 }, "initialIsOpen": false } ], "interfaces": [ { "id": "def-server.ActionGroup", "type": "Interface", "label": "ActionGroup", "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.ActionGroup.id", "type": "Uncategorized", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 26 }, "signature": [ "ActionGroupIds" ] }, { "tags": [], "id": "def-server.ActionGroup.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 27 } } ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 25 }, "initialIsOpen": false }, { "id": "def-server.AlertExecutorOptions", "type": "Interface", "label": "AlertExecutorOptions", "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertExecutorOptions", "text": "AlertExecutorOptions" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.AlertExecutorOptions.alertId", "type": "string", "label": "alertId", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 85 } }, { "tags": [], "id": "def-server.AlertExecutorOptions.startedAt", "type": "Object", "label": "startedAt", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 86 }, "signature": [ "Date" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.previousStartedAt", "type": "CompoundType", "label": "previousStartedAt", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 87 }, "signature": [ "Date | null" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.services", "type": "Object", "label": "services", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 88 }, "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertServices", "text": "AlertServices" }, "" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 89 }, "signature": [ "Params" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.state", "type": "Uncategorized", "label": "state", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 90 }, "signature": [ "State" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.spaceId", "type": "string", "label": "spaceId", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 91 } }, { "tags": [], "id": "def-server.AlertExecutorOptions.namespace", "type": "string", "label": "namespace", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 92 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 93 } }, { "tags": [], "id": "def-server.AlertExecutorOptions.tags", "type": "Array", "label": "tags", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 94 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.createdBy", "type": "CompoundType", "label": "createdBy", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 95 }, "signature": [ "string | null" ] }, { "tags": [], "id": "def-server.AlertExecutorOptions.updatedBy", "type": "CompoundType", "label": "updatedBy", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 96 }, "signature": [ "string | null" ] } ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 78 }, "initialIsOpen": false }, { "id": "def-server.AlertingApiRequestHandlerContext", "type": "Interface", "label": "AlertingApiRequestHandlerContext", "description": [], "tags": [ "public" ], "children": [ { "tags": [], "id": "def-server.AlertingApiRequestHandlerContext.getAlertsClient", "type": "Function", "label": "getAlertsClient", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 46 }, "signature": [ "() => ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertsClient", "text": "AlertsClient" } ] }, { "tags": [], "id": "def-server.AlertingApiRequestHandlerContext.listTypes", "type": "Function", "label": "listTypes", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 47 }, "signature": [ "() => Set<", "RegistryAlertType", ">" ] }, { "tags": [], "id": "def-server.AlertingApiRequestHandlerContext.getFrameworkHealth", "type": "Function", "label": "getFrameworkHealth", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 48 }, "signature": [ "() => Promise<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertsHealth", "text": "AlertsHealth" }, ">" ] } ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 45 }, "initialIsOpen": false }, { "id": "def-server.AlertingPlugin", "type": "Interface", "label": "AlertingPlugin", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.AlertingPlugin.setup", "type": "Object", "label": "setup", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 219 }, "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } ] }, { "tags": [], "id": "def-server.AlertingPlugin.start", "type": "Object", "label": "start", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 220 }, "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.PluginStartContract", "text": "PluginStartContract" } ] } ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 218 }, "initialIsOpen": false }, { "id": "def-server.AlertServices", "type": "Interface", "label": "AlertServices", "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertServices", "text": "AlertServices" }, " extends ", "Services" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.AlertServices.alertInstanceFactory", "type": "Function", "label": "alertInstanceFactory", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 73 }, "signature": [ "(id: string) => Pick<", "AlertInstance", ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" ] } ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 68 }, "initialIsOpen": false }, { "id": "def-server.AlertType", "type": "Interface", "label": "AlertType", "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertType", "text": "AlertType" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.AlertType.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 120 } }, { "tags": [], "id": "def-server.AlertType.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 121 } }, { "tags": [], "id": "def-server.AlertType.validate", "type": "Object", "label": "validate", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 122 }, "signature": [ "{ params?: ", "AlertTypeParamsValidator", " | undefined; } | undefined" ] }, { "tags": [], "id": "def-server.AlertType.actionGroups", "type": "Array", "label": "actionGroups", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 125 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "[]" ] }, { "tags": [], "id": "def-server.AlertType.defaultActionGroupId", "type": "Uncategorized", "label": "defaultActionGroupId", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 126 }, "signature": [ "ActionGroupIds" ] }, { "tags": [], "id": "def-server.AlertType.recoveryActionGroup", "type": "Object", "label": "recoveryActionGroup", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 127 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " | undefined" ] }, { "tags": [], "id": "def-server.AlertType.executor", "type": "Function", "label": "executor", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 128 }, "signature": [ "ExecutorType", ">" ] }, { "tags": [], "id": "def-server.AlertType.producer", "type": "string", "label": "producer", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 139 } }, { "tags": [], "id": "def-server.AlertType.actionVariables", "type": "Object", "label": "actionVariables", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 140 }, "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" ] }, { "tags": [], "id": "def-server.AlertType.minimumLicenseRequired", "type": "CompoundType", "label": "minimumLicenseRequired", "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 145 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ] } ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 112 }, "initialIsOpen": false }, { "id": "def-server.FindResult", "type": "Interface", "label": "FindResult", "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.FindResult", "text": "FindResult" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.FindResult.page", "type": "number", "label": "page", "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 133 } }, { "tags": [], "id": "def-server.FindResult.perPage", "type": "number", "label": "perPage", "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 134 } }, { "tags": [], "id": "def-server.FindResult.total", "type": "number", "label": "total", "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 135 } }, { "tags": [], "id": "def-server.FindResult.data", "type": "Array", "label": "data", "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 136 }, "signature": [ "Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.Alert", "text": "Alert" }, ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]" ] } ], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", "lineNumber": 132 }, "initialIsOpen": false }, { "id": "def-server.PluginSetupContract", "type": "Interface", "label": "PluginSetupContract", "description": [], "tags": [], "children": [ { "id": "def-server.PluginSetupContract.registerType", "type": "Function", "label": "registerType", "signature": [ " = 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" ], "description": [], "children": [ { "id": "def-server.PluginSetupContract.registerType.$1", "type": "Object", "label": "alertType", "isRequired": true, "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertType", "text": "AlertType" }, "" ], "description": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 93 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 85 } } ], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 84 }, "initialIsOpen": false }, { "id": "def-server.PluginStartContract", "type": "Interface", "label": "PluginStartContract", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.PluginStartContract.listTypes", "type": "Function", "label": "listTypes", "description": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 105 }, "signature": [ "() => Set<", "RegistryAlertType", ">" ] }, { "id": "def-server.PluginStartContract.getAlertsClientWithRequest", "type": "Function", "label": "getAlertsClientWithRequest", "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => Pick<", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.AlertsClient", "text": "AlertsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">" ], "description": [], "children": [ { "id": "def-server.PluginStartContract.getAlertsClientWithRequest.$1", "type": "Object", "label": "request", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "description": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 106 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 106 } }, { "tags": [], "id": "def-server.PluginStartContract.getFrameworkHealth", "type": "Function", "label": "getFrameworkHealth", "description": [], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 107 }, "signature": [ "() => Promise<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertsHealth", "text": "AlertsHealth" }, ">" ] } ], "source": { "path": "x-pack/plugins/alerting/server/plugin.ts", "lineNumber": 104 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "id": "def-server.ActionGroupIdsOf", "type": "Type", "label": "ActionGroupIdsOf", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 30 }, "signature": [ "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" ], "initialIsOpen": false }, { "id": "def-server.AlertActionParams", "type": "Type", "label": "AlertActionParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 40 }, "signature": [ "SavedObjectAttributes" ], "initialIsOpen": false }, { "id": "def-server.AlertInstanceContext", "type": "Type", "label": "AlertInstanceContext", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 28 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-server.AlertInstanceState", "type": "Type", "label": "AlertInstanceState", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 25 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-server.AlertsClient", "type": "Type", "label": "AlertsClient", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/server/index.ts", "lineNumber": 15 }, "signature": [ "{ get: ({ id, }: { id: string; }) => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ", "CreateOptions", ") => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: ({ options: { fields, ...options }, }?: { options?: ", "FindOptions", " | undefined; }) => Promise<", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", "section": "def-server.FindResult", "text": "FindResult" } ], "initialIsOpen": false }, { "id": "def-server.AlertTypeParams", "type": "Type", "label": "AlertTypeParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 12 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-server.AlertTypeState", "type": "Type", "label": "AlertTypeState", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 11 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-server.PartialAlert", "type": "Type", "label": "PartialAlert", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", "lineNumber": 178 }, "signature": [ "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" ], "initialIsOpen": false }, { "id": "def-server.PublicAlertInstance", "type": "Type", "label": "PublicAlertInstance", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts", "lineNumber": 30 }, "signature": [ "{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }" ], "initialIsOpen": false } ], "objects": [] }, "common": { "classes": [], "functions": [ { "id": "def-common.getBuiltinActionGroups", "type": "Function", "label": "getBuiltinActionGroups", "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" }, ">]" ], "description": [], "children": [ { "id": "def-common.getBuiltinActionGroups.$1", "type": "Object", "label": "customRecoveryGroup", "isRequired": false, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, " | undefined" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 31 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 30 }, "initialIsOpen": false }, { "id": "def-common.getDurationNumberInItsUnit", "type": "Function", "label": "getDurationNumberInItsUnit", "signature": [ "(duration: string) => number" ], "description": [], "children": [ { "id": "def-common.getDurationNumberInItsUnit.$1", "type": "string", "label": "duration", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 30 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 30 }, "initialIsOpen": false }, { "id": "def-common.getDurationUnitValue", "type": "Function", "label": "getDurationUnitValue", "signature": [ "(duration: string) => string" ], "description": [], "children": [ { "id": "def-common.getDurationUnitValue.$1", "type": "string", "label": "duration", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 34 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-common.isActionGroupDisabledForActionTypeId", "type": "Function", "label": "isActionGroupDisabledForActionTypeId", "signature": [ "(actionGroup: string, actionTypeId: string) => boolean" ], "description": [], "children": [ { "id": "def-common.isActionGroupDisabledForActionTypeId.$1", "type": "string", "label": "actionGroup", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "lineNumber": 19 } }, { "id": "def-common.isActionGroupDisabledForActionTypeId.$2", "type": "string", "label": "actionTypeId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "lineNumber": 20 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "lineNumber": 18 }, "initialIsOpen": false }, { "id": "def-common.parseDuration", "type": "Function", "label": "parseDuration", "signature": [ "(duration: string) => number" ], "description": [], "children": [ { "id": "def-common.parseDuration.$1", "type": "string", "label": "duration", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 14 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-common.validateDurationSchema", "type": "Function", "label": "validateDurationSchema", "signature": [ "(duration: string) => string | undefined" ], "description": [], "children": [ { "id": "def-common.validateDurationSchema.$1", "type": "string", "label": "duration", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 39 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", "lineNumber": 39 }, "initialIsOpen": false }, { "id": "def-common.validateNotifyWhenType", "type": "Function", "label": "validateNotifyWhenType", "signature": [ "(notifyWhen: string) => string | undefined" ], "description": [], "children": [ { "id": "def-common.validateNotifyWhenType.$1", "type": "string", "label": "notifyWhen", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "lineNumber": 15 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "lineNumber": 15 }, "initialIsOpen": false } ], "interfaces": [ { "id": "def-common.ActionGroup", "type": "Interface", "label": "ActionGroup", "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ActionGroup.id", "type": "Uncategorized", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 26 }, "signature": [ "ActionGroupIds" ] }, { "tags": [], "id": "def-common.ActionGroup.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 27 } } ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 25 }, "initialIsOpen": false }, { "id": "def-common.ActionVariable", "type": "Interface", "label": "ActionVariable", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ActionVariable.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 102 } }, { "tags": [], "id": "def-common.ActionVariable.description", "type": "string", "label": "description", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 103 } }, { "tags": [], "id": "def-common.ActionVariable.deprecated", "type": "CompoundType", "label": "deprecated", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 104 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.ActionVariable.useWithTripleBracesInTemplates", "type": "CompoundType", "label": "useWithTripleBracesInTemplates", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 105 }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 101 }, "initialIsOpen": false }, { "id": "def-common.Alert", "type": "Interface", "label": "Alert", "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.Alert", "text": "Alert" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.Alert.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 55 } }, { "tags": [], "id": "def-common.Alert.enabled", "type": "boolean", "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 56 } }, { "tags": [], "id": "def-common.Alert.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-common.Alert.tags", "type": "Array", "label": "tags", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 58 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.Alert.alertTypeId", "type": "string", "label": "alertTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 59 } }, { "tags": [], "id": "def-common.Alert.consumer", "type": "string", "label": "consumer", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 60 } }, { "tags": [], "id": "def-common.Alert.schedule", "type": "Object", "label": "schedule", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 61 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.IntervalSchedule", "text": "IntervalSchedule" } ] }, { "tags": [], "id": "def-common.Alert.actions", "type": "Array", "label": "actions", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 62 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertAction", "text": "AlertAction" }, "[]" ] }, { "tags": [], "id": "def-common.Alert.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 63 }, "signature": [ "Params" ] }, { "tags": [], "id": "def-common.Alert.scheduledTaskId", "type": "string", "label": "scheduledTaskId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 64 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.Alert.createdBy", "type": "CompoundType", "label": "createdBy", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 65 }, "signature": [ "string | null" ] }, { "tags": [], "id": "def-common.Alert.updatedBy", "type": "CompoundType", "label": "updatedBy", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 66 }, "signature": [ "string | null" ] }, { "tags": [], "id": "def-common.Alert.createdAt", "type": "Object", "label": "createdAt", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 67 }, "signature": [ "Date" ] }, { "tags": [], "id": "def-common.Alert.updatedAt", "type": "Object", "label": "updatedAt", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 68 }, "signature": [ "Date" ] }, { "tags": [], "id": "def-common.Alert.apiKey", "type": "CompoundType", "label": "apiKey", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 69 }, "signature": [ "string | null" ] }, { "tags": [], "id": "def-common.Alert.apiKeyOwner", "type": "CompoundType", "label": "apiKeyOwner", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 70 }, "signature": [ "string | null" ] }, { "tags": [], "id": "def-common.Alert.throttle", "type": "CompoundType", "label": "throttle", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 71 }, "signature": [ "string | null" ] }, { "tags": [], "id": "def-common.Alert.notifyWhen", "type": "CompoundType", "label": "notifyWhen", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 72 }, "signature": [ "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" ] }, { "tags": [], "id": "def-common.Alert.muteAll", "type": "boolean", "label": "muteAll", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 73 } }, { "tags": [], "id": "def-common.Alert.mutedInstanceIds", "type": "Array", "label": "mutedInstanceIds", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 74 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.Alert.executionStatus", "type": "Object", "label": "executionStatus", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 75 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertExecutionStatus", "text": "AlertExecutionStatus" } ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-common.AlertAction", "type": "Interface", "label": "AlertAction", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertAction.group", "type": "string", "label": "group", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 44 } }, { "tags": [], "id": "def-common.AlertAction.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 45 } }, { "tags": [], "id": "def-common.AlertAction.actionTypeId", "type": "string", "label": "actionTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 46 } }, { "tags": [], "id": "def-common.AlertAction.params", "type": "Object", "label": "params", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 47 }, "signature": [ "SavedObjectAttributes" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 43 }, "initialIsOpen": false }, { "id": "def-common.AlertAggregations", "type": "Interface", "label": "AlertAggregations", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertAggregations.alertExecutionStatus", "type": "Object", "label": "alertExecutionStatus", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 51 }, "signature": [ "{ [status: string]: number; }" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 50 }, "initialIsOpen": false }, { "id": "def-common.AlertExecutionStatus", "type": "Interface", "label": "AlertExecutionStatus", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertExecutionStatus.status", "type": "CompoundType", "label": "status", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 32 }, "signature": [ "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" ] }, { "tags": [], "id": "def-common.AlertExecutionStatus.lastExecutionDate", "type": "Object", "label": "lastExecutionDate", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 33 }, "signature": [ "Date" ] }, { "tags": [], "id": "def-common.AlertExecutionStatus.error", "type": "Object", "label": "error", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 34 }, "signature": [ "{ reason: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertExecutionStatusErrorReasons", "text": "AlertExecutionStatusErrorReasons" }, "; message: string; } | undefined" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 31 }, "initialIsOpen": false }, { "id": "def-common.AlertingFrameworkHealth", "type": "Interface", "label": "AlertingFrameworkHealth", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", "type": "boolean", "label": "isSufficientlySecure", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 22 } }, { "tags": [], "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", "type": "boolean", "label": "hasPermanentEncryptionKey", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 23 } }, { "tags": [], "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHeath", "type": "Object", "label": "alertingFrameworkHeath", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 24 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertsHealth", "text": "AlertsHealth" } ] } ], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 21 }, "initialIsOpen": false }, { "id": "def-common.AlertInstanceStatus", "type": "Interface", "label": "AlertInstanceStatus", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertInstanceStatus.status", "type": "CompoundType", "label": "status", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 29 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertInstanceStatusValues", "text": "AlertInstanceStatusValues" } ] }, { "tags": [], "id": "def-common.AlertInstanceStatus.muted", "type": "boolean", "label": "muted", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 30 } }, { "tags": [], "id": "def-common.AlertInstanceStatus.actionGroupId", "type": "string", "label": "actionGroupId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 31 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AlertInstanceStatus.actionSubgroup", "type": "string", "label": "actionSubgroup", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 32 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AlertInstanceStatus.activeStartDate", "type": "string", "label": "activeStartDate", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 33 }, "signature": [ "string | undefined" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 28 }, "initialIsOpen": false }, { "id": "def-common.AlertInstanceSummary", "type": "Interface", "label": "AlertInstanceSummary", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertInstanceSummary.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 12 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 13 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.tags", "type": "Array", "label": "tags", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 14 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.AlertInstanceSummary.alertTypeId", "type": "string", "label": "alertTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 15 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.consumer", "type": "string", "label": "consumer", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 16 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.muteAll", "type": "boolean", "label": "muteAll", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.throttle", "type": "CompoundType", "label": "throttle", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 18 }, "signature": [ "string | null" ] }, { "tags": [], "id": "def-common.AlertInstanceSummary.enabled", "type": "boolean", "label": "enabled", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 19 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.statusStartDate", "type": "string", "label": "statusStartDate", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 20 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.statusEndDate", "type": "string", "label": "statusEndDate", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 21 } }, { "tags": [], "id": "def-common.AlertInstanceSummary.status", "type": "CompoundType", "label": "status", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 22 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertStatusValues", "text": "AlertStatusValues" } ] }, { "tags": [], "id": "def-common.AlertInstanceSummary.lastRun", "type": "string", "label": "lastRun", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 23 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AlertInstanceSummary.errorMessages", "type": "Array", "label": "errorMessages", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 24 }, "signature": [ "{ date: string; message: string; }[]" ] }, { "tags": [], "id": "def-common.AlertInstanceSummary.instances", "type": "Object", "label": "instances", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 25 }, "signature": [ "Record" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-common.AlertsHealth", "type": "Interface", "label": "AlertsHealth", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertsHealth.decryptionHealth", "type": "Object", "label": "decryptionHealth", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 87 }, "signature": [ "{ status: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.HealthStatus", "text": "HealthStatus" }, "; timestamp: string; }" ] }, { "tags": [], "id": "def-common.AlertsHealth.executionHealth", "type": "Object", "label": "executionHealth", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 91 }, "signature": [ "{ status: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.HealthStatus", "text": "HealthStatus" }, "; timestamp: string; }" ] }, { "tags": [], "id": "def-common.AlertsHealth.readHealth", "type": "Object", "label": "readHealth", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 95 }, "signature": [ "{ status: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.HealthStatus", "text": "HealthStatus" }, "; timestamp: string; }" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 86 }, "initialIsOpen": false }, { "id": "def-common.AlertStateNavigation", "type": "Interface", "label": "AlertStateNavigation", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertStateNavigation.state", "type": "Object", "label": "state", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "lineNumber": 14 }, "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.JsonObject", "text": "JsonObject" } ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "lineNumber": 13 }, "initialIsOpen": false }, { "id": "def-common.AlertType", "type": "Interface", "label": "AlertType", "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.AlertType", "text": "AlertType" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertType.id", "type": "string", "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 15 } }, { "tags": [], "id": "def-common.AlertType.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 16 } }, { "tags": [], "id": "def-common.AlertType.actionGroups", "type": "Array", "label": "actionGroups", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 17 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "[]" ] }, { "tags": [], "id": "def-common.AlertType.recoveryActionGroup", "type": "Object", "label": "recoveryActionGroup", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 18 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "" ] }, { "tags": [], "id": "def-common.AlertType.actionVariables", "type": "Array", "label": "actionVariables", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 19 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.AlertType.defaultActionGroupId", "type": "Uncategorized", "label": "defaultActionGroupId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 20 }, "signature": [ "ActionGroupIds" ] }, { "tags": [], "id": "def-common.AlertType.producer", "type": "string", "label": "producer", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 21 } }, { "tags": [], "id": "def-common.AlertType.minimumLicenseRequired", "type": "CompoundType", "label": "minimumLicenseRequired", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 22 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-common.AlertUrlNavigation", "type": "Interface", "label": "AlertUrlNavigation", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AlertUrlNavigation.path", "type": "string", "label": "path", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "lineNumber": 11 } } ], "source": { "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "lineNumber": 10 }, "initialIsOpen": false }, { "id": "def-common.IntervalSchedule", "type": "Interface", "label": "IntervalSchedule", "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.IntervalSchedule", "text": "IntervalSchedule" }, " extends ", "SavedObjectAttributes" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IntervalSchedule.interval", "type": "string", "label": "interval", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 15 } } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 14 }, "initialIsOpen": false } ], "enums": [ { "id": "def-common.AlertExecutionStatusErrorReasons", "type": "Enum", "label": "AlertExecutionStatusErrorReasons", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-common.HealthStatus", "type": "Enum", "label": "HealthStatus", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 80 }, "initialIsOpen": false } ], "misc": [ { "id": "def-common.ActionGroupIdsOf", "type": "Type", "label": "ActionGroupIdsOf", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", "lineNumber": 30 }, "signature": [ "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" ], "initialIsOpen": false }, { "id": "def-common.AlertActionParam", "type": "Type", "label": "AlertActionParam", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 41 }, "signature": [ "undefined | null | string | number | false | true | ", "SavedObjectAttributes", " | ", "SavedObjectAttributeSingle", "[]" ], "initialIsOpen": false }, { "id": "def-common.AlertActionParams", "type": "Type", "label": "AlertActionParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 40 }, "signature": [ "SavedObjectAttributes" ], "initialIsOpen": false }, { "id": "def-common.AlertExecutionStatuses", "type": "Type", "label": "AlertExecutionStatuses", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 21 }, "signature": [ "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" ], "initialIsOpen": false }, { "id": "def-common.AlertInstanceContext", "type": "Type", "label": "AlertInstanceContext", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 28 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-common.AlertInstanceMeta", "type": "Type", "label": "AlertInstanceMeta", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 22 }, "signature": [ "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.AlertInstanceState", "type": "Type", "label": "AlertInstanceState", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 25 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-common.AlertInstanceStatusValues", "type": "Type", "label": "AlertInstanceStatusValues", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 9 }, "signature": [ "\"OK\" | \"Active\"" ], "initialIsOpen": false }, { "id": "def-common.AlertNavigation", "type": "Type", "label": "AlertNavigation", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_navigation.ts", "lineNumber": 16 }, "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" } ], "initialIsOpen": false }, { "id": "def-common.AlertNotifyWhenType", "type": "Type", "label": "AlertNotifyWhenType", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", "lineNumber": 13 }, "signature": [ "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.ALERTS_FEATURE_ID", "type": "string", "label": "ALERTS_FEATURE_ID", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 30 }, "signature": [ "\"alerts\"" ], "initialIsOpen": false }, { "id": "def-common.AlertStatusValues", "type": "Type", "label": "AlertStatusValues", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", "lineNumber": 8 }, "signature": [ "\"OK\" | \"Active\" | \"Error\"" ], "initialIsOpen": false }, { "id": "def-common.AlertTaskParams", "type": "Type", "label": "AlertTaskParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "lineNumber": 28 }, "signature": [ "{ alertId: string; } & { spaceId?: string | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.AlertTaskState", "type": "Type", "label": "AlertTaskState", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "lineNumber": 18 }, "signature": [ "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.AlertTypeParams", "type": "Type", "label": "AlertTypeParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 12 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "id": "def-common.AlertTypeState", "type": "Type", "label": "AlertTypeState", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 11 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.BASE_ALERTING_API_PATH", "type": "string", "label": "BASE_ALERTING_API_PATH", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 28 }, "signature": [ "\"/api/alerting\"" ], "initialIsOpen": false }, { "id": "def-common.DefaultActionGroupId", "type": "Type", "label": "DefaultActionGroupId", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 11 }, "signature": [ "\"default\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.INTERNAL_BASE_ALERTING_API_PATH", "type": "string", "label": "INTERNAL_BASE_ALERTING_API_PATH", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 29 }, "signature": [ "\"/internal/alerting\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.LEGACY_BASE_ALERT_API_PATH", "type": "string", "label": "LEGACY_BASE_ALERT_API_PATH", "description": [], "source": { "path": "x-pack/plugins/alerting/common/index.ts", "lineNumber": 27 }, "signature": [ "\"/api/alerts\"" ], "initialIsOpen": false }, { "id": "def-common.RawAlertInstance", "type": "Type", "label": "RawAlertInstance", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 34 }, "signature": [ "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.RecoveredActionGroupId", "type": "Type", "label": "RecoveredActionGroupId", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 13 }, "signature": [ "\"recovered\"" ], "initialIsOpen": false }, { "id": "def-common.ReservedActionGroups", "type": "Type", "label": "ReservedActionGroups", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 21 }, "signature": [ "RecoveryActionGroupId | \"recovered\"" ], "initialIsOpen": false }, { "id": "def-common.SanitizedAlert", "type": "Type", "label": "SanitizedAlert", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 78 }, "signature": [ "{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }" ], "initialIsOpen": false }, { "id": "def-common.WithoutReservedActionGroups", "type": "Type", "label": "WithoutReservedActionGroups", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 25 }, "signature": [ "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" ], "initialIsOpen": false } ], "objects": [ { "tags": [], "id": "def-common.AlertExecutionStatusValues", "type": "Object", "label": "AlertExecutionStatusValues", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", "lineNumber": 20 }, "signature": [ "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.alertParamsSchema", "type": "Object", "label": "alertParamsSchema", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "lineNumber": 20 }, "signature": [ "IntersectionC", "<[", "TypeC", "<{ alertId: ", "StringC", "; }>, ", "PartialC", "<{ spaceId: ", "StringC" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.alertStateSchema", "type": "Object", "label": "alertStateSchema", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", "lineNumber": 12 }, "signature": [ "PartialC", "<{ alertTypeState: ", "RecordC", "<", "StringC", ", ", "UnknownC", ">; alertInstances: ", "RecordC" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.DisabledActionTypeIdsForActionGroup", "type": "Object", "label": "DisabledActionTypeIdsForActionGroup", "description": [], "source": { "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "lineNumber": 14 }, "signature": [ "Map" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.rawAlertInstance", "type": "Object", "label": "rawAlertInstance", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance.ts", "lineNumber": 30 }, "signature": [ "PartialC", "<{ state: ", "RecordC", "<", "StringC", ", ", "UnknownC", ">; meta: ", "PartialC" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.RecoveredActionGroup", "type": "Object", "label": "RecoveredActionGroup", "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "lineNumber": 14 }, "signature": [ "Readonly<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", "section": "def-common.ActionGroup", "text": "ActionGroup" }, "<\"recovered\">>" ], "initialIsOpen": false } ] } }