github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/rule_registry.devdocs.json

4834 lines
No EOL
242 KiB
JSON
Raw Blame History

{
"id": "ruleRegistry",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient",
"type": "Class",
"tags": [],
"label": "AlertsClient",
"description": [
"\nProvides apis to interact with alerts as data\nensures the request is authorized to perform read / write actions\non alerts as data."
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ConstructorOptions"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.ensureAllAlertsAuthorizedRead",
"type": "Function",
"tags": [],
"label": "ensureAllAlertsAuthorizedRead",
"description": [],
"signature": [
"({ alerts }: { alerts: MgetAndAuditAlert[]; }) => Promise<void>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.ensureAllAlertsAuthorizedRead.$1",
"type": "Object",
"tags": [],
"label": "{ alerts }",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.ensureAllAlertsAuthorizedRead.$1.alerts",
"type": "Array",
"tags": [],
"label": "alerts",
"description": [],
"signature": [
"MgetAndAuditAlert[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"({ id, index }: GetAlertParams) => Promise<{ _index: string; \"@timestamp\"?: string | undefined; \"kibana.alert.rule.rule_type_id\"?: string | undefined; \"kibana.alert.rule.consumer\"?: string | undefined; \"kibana.alert.instance.id\"?: string | undefined; \"kibana.alert.rule.category\"?: string | undefined; \"kibana.alert.rule.name\"?: string | undefined; \"kibana.alert.rule.producer\"?: string | undefined; \"kibana.alert.rule.revision\"?: number | undefined; \"kibana.alert.rule.uuid\"?: string | undefined; \"kibana.alert.status\"?: string | undefined; \"kibana.alert.uuid\"?: string | undefined; \"kibana.space_ids\"?: string[] | undefined; \"event.action\"?: string | undefined; tags?: string[] | undefined; \"kibana.alert.rule.execution.uuid\"?: string | undefined; \"event.kind\"?: string | undefined; \"event.original\"?: string | undefined; \"kibana.alert.action_group\"?: string | undefined; \"kibana.alert.case_ids\"?: string[] | undefined; \"kibana.alert.consecutive_matches\"?: number | undefined; \"kibana.alert.duration.us\"?: number | undefined; \"kibana.alert.end\"?: string | undefined; \"kibana.alert.flapping\"?: boolean | undefined; \"kibana.alert.flapping_history\"?: boolean[] | undefined; \"kibana.alert.intended_timestamp\"?: string | undefined; \"kibana.alert.last_detected\"?: string | undefined; \"kibana.alert.maintenance_window_ids\"?: string[] | undefined; \"kibana.alert.previous_action_group\"?: string | undefined; \"kibana.alert.reason\"?: string | undefined; \"kibana.alert.rule.execution.timestamp\"?: string | undefined; \"kibana.alert.rule.execution.type\"?: string | undefined; \"kibana.alert.rule.parameters\"?: { [key: string]: unknown; } | undefined; \"kibana.alert.rule.tags\"?: string[] | undefined; \"kibana.alert.severity_improving\"?: boolean | undefined; \"kibana.alert.start\"?: string | undefined; \"kibana.alert.time_range\"?: unknown; \"kibana.alert.url\"?: string | undefined; \"kibana.alert.workflow_assignee_ids\"?: string[] | undefined; \"kibana.alert.workflow_status\"?: string | undefined; \"kibana.alert.workflow_tags\"?: string[] | undefined; \"kibana.version\"?: string | undefined; \"ecs.version\"?: string | undefined; \"kibana.alert.risk_score\"?: number | undefined; \"kibana.alert.rule.author\"?: string | undefined; \"kibana.alert.rule.created_at\"?: string | undefined; \"kibana.alert.rule.created_by\"?: string | undefined; \"kibana.alert.rule.description\"?: string | undefined; \"kibana.alert.rule.enabled\"?: string | undefined; \"kibana.alert.rule.from\"?: string | undefined; \"kibana.alert.rule.interval\"?: string | undefined; \"kibana.alert.rule.license\"?: string | undefined; \"kibana.alert.rule.note\"?: string | undefined; \"kibana.alert.rule.references\"?: string[] | undefined; \"kibana.alert.rule.rule_id\"?: string | undefined; \"kibana.alert.rule.rule_name_override\"?: string | undefined; \"kibana.alert.rule.to\"?: string | undefined; \"kibana.alert.rule.type\"?: string | undefined; \"kibana.alert.rule.updated_at\"?: string | undefined; \"kibana.alert.rule.updated_by\"?: string | undefined; \"kibana.alert.rule.version\"?: string | undefined; \"kibana.alert.severity\"?: string | undefined; \"kibana.alert.suppression.docs_count\"?: number | undefined; \"kibana.alert.suppression.end\"?: string | undefined; \"kibana.alert.suppression.start\"?: string | undefined; \"kibana.alert.suppression.terms.field\"?: string[] | undefined; \"kibana.alert.suppression.terms.value\"?: string[] | undefined; \"kibana.alert.system_status\"?: string | undefined; \"kibana.alert.workflow_reason\"?: string | undefined; \"kibana.alert.workflow_status_updated_at\"?: string | undefined; \"kibana.alert.workflow_user\"?: string | undefined; }>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.get.$1",
"type": "Object",
"tags": [],
"label": "{ id, index }",
"description": [],
"signature": [
"GetAlertParams"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getAlertSummary",
"type": "Function",
"tags": [],
"label": "getAlertSummary",
"description": [],
"signature": [
"({ gte, lte, ruleTypeIds, consumers, filter, fixedInterval, }: GetAlertSummaryParams) => Promise<{ activeAlertCount: number; recoveredAlertCount: number; activeAlerts: ",
"AggregationsBuckets",
"<",
"AggregationsDateHistogramBucket",
">; recoveredAlerts: ",
"AggregationsBuckets",
"<",
"AggregationsDateHistogramBucket",
">; }>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getAlertSummary.$1",
"type": "Object",
"tags": [],
"label": "{\n gte,\n lte,\n ruleTypeIds,\n consumers,\n filter,\n fixedInterval = '1m',\n }",
"description": [],
"signature": [
"GetAlertSummaryParams"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [],
"signature": [
"<Params extends ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>({ id, status, _version, index, }: ",
"UpdateOptions",
"<Params>) => Promise<{ _version: string | undefined; get?: ",
"InlineGet",
"<unknown> | undefined; _id: string; _index: string; _primary_term?: number | undefined; result: ",
"Result",
"; _seq_no?: number | undefined; _shards: ",
"ShardStatistics",
"; forced_refresh?: boolean | undefined; }>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.update.$1",
"type": "Object",
"tags": [],
"label": "{\n id,\n status,\n _version,\n index,\n }",
"description": [],
"signature": [
"UpdateOptions",
"<Params>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.bulkUpdate",
"type": "Function",
"tags": [],
"label": "bulkUpdate",
"description": [],
"signature": [
"<Params extends ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>({ ids, query, index, status, }: ",
"BulkUpdateOptions",
"<Params>) => Promise<",
"BulkResponse",
" | ",
"UpdateByQueryResponse",
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.bulkUpdate.$1",
"type": "Object",
"tags": [],
"label": "{\n ids,\n query,\n index,\n status,\n }",
"description": [],
"signature": [
"BulkUpdateOptions",
"<Params>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.bulkUpdateCases",
"type": "Function",
"tags": [],
"label": "bulkUpdateCases",
"description": [
"\nThis function updates the case ids of multiple alerts per index.\nIt is supposed to be used only by Cases.\nCases implements its own RBAC. By using this function directly\nCases RBAC is bypassed.\nPlugins that want to attach alerts to a case should use the\ncases client that does all the necessary cases RBAC checks\nbefore updating the alert with the case ids."
],
"signature": [
"({ alerts, caseIds }: ",
"BulkUpdateCasesOptions",
") => Promise<",
"BulkResponse",
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.bulkUpdateCases.$1",
"type": "Object",
"tags": [],
"label": "{ alerts, caseIds }",
"description": [],
"signature": [
"BulkUpdateCasesOptions"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.removeCaseIdFromAlerts",
"type": "Function",
"tags": [],
"label": "removeCaseIdFromAlerts",
"description": [],
"signature": [
"({ caseId, alerts }: ",
"RemoveCaseIdFromAlertsOptions",
") => Promise<void>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.removeCaseIdFromAlerts.$1",
"type": "Object",
"tags": [],
"label": "{ caseId, alerts }",
"description": [],
"signature": [
"RemoveCaseIdFromAlertsOptions"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.removeCaseIdsFromAllAlerts",
"type": "Function",
"tags": [],
"label": "removeCaseIdsFromAllAlerts",
"description": [],
"signature": [
"({ caseIds }: { caseIds: string[]; }) => Promise<void>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.removeCaseIdsFromAllAlerts.$1",
"type": "Object",
"tags": [],
"label": "{ caseIds }",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.removeCaseIdsFromAllAlerts.$1.caseIds",
"type": "Array",
"tags": [],
"label": "caseIds",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find",
"type": "Function",
"tags": [],
"label": "find",
"description": [],
"signature": [
"<Params extends ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never, TAggregations = Record<string, ",
"AggregationsAggregate",
">>({ aggs, ruleTypeIds, consumers, index, query, search_after: searchAfter, size, sort, track_total_hits: trackTotalHits, _source, runtimeMappings, }: { aggs?: object | undefined; ruleTypeIds?: string[] | undefined; consumers?: string[] | undefined; index?: string | undefined; query?: object | undefined; search_after?: (string | number)[] | undefined; size?: number | undefined; sort?: ",
"SortOptions",
"[] | undefined; track_total_hits?: number | boolean | undefined; _source?: false | string[] | undefined; runtimeMappings?: ",
"MappingRuntimeFields",
" | undefined; }) => Promise<",
"SearchResponse",
"<OutputOf<SetOptional<{ readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.description\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.enabled\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.from\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.interval\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.license\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.note\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.references\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.rule_name_override\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.to\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.docs_count\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.suppression.terms.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status_updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"@timestamp\": { readonly type: \"date\"; readonly required: true; readonly array: false; }; readonly \"event.action\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.execution.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.revision\": { readonly type: \"long\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"event.kind\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"event.original\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"kibana.alert.action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.case_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.consecutive_matches\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping_history\": { readonly type: \"boolean\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.intended_timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.last_detected\": { readonly type: \"date\"; readonly required: false; readonly array: false; }; readonly \"kibana.alert.maintenance_window_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.previous_action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly multi_fields: ",
{
"pluginId": "@kbn/alerts-as-data-utils",
"scope": "common",
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
"section": "def-common.MultiField",
"text": "MultiField"
},
"[]; }; readonly \"kibana.alert.rule.execution.timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.execution.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.parameters\": { readonly array: false; readonly type: \"flattened\"; readonly ignore_above: 4096; readonly required: false; }; readonly \"kibana.alert.rule.tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.severity_improving\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.time_range\": { readonly type: \"date_range\"; readonly format: \"epoch_millis||strict_date_optional_time\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.url\": { readonly type: \"keyword\"; readonly array: false; readonly index: false; readonly required: false; readonly ignore_above: 2048; }; readonly \"kibana.alert.workflow_assignee_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; }>>, TAggregations>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1",
"type": "Object",
"tags": [],
"label": "{\n aggs,\n ruleTypeIds,\n consumers,\n index,\n query,\n search_after: searchAfter,\n size,\n sort,\n track_total_hits: trackTotalHits,\n _source,\n runtimeMappings,\n }",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.aggs",
"type": "Uncategorized",
"tags": [],
"label": "aggs",
"description": [],
"signature": [
"object | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.ruleTypeIds",
"type": "Array",
"tags": [],
"label": "ruleTypeIds",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.consumers",
"type": "Array",
"tags": [],
"label": "consumers",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.index",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.query",
"type": "Uncategorized",
"tags": [],
"label": "query",
"description": [],
"signature": [
"object | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.search_after",
"type": "Array",
"tags": [],
"label": "search_after",
"description": [],
"signature": [
"(string | number)[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.size",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"SortOptions",
"[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.track_total_hits",
"type": "CompoundType",
"tags": [],
"label": "track_total_hits",
"description": [],
"signature": [
"number | boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1._source",
"type": "CompoundType",
"tags": [],
"label": "_source",
"description": [],
"signature": [
"false | string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.find.$1.runtimeMappings",
"type": "Object",
"tags": [],
"label": "runtimeMappings",
"description": [],
"signature": [
"MappingRuntimeFields",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations",
"type": "Function",
"tags": [],
"label": "getGroupAggregations",
"description": [
"\nPerforms a `find` query to extract aggregations on alert groups"
],
"signature": [
"({ ruleTypeIds, consumers, groupByField, aggregations, filters, pageIndex, pageSize, sort, }: { ruleTypeIds: string[]; consumers?: string[] | undefined; groupByField: string; aggregations?: { [x: string]: { avg?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; cardinality?: { field?: string | undefined; precision_threshold?: number | undefined; rehash?: boolean | undefined; missing?: string | number | boolean | undefined; } | undefined; min?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; max?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; sum?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; top_hits?: { explain?: boolean | undefined; docvalue_fields?: string | string[] | undefined; stored_fields?: string | string[] | undefined; from?: number | undefined; size?: number | undefined; sort?: string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; } | (string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; })[] | undefined; seq_no_primary_term?: boolean | undefined; version?: boolean | undefined; track_scores?: boolean | undefined; highlight?: any; _source?: string | boolean | string[] | undefined; } | undefined; weighted_avg?: { format?: string | undefined; value_type?: string | undefined; value?: { field?: string | undefined; missing?: number | undefined; } | undefined; weight?: { field?: string | undefined; missing?: number | undefined; } | undefined; } | undefined; } & BucketAggsSchemas & { aggs?: { [x: string]: BucketAggsSchemas & { avg?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; cardinality?: { field?: string | undefined; precision_threshold?: number | undefined; rehash?: boolean | undefined; missing?: string | number | boolean | undefined; } | undefined; min?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; max?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; sum?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; top_hits?: { explain?: boolean | undefined; docvalue_fields?: string | string[] | undefined; stored_fields?: string | string[] | undefined; from?: number | undefined; size?: number | undefined; sort?: string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; } | (string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; })[] | undefined; seq_no_primary_term?: boolean | undefined; version?: boolean | undefined; track_scores?: boolean | undefined; highlight?: any; _source?: string | boolean | string[] | undefined; } | undefined; weighted_avg?: { format?: string | undefined; value_type?: string | undefined; value?: { field?: string | undefined; missing?: number | undefined; } | undefined; weight?: { field?: string | undefined; missing?: number | undefined; } | undefined; } | undefined; }; } | undefined; aggregations?: { [x: string]: BucketAggsSchemas & { avg?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; cardinality?: { field?: string | undefined; precision_threshold?: number | undefined; rehash?: boolean | undefined; missing?: string | number | boolean | undefined; } | undefined; min?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; max?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; sum?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; top_hits?: { explain?: boolean | undefined; docvalue_fields?: string | string[] | undefined; stored_fields?: string | string[] | undefined; from?: number | undefined; size?: number | undefined; sort?: string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; } | (string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; })[] | undefined; seq_no_primary_term?: boolean | undefined; version?: boolean | undefined; track_scores?: boolean | undefined; highlight?: any; _source?: string | boolean | string[] | undefined; } | undefined; weighted_avg?: { format?: string | undefined; value_type?: string | undefined; value?: { field?: string | undefined; missing?: number | undefined; } | undefined; weight?: { field?: string | undefined; missing?: number | undefined; } | undefined; } | undefined; }; } | undefined; }; } | undefined; filters?: ",
"QueryDslQueryContainer",
"[] | undefined; sort?: ",
"SortCombinations",
"[] | undefined; pageIndex: number; pageSize: number; }) => Promise<",
"SearchResponse",
"<OutputOf<SetOptional<{ readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.description\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.enabled\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.from\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.interval\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.license\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.note\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.references\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.rule_name_override\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.to\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.docs_count\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.suppression.terms.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status_updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"@timestamp\": { readonly type: \"date\"; readonly required: true; readonly array: false; }; readonly \"event.action\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.execution.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.revision\": { readonly type: \"long\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"event.kind\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"event.original\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"kibana.alert.action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.case_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.consecutive_matches\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping_history\": { readonly type: \"boolean\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.intended_timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.last_detected\": { readonly type: \"date\"; readonly required: false; readonly array: false; }; readonly \"kibana.alert.maintenance_window_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.previous_action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly multi_fields: ",
{
"pluginId": "@kbn/alerts-as-data-utils",
"scope": "common",
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
"section": "def-common.MultiField",
"text": "MultiField"
},
"[]; }; readonly \"kibana.alert.rule.execution.timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.execution.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.parameters\": { readonly array: false; readonly type: \"flattened\"; readonly ignore_above: 4096; readonly required: false; }; readonly \"kibana.alert.rule.tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.severity_improving\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.time_range\": { readonly type: \"date_range\"; readonly format: \"epoch_millis||strict_date_optional_time\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.url\": { readonly type: \"keyword\"; readonly array: false; readonly index: false; readonly required: false; readonly ignore_above: 2048; }; readonly \"kibana.alert.workflow_assignee_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; }>>, { groupByFields: ",
"AggregationsMultiBucketAggregateBase",
"<{ key: string; }>; }>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1",
"type": "Object",
"tags": [],
"label": "{\n ruleTypeIds,\n consumers,\n groupByField,\n aggregations,\n filters,\n pageIndex,\n pageSize,\n sort = [{ unitsCount: { order: 'desc' } }],\n }",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.ruleTypeIds",
"type": "Array",
"tags": [],
"label": "ruleTypeIds",
"description": [
"\nThe rule type IDs the alerts belong to.\nUsed for filtering."
],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.consumers",
"type": "Array",
"tags": [],
"label": "consumers",
"description": [
"\nThe consumers the alerts belong to.\nUsed for filtering."
],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.groupByField",
"type": "string",
"tags": [],
"label": "groupByField",
"description": [
"\nThe field to group by"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.aggregations",
"type": "Object",
"tags": [],
"label": "aggregations",
"description": [
"\nThe aggregations to perform on the groupByField buckets"
],
"signature": [
"{ [x: string]: { avg?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; cardinality?: { field?: string | undefined; precision_threshold?: number | undefined; rehash?: boolean | undefined; missing?: string | number | boolean | undefined; } | undefined; min?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; max?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; sum?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; top_hits?: { explain?: boolean | undefined; docvalue_fields?: string | string[] | undefined; stored_fields?: string | string[] | undefined; from?: number | undefined; size?: number | undefined; sort?: string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; } | (string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; })[] | undefined; seq_no_primary_term?: boolean | undefined; version?: boolean | undefined; track_scores?: boolean | undefined; highlight?: any; _source?: string | boolean | string[] | undefined; } | undefined; weighted_avg?: { format?: string | undefined; value_type?: string | undefined; value?: { field?: string | undefined; missing?: number | undefined; } | undefined; weight?: { field?: string | undefined; missing?: number | undefined; } | undefined; } | undefined; } & BucketAggsSchemas & { aggs?: { [x: string]: BucketAggsSchemas & { avg?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; cardinality?: { field?: string | undefined; precision_threshold?: number | undefined; rehash?: boolean | undefined; missing?: string | number | boolean | undefined; } | undefined; min?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; max?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; sum?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; top_hits?: { explain?: boolean | undefined; docvalue_fields?: string | string[] | undefined; stored_fields?: string | string[] | undefined; from?: number | undefined; size?: number | undefined; sort?: string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; } | (string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; })[] | undefined; seq_no_primary_term?: boolean | undefined; version?: boolean | undefined; track_scores?: boolean | undefined; highlight?: any; _source?: string | boolean | string[] | undefined; } | undefined; weighted_avg?: { format?: string | undefined; value_type?: string | undefined; value?: { field?: string | undefined; missing?: number | undefined; } | undefined; weight?: { field?: string | undefined; missing?: number | undefined; } | undefined; } | undefined; }; } | undefined; aggregations?: { [x: string]: BucketAggsSchemas & { avg?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; cardinality?: { field?: string | undefined; precision_threshold?: number | undefined; rehash?: boolean | undefined; missing?: string | number | boolean | undefined; } | undefined; min?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; max?: { field?: string | undefined; missing?: string | number | boolean | undefined; format?: string | undefined; } | undefined; sum?: { field?: string | undefined; missing?: string | number | boolean | undefined; } | undefined; top_hits?: { explain?: boolean | undefined; docvalue_fields?: string | string[] | undefined; stored_fields?: string | string[] | undefined; from?: number | undefined; size?: number | undefined; sort?: string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; } | (string | { [x: string]: \"asc\" | \"desc\" | \"_doc\" | { missing?: string | number | boolean | undefined; mode?: \"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | undefined; order?: \"asc\" | \"desc\" | \"_doc\" | undefined; }; })[] | undefined; seq_no_primary_term?: boolean | undefined; version?: boolean | undefined; track_scores?: boolean | undefined; highlight?: any; _source?: string | boolean | string[] | undefined; } | undefined; weighted_avg?: { format?: string | undefined; value_type?: string | undefined; value?: { field?: string | undefined; missing?: number | undefined; } | undefined; weight?: { field?: string | undefined; missing?: number | undefined; } | undefined; } | undefined; }; } | undefined; }; } | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"\nThe filters to apply to the query"
],
"signature": [
"QueryDslQueryContainer",
"[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
"\nAny sort options to apply to the groupByField aggregations"
],
"signature": [
"SortCombinations",
"[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.pageIndex",
"type": "number",
"tags": [],
"label": "pageIndex",
"description": [
"\nThe page index to start from"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getGroupAggregations.$1.pageSize",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [
"\nThe page size"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getAuthorizedAlertsIndices",
"type": "Function",
"tags": [],
"label": "getAuthorizedAlertsIndices",
"description": [],
"signature": [
"(ruleTypeIds?: string[] | undefined) => Promise<string[] | undefined>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getAuthorizedAlertsIndices.$1",
"type": "Array",
"tags": [],
"label": "ruleTypeIds",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getBrowserFields",
"type": "Function",
"tags": [],
"label": "getBrowserFields",
"description": [],
"signature": [
"({ ruleTypeIds, indices, metaFields, allowNoIndex, }: { ruleTypeIds: string[]; indices: string[]; metaFields: string[]; allowNoIndex: boolean; }) => Promise<{ browserFields: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.BrowserFields",
"text": "BrowserFields"
},
"; fields: ",
{
"pluginId": "dataViews",
"scope": "server",
"docId": "kibDataViewsPluginApi",
"section": "def-server.FieldDescriptor",
"text": "FieldDescriptor"
},
"[]; }>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getBrowserFields.$1",
"type": "Object",
"tags": [],
"label": "{\n ruleTypeIds,\n indices,\n metaFields,\n allowNoIndex,\n }",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getBrowserFields.$1.ruleTypeIds",
"type": "Array",
"tags": [],
"label": "ruleTypeIds",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getBrowserFields.$1.indices",
"type": "Array",
"tags": [],
"label": "indices",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getBrowserFields.$1.metaFields",
"type": "Array",
"tags": [],
"label": "metaFields",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getBrowserFields.$1.allowNoIndex",
"type": "boolean",
"tags": [],
"label": "allowNoIndex",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getAADFields",
"type": "Function",
"tags": [],
"label": "getAADFields",
"description": [],
"signature": [
"({ ruleTypeId }: { ruleTypeId: string; }) => Promise<",
{
"pluginId": "dataViews",
"scope": "server",
"docId": "kibDataViewsPluginApi",
"section": "def-server.FieldDescriptor",
"text": "FieldDescriptor"
},
"[]>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getAADFields.$1",
"type": "Object",
"tags": [],
"label": "{ ruleTypeId }",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertsClient.getAADFields.$1.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/alerts_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient",
"type": "Class",
"tags": [],
"label": "RuleDataClient",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClient",
"text": "RuleDataClient"
},
" implements ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataClientConstructorOptions",
"text": "RuleDataClientConstructorOptions"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.indexName",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.kibanaVersion",
"type": "string",
"tags": [],
"label": "kibanaVersion",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.indexNameWithNamespace",
"type": "Function",
"tags": [],
"label": "indexNameWithNamespace",
"description": [],
"signature": [
"(namespace: string) => string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.indexNameWithNamespace.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.isWriteEnabled",
"type": "Function",
"tags": [],
"label": "isWriteEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.isUsingDataStreams",
"type": "Function",
"tags": [],
"label": "isUsingDataStreams",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getReader",
"type": "Function",
"tags": [],
"label": "getReader",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; }) => ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataReader",
"text": "IRuleDataReader"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getReader.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getReader.$1.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getWriter",
"type": "Function",
"tags": [],
"label": "getWriter",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; }) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataWriter",
"text": "IRuleDataWriter"
},
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getWriter.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClient.getWriter.$1.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService",
"type": "Class",
"tags": [],
"label": "RuleDataService",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataService",
"text": "RuleDataService"
},
" implements ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataService",
"text": "IRuleDataService"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ConstructorOptions"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.getResourcePrefix",
"type": "Function",
"tags": [],
"label": "getResourcePrefix",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.getResourceName",
"type": "Function",
"tags": [],
"label": "getResourceName",
"description": [],
"signature": [
"(relativeName: string) => string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.getResourceName.$1",
"type": "string",
"tags": [],
"label": "relativeName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.isWriteEnabled",
"type": "Function",
"tags": [],
"label": "isWriteEnabled",
"description": [],
"signature": [
"(registrationContext: string) => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.isWriteEnabled.$1",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.isRegistrationContextDisabled",
"type": "Function",
"tags": [],
"label": "isRegistrationContextDisabled",
"description": [],
"signature": [
"(registrationContext: string) => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.isRegistrationContextDisabled.$1",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.isWriterCacheEnabled",
"type": "Function",
"tags": [],
"label": "isWriterCacheEnabled",
"description": [
"\nIf writer cache is enabled (the default), the writer will be cached\nafter being initialized. Disabling this is useful for tests, where we\nexpect to easily be able to clean up after ourselves between test cases."
],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.initializeService",
"type": "Function",
"tags": [],
"label": "initializeService",
"description": [
"\nInstalls common Elasticsearch resources used by all alerts-as-data indices."
],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.initializeIndex",
"type": "Function",
"tags": [],
"label": "initializeIndex",
"description": [],
"signature": [
"(indexOptions: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IndexOptions",
"text": "IndexOptions"
},
") => ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.initializeIndex.$1",
"type": "Object",
"tags": [],
"label": "indexOptions",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IndexOptions",
"text": "IndexOptions"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.findIndexByName",
"type": "Function",
"tags": [],
"label": "findIndexByName",
"description": [],
"signature": [
"(registrationContext: string, dataset: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
},
") => ",
"IndexInfo",
" | null"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.findIndexByName.$1",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.findIndexByName.$2",
"type": "Enum",
"tags": [],
"label": "dataset",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.findIndexByFeature",
"type": "Function",
"tags": [],
"label": "findIndexByFeature",
"description": [],
"signature": [
"(featureId: ",
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
},
", dataset: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
},
") => ",
"IndexInfo",
" | null"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.findIndexByFeature.$1",
"type": "CompoundType",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataService.findIndexByFeature.$2",
"type": "Enum",
"tags": [],
"label": "dataset",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriteDisabledError",
"type": "Class",
"tags": [],
"label": "RuleDataWriteDisabledError",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataWriteDisabledError",
"text": "RuleDataWriteDisabledError"
},
" extends Error"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriteDisabledError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriteDisabledError.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n reason,\n registrationContext,\n message,\n }",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriteDisabledError.Unnamed.$1.reason",
"type": "CompoundType",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"\"config\" | \"error\""
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriteDisabledError.Unnamed.$1.registrationContext",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriteDisabledError.Unnamed.$1.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriterInitializationError",
"type": "Class",
"tags": [],
"label": "RuleDataWriterInitializationError",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleDataWriterInitializationError",
"text": "RuleDataWriterInitializationError"
},
" extends Error"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriterInitializationError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriterInitializationError.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "resourceType",
"description": [],
"signature": [
"\"namespace\" | \"index\""
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriterInitializationError.Unnamed.$2",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataWriterInitializationError.Unnamed.$3",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"string | Error"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/errors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.alertAuditEvent",
"type": "Function",
"tags": [],
"label": "alertAuditEvent",
"description": [],
"signature": [
"({ action, id, outcome, error }: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertAuditEventParams",
"text": "AlertAuditEventParams"
},
") => ",
"AuditEvent"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.alertAuditEvent.$1",
"type": "Object",
"tags": [],
"label": "{ action, id, outcome, error }",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertAuditEventParams",
"text": "AlertAuditEventParams"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createPersistenceRuleTypeWrapper",
"type": "Function",
"tags": [],
"label": "createPersistenceRuleTypeWrapper",
"description": [],
"signature": [
"({ logger, ruleDataClient, formatAlert }: { ruleDataClient: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
},
"; logger: ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
"; formatAlert?: ((alert: unknown) => unknown) | undefined; }) => <TParams extends ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
", TState extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeState",
"text": "RuleTypeState"
},
">(type: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.PersistenceAlertType",
"text": "PersistenceAlertType"
},
"<TParams, TState, { [x: string]: unknown; }, \"default\">) => { executor: (options: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleExecutorOptions",
"text": "RuleExecutorOptions"
},
"<TParams, TState, Record<string, any>, { [x: string]: unknown; }, \"default\", never>) => Promise<{ state: TState; }>; id: string; validate: { params: ",
"RuleTypeParamsValidator",
"<TParams>; }; name: string; cancelAlertsOnRuleTimeout?: boolean | undefined; alerts?: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.IRuleTypeAlerts",
"text": "IRuleTypeAlerts"
},
"<never> | undefined; recoveryActionGroup?: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<never> | undefined; actionGroups: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<\"default\">[]; schemas?: { params?: { type: \"zod\"; schema: Zod.ZodObject<Zod.ZodRawShape, Zod.UnknownKeysParam, Zod.ZodTypeAny, { [x: string]: any; }, { [x: string]: any; }> | Zod.ZodIntersection<Zod.ZodTypeAny, Zod.ZodTypeAny>; } | { type: \"config-schema\"; schema: ",
{
"pluginId": "@kbn/config-schema",
"scope": "common",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-common.ObjectType",
"text": "ObjectType"
},
"<any>; } | undefined; } | undefined; defaultActionGroupId: \"default\"; category: string; producer: string; actionVariables?: { context?: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; state?: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; params?: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[] | undefined; } | undefined; minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"; useSavedObjectReferences?: { extractReferences: (params: TParams) => ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleParamsAndRefs",
"text": "RuleParamsAndRefs"
},
"<TParams>; injectReferences: (params: TParams, references: ",
"SavedObjectReference",
"[]) => TParams; } | undefined; isExportable: boolean; defaultScheduleInterval?: string | undefined; ruleTaskTimeout?: string | undefined; doesSetRecoveryContext?: boolean | undefined; autoRecoverAlerts?: boolean | undefined; getViewInAppRelativeUrl?: ",
"GetViewInAppRelativeUrlFn",
"<TParams> | undefined; fieldsForAAD?: string[] | undefined; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.createPersistenceRuleTypeWrapper.$1",
"type": "Object",
"tags": [],
"label": "{ logger, ruleDataClient, formatAlert }",
"description": [],
"signature": [
"{ ruleDataClient: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
},
"; logger: ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
"; formatAlert?: ((alert: unknown) => unknown) | undefined; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertAuditEventParams",
"type": "Interface",
"tags": [],
"label": "AlertAuditEventParams",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertAuditEventParams.action",
"type": "Enum",
"tags": [],
"label": "action",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertAuditAction",
"text": "AlertAuditAction"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertAuditEventParams.outcome",
"type": "string",
"tags": [],
"label": "outcome",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertAuditEventParams.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertAuditEventParams.error",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.ComponentTemplateOptions",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateOptions",
"description": [
"\nWhen initializing an index, a plugin/solution can break mappings and settings\ndown into several component templates. Some of their properties can be\ndefined by the plugin/solution via these options.\n\nhttps://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.ComponentTemplateOptions.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.ComponentTemplateOptions.mappings",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"MappingTypeMapping",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.ComponentTemplateOptions.settings",
"type": "CompoundType",
"tags": [],
"label": "settings",
"description": [],
"signature": [
"IndicesIndexSettings",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.ComponentTemplateOptions._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"Metadata",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions",
"type": "Interface",
"tags": [],
"label": "IndexOptions",
"description": [
"\nOptions that a plugin/solution provides to rule_registry in order to\ndefine and initialize an index for alerts-as-data.\n\nIMPORTANT: All names provided in these options are relative. For example:\n- component template refs will be 'ecs-mappings', not '.alerts-ecs-mappings'\n- component template names will be 'mappings', not '.alerts-security.alerts-mappings'\n- etc"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.feature",
"type": "CompoundType",
"tags": [],
"label": "feature",
"description": [
"\nID of the Kibana feature associated with the index.\nUsed by alerts-as-data RBAC.\n\nNote from @dhurley14\nThe purpose of the `feature` param is to force the user to update\nthe data structure which contains the mapping of consumers to alerts\nas data indices. The idea is it is typed such that it forces the\nuser to go to the code and modify it. At least until a better system\nis put in place or we move the alerts as data client out of rule registry.\n"
],
"signature": [
"\"ml\" | \"monitoring\" | \"uptime\" | \"siem\" | \"observability\" | \"stackAlerts\" | \"alerts\" | \"apm\" | \"logs\" | \"infrastructure\" | \"slo\" | \"discover\" | \"AlertingExample\""
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.registrationContext",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [
"\nRegistration context which defines a solution or an app within a solution."
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.dataset",
"type": "Enum",
"tags": [],
"label": "dataset",
"description": [
"\nDataset suffix. Restricted to a few values."
],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.componentTemplateRefs",
"type": "Array",
"tags": [],
"label": "componentTemplateRefs",
"description": [
"\nA list of references to external component templates. Those can be\nthe common ones shared between all solutions, or special ones\nshared between some of them.\n\nIMPORTANT: These names should be relative.\n- correct: 'my-mappings'\n- incorrect: '.alerts-my-mappings'\n"
],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.componentTemplates",
"type": "Array",
"tags": [],
"label": "componentTemplates",
"description": [
"\nOwn component templates specified for the index by the plugin/solution\ndefining this index.\n\nIMPORTANT: Order matters. This order is used by Elasticsearch to set\npriorities when merging the same field names defined in 2+ templates.\n\nIMPORTANT: Component template names should be relative.\n- correct: 'mappings'\n- incorrect: 'security.alerts-mappings'\n- incorrect: '.alerts-security.alerts-mappings'"
],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.ComponentTemplateOptions",
"text": "ComponentTemplateOptions"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.indexTemplate",
"type": "Object",
"tags": [],
"label": "indexTemplate",
"description": [
"\nAdditional properties for the namespaced index template."
],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IndexTemplateOptions",
"text": "IndexTemplateOptions"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.ilmPolicy",
"type": "Object",
"tags": [],
"label": "ilmPolicy",
"description": [
"\nOptional custom ILM policy for the index.\nNOTE: this policy will be shared between all namespaces of the index."
],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IlmPolicyOptions",
"text": "IlmPolicyOptions"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.secondaryAlias",
"type": "string",
"tags": [],
"label": "secondaryAlias",
"description": [
"\nOptional secondary alias that will be applied to concrete indices in\naddition to the primary one '.alerts-{reg. context}.{dataset}-{namespace}'\n\nIMPORTANT: It should not include the namespace. It will be added\nautomatically.\n- correct: '.siem-signals'\n- incorrect: '.siem-signals-default'\n"
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexOptions.additionalPrefix",
"type": "string",
"tags": [],
"label": "additionalPrefix",
"description": [
"\nOptional prefix name that will be prepended to indices in addition to\nprimary dataset and context naming convention.\n\nCurrently used only for creating a preview index for the purpose of\npreviewing alerts from a rule. The documents are identical to alerts, but\nshouldn't exist on an alert index and shouldn't be queried together with\nreal alerts in any way, because the rule that created them doesn't exist"
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexTemplateOptions",
"type": "Interface",
"tags": [],
"label": "IndexTemplateOptions",
"description": [
"\nWhen initializing an index, a plugin/solution can provide some optional\nproperties which will be included into the index template.\n\nNote that:\n- each index namespace will get its own index template\n- the template will be created by the library\n- most of its properties will be set by the library\n- you can inject some of them via these options\n\nhttps://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html\nhttps://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IndexTemplateOptions._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"Metadata",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient",
"type": "Interface",
"tags": [],
"label": "IRuleDataClient",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.indexName",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.indexNameWithNamespace",
"type": "Function",
"tags": [],
"label": "indexNameWithNamespace",
"description": [],
"signature": [
"(namespace: string) => string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.indexNameWithNamespace.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.kibanaVersion",
"type": "string",
"tags": [],
"label": "kibanaVersion",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.isWriteEnabled",
"type": "Function",
"tags": [],
"label": "isWriteEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.isUsingDataStreams",
"type": "Function",
"tags": [],
"label": "isUsingDataStreams",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getReader",
"type": "Function",
"tags": [],
"label": "getReader",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; } | undefined) => ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataReader",
"text": "IRuleDataReader"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getReader.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getReader.$1.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getWriter",
"type": "Function",
"tags": [],
"label": "getWriter",
"description": [],
"signature": [
"(options?: { namespace?: string | undefined; } | undefined) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataWriter",
"text": "IRuleDataWriter"
},
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getWriter.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataClient.getWriter.$1.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataReader",
"type": "Interface",
"tags": [],
"label": "IRuleDataReader",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataReader.search",
"type": "Function",
"tags": [],
"label": "search",
"description": [],
"signature": [
"<TSearchRequest extends ",
{
"pluginId": "@kbn/es-types",
"scope": "common",
"docId": "kibKbnEsTypesPluginApi",
"section": "def-common.ESSearchRequest",
"text": "ESSearchRequest"
},
", TAlertDoc = Partial<OutputOf<SetOptional<{ readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.description\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.enabled\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.from\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.interval\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.license\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.note\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.references\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.rule_name_override\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.to\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.docs_count\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.suppression.terms.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status_updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"@timestamp\": { readonly type: \"date\"; readonly required: true; readonly array: false; }; readonly \"event.action\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.execution.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.revision\": { readonly type: \"long\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"event.kind\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"event.original\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"kibana.alert.action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.case_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.consecutive_matches\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping_history\": { readonly type: \"boolean\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.intended_timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.last_detected\": { readonly type: \"date\"; readonly required: false; readonly array: false; }; readonly \"kibana.alert.maintenance_window_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.previous_action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly multi_fields: ",
{
"pluginId": "@kbn/alerts-as-data-utils",
"scope": "common",
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
"section": "def-common.MultiField",
"text": "MultiField"
},
"[]; }; readonly \"kibana.alert.rule.execution.timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.execution.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.parameters\": { readonly array: false; readonly type: \"flattened\"; readonly ignore_above: 4096; readonly required: false; }; readonly \"kibana.alert.rule.tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.severity_improving\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.time_range\": { readonly type: \"date_range\"; readonly format: \"epoch_millis||strict_date_optional_time\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.url\": { readonly type: \"keyword\"; readonly array: false; readonly index: false; readonly required: false; readonly ignore_above: 2048; }; readonly \"kibana.alert.workflow_assignee_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; }>> & OutputOf<SetOptional<{ readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; readonly required: false; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; readonly required: false; }; readonly \"kibana.alert.context\": { readonly type: \"object\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.evaluation.values\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; readonly required: false; readonly array: true; }; readonly \"kibana.alert.group\": { readonly type: \"object\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.group.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.group.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; }>>>>(request: TSearchRequest) => Promise<",
{
"pluginId": "@kbn/es-types",
"scope": "common",
"docId": "kibKbnEsTypesPluginApi",
"section": "def-common.ESSearchResponse",
"text": "ESSearchResponse"
},
"<TAlertDoc, TSearchRequest, { restTotalHitsAsInt: false; }>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataReader.search.$1",
"type": "Uncategorized",
"tags": [],
"label": "request",
"description": [],
"signature": [
"TSearchRequest"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataReader.getDynamicIndexPattern",
"type": "Function",
"tags": [],
"label": "getDynamicIndexPattern",
"description": [],
"signature": [
"(target?: string | undefined) => Promise<{ title: string; timeFieldName: string; fields: ",
{
"pluginId": "dataViews",
"scope": "server",
"docId": "kibDataViewsPluginApi",
"section": "def-server.FieldDescriptor",
"text": "FieldDescriptor"
},
"[]; }>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataReader.getDynamicIndexPattern.$1",
"type": "string",
"tags": [],
"label": "target",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService",
"type": "Interface",
"tags": [],
"label": "IRuleDataService",
"description": [
"\nA service for creating and using Elasticsearch indices for alerts-as-data."
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.getResourcePrefix",
"type": "Function",
"tags": [],
"label": "getResourcePrefix",
"description": [
"\nReturns a prefix used in the naming scheme of index aliases, templates\nand other Elasticsearch resources that this service creates\nfor alerts-as-data indices."
],
"signature": [
"() => string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.getResourceName",
"type": "Function",
"tags": [],
"label": "getResourceName",
"description": [
"\nPrepends a relative resource name with the resource prefix."
],
"signature": [
"(relativeName: string) => string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.getResourceName.$1",
"type": "string",
"tags": [],
"label": "relativeName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"Full name of the resource."
]
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.isWriteEnabled",
"type": "Function",
"tags": [],
"label": "isWriteEnabled",
"description": [
"\nIf write is enabled for the specified registration context, everything works as usual.\nIf it's disabled, writing to the registration context's alerts-as-data indices will be disabled,\nand also Elasticsearch resources associated with the indices will not be\ninstalled."
],
"signature": [
"(registrationContext: string) => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.isWriteEnabled.$1",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.isWriterCacheEnabled",
"type": "Function",
"tags": [],
"label": "isWriterCacheEnabled",
"description": [
"\nIf writer cache is enabled (the default), the writer will be cached\nafter being initialized. Disabling this is useful for tests, where we\nexpect to easily be able to clean up after ourselves between test cases."
],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.initializeService",
"type": "Function",
"tags": [],
"label": "initializeService",
"description": [
"\nInstalls common Elasticsearch resources used by all alerts-as-data indices."
],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.initializeIndex",
"type": "Function",
"tags": [],
"label": "initializeIndex",
"description": [
"\nInitializes alerts-as-data index and starts index bootstrapping right away."
],
"signature": [
"(indexOptions: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IndexOptions",
"text": "IndexOptions"
},
") => ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.initializeIndex.$1",
"type": "Object",
"tags": [],
"label": "indexOptions",
"description": [
"Index parameters: names and resources."
],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IndexOptions",
"text": "IndexOptions"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"Client for reading and writing data to this index."
]
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.findIndexByName",
"type": "Function",
"tags": [],
"label": "findIndexByName",
"description": [
"\nLooks up the index information associated with the given registration context and dataset."
],
"signature": [
"(registrationContext: string, dataset: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
},
") => ",
"IndexInfo",
" | null"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.findIndexByName.$1",
"type": "string",
"tags": [],
"label": "registrationContext",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.findIndexByName.$2",
"type": "Enum",
"tags": [],
"label": "dataset",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.findIndexByFeature",
"type": "Function",
"tags": [],
"label": "findIndexByFeature",
"description": [
"\nLooks up the index information associated with the given Kibana \"feature\".\nNote: features are used in RBAC."
],
"signature": [
"(featureId: ",
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
},
", dataset: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
},
") => ",
"IndexInfo",
" | null"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.findIndexByFeature.$1",
"type": "CompoundType",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.AlertConsumers",
"text": "AlertConsumers"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataService.findIndexByFeature.$2",
"type": "Enum",
"tags": [],
"label": "dataset",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataWriter",
"type": "Interface",
"tags": [],
"label": "IRuleDataWriter",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataWriter.bulk",
"type": "Function",
"tags": [],
"label": "bulk",
"description": [],
"signature": [
"(request: ",
"BulkRequest",
"<unknown, unknown>) => Promise<",
"TransportResult",
"<",
"BulkResponse",
", unknown> | undefined>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IRuleDataWriter.bulk.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"BulkRequest",
"<unknown, unknown>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertServiceResult",
"type": "Interface",
"tags": [],
"label": "PersistenceAlertServiceResult",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.PersistenceAlertServiceResult",
"text": "PersistenceAlertServiceResult"
},
"<T>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertServiceResult.createdAlerts",
"type": "Array",
"tags": [],
"label": "createdAlerts",
"description": [],
"signature": [
"(T & ",
"CommonAlertFields870",
" & ",
"RevisionField880",
" & { _id: string; _index: string; })[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertServiceResult.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ [x: string]: { count: number; statusCode: number; }; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertServiceResult.alertsWereTruncated",
"type": "boolean",
"tags": [],
"label": "alertsWereTruncated",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices",
"type": "Interface",
"tags": [],
"label": "PersistenceServices",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithPersistence",
"type": "Function",
"tags": [],
"label": "alertWithPersistence",
"description": [],
"signature": [
"<T>(alerts: { _id: string; _source: T; }[], refresh: boolean | \"wait_for\", maxAlerts?: number | undefined, enrichAlerts?: ((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.PersistenceAlertServiceResult",
"text": "PersistenceAlertServiceResult"
},
"<T>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithPersistence.$1",
"type": "Array",
"tags": [],
"label": "alerts",
"description": [],
"signature": [
"{ _id: string; _source: T; }[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithPersistence.$2",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [],
"signature": [
"boolean | \"wait_for\""
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithPersistence.$3",
"type": "number",
"tags": [],
"label": "maxAlerts",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithPersistence.$4",
"type": "Function",
"tags": [],
"label": "enrichAlerts",
"description": [],
"signature": [
"((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithSuppression",
"type": "Function",
"tags": [],
"label": "alertWithSuppression",
"description": [],
"signature": [
"<T extends ",
"SuppressionFields8170",
">(alerts: { _id: string; _source: T; subAlerts?: { _id: string; _source: T; }[] | undefined; }[], suppressionWindow: string, enrichAlerts?: ((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined, currentTimeOverride?: Date | undefined, isRuleExecutionOnly?: boolean | undefined, maxAlerts?: number | undefined) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.SuppressedAlertServiceResult",
"text": "SuppressedAlertServiceResult"
},
"<T>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithSuppression.$1",
"type": "Array",
"tags": [],
"label": "alerts",
"description": [],
"signature": [
"{ _id: string; _source: T; subAlerts?: { _id: string; _source: T; }[] | undefined; }[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithSuppression.$2",
"type": "string",
"tags": [],
"label": "suppressionWindow",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithSuppression.$3",
"type": "Function",
"tags": [],
"label": "enrichAlerts",
"description": [],
"signature": [
"((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithSuppression.$4",
"type": "Object",
"tags": [],
"label": "currentTimeOverride",
"description": [],
"signature": [
"Date | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithSuppression.$5",
"type": "CompoundType",
"tags": [],
"label": "isRuleExecutionOnly",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceServices.alertWithSuppression.$6",
"type": "number",
"tags": [],
"label": "maxAlerts",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RacApiRequestHandlerContext",
"type": "Interface",
"tags": [],
"label": "RacApiRequestHandlerContext",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RacApiRequestHandlerContext.getAlertsClient",
"type": "Function",
"tags": [],
"label": "getAlertsClient",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertsClient",
"text": "AlertsClient"
},
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions",
"type": "Interface",
"tags": [],
"label": "RuleDataClientConstructorOptions",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.indexInfo",
"type": "Object",
"tags": [],
"label": "indexInfo",
"description": [],
"signature": [
"IndexInfo"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.resourceInstaller",
"type": "Object",
"tags": [],
"label": "resourceInstaller",
"description": [],
"signature": [
"{ installCommonResources: () => Promise<void>; installIndexLevelResources: (indexInfo: ",
"IndexInfo",
") => Promise<void>; installAndUpdateNamespaceLevelResources: (indexInfo: ",
"IndexInfo",
", namespace: string) => Promise<void>; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.isWriteEnabled",
"type": "boolean",
"tags": [],
"label": "isWriteEnabled",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.isWriterCacheEnabled",
"type": "boolean",
"tags": [],
"label": "isWriterCacheEnabled",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.waitUntilReadyForReading",
"type": "Object",
"tags": [],
"label": "waitUntilReadyForReading",
"description": [],
"signature": [
"Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.WaitResult",
"text": "WaitResult"
},
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.waitUntilReadyForWriting",
"type": "Object",
"tags": [],
"label": "waitUntilReadyForWriting",
"description": [],
"signature": [
"Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.WaitResult",
"text": "WaitResult"
},
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.logger",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataClientConstructorOptions.isUsingDataStreams",
"type": "boolean",
"tags": [],
"label": "isUsingDataStreams",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertServiceResult",
"type": "Interface",
"tags": [],
"label": "SuppressedAlertServiceResult",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.SuppressedAlertServiceResult",
"text": "SuppressedAlertServiceResult"
},
"<T> extends ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.PersistenceAlertServiceResult",
"text": "PersistenceAlertServiceResult"
},
"<T>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertServiceResult.suppressedAlerts",
"type": "Array",
"tags": [],
"label": "suppressedAlerts",
"description": [],
"signature": [
"{ _id: string; _source: T; }[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertAuditAction",
"type": "Enum",
"tags": [],
"label": "AlertAuditAction",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.Dataset",
"type": "Enum",
"tags": [],
"label": "Dataset",
"description": [
"\nDataset suffix restricted to a few values. All alerts-as-data indices\nare designed to contain only documents of these \"kinds\"."
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.AlertTypeWithExecutor",
"type": "Type",
"tags": [],
"label": "AlertTypeWithExecutor",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleType",
"text": "RuleType"
},
"<TParams, TParams, TState, Record<string, any>, TAlertInstanceContext, string, string, never>, \"executor\"> & { executor: ",
"AlertTypeExecutor",
"<TState, TParams, TAlertInstanceContext, TServices>; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.CreatePersistenceRuleTypeWrapper",
"type": "Type",
"tags": [],
"label": "CreatePersistenceRuleTypeWrapper",
"description": [],
"signature": [
"(options: { ruleDataClient: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
},
"; logger: ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
"; formatAlert?: ((alert: unknown) => unknown) | undefined; }) => <TParams extends ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
", TState extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeState",
"text": "RuleTypeState"
},
">(type: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.PersistenceAlertType",
"text": "PersistenceAlertType"
},
"<TParams, TState, { [x: string]: unknown; }, \"default\">) => ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleType",
"text": "RuleType"
},
"<TParams, TParams, TState, Record<string, any>, { [x: string]: unknown; }, \"default\", never, never>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.CreatePersistenceRuleTypeWrapper.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ ruleDataClient: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataClient",
"text": "IRuleDataClient"
},
"; logger: ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
"; formatAlert?: ((alert: unknown) => unknown) | undefined; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.IlmPolicyOptions",
"type": "Type",
"tags": [],
"label": "IlmPolicyOptions",
"description": [
"\nWhen initializing an index, a plugin/solution can provide a custom\nILM policy that will be applied to concrete indices of this index.\n\nNote that policy will be shared between all namespaces of the index."
],
"signature": [
"{ _meta?: ",
"Metadata",
" | undefined; phases: ",
"IlmPhases",
"; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.INDEX_PREFIX",
"type": "string",
"tags": [],
"label": "INDEX_PREFIX",
"description": [],
"signature": [
"\".alerts\""
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.Mappings",
"type": "Type",
"tags": [],
"label": "Mappings",
"description": [],
"signature": [
"MappingTypeMapping"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.Meta",
"type": "Type",
"tags": [],
"label": "Meta",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertService",
"type": "Type",
"tags": [],
"label": "PersistenceAlertService",
"description": [],
"signature": [
"<T>(alerts: { _id: string; _source: T; }[], refresh: boolean | \"wait_for\", maxAlerts?: number | undefined, enrichAlerts?: ((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.PersistenceAlertServiceResult",
"text": "PersistenceAlertServiceResult"
},
"<T>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertService.$1",
"type": "Array",
"tags": [],
"label": "alerts",
"description": [],
"signature": [
"{ _id: string; _source: T; }[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertService.$2",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [],
"signature": [
"boolean | \"wait_for\""
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertService.$3",
"type": "number",
"tags": [],
"label": "maxAlerts",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertService.$4",
"type": "Function",
"tags": [],
"label": "enrichAlerts",
"description": [],
"signature": [
"((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.PersistenceAlertType",
"type": "Type",
"tags": [],
"label": "PersistenceAlertType",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleType",
"text": "RuleType"
},
"<TParams, TParams, TState, Record<string, any>, TInstanceContext, TActionGroupIds, never, never>, \"executor\"> & { executor: (options: ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.RuleExecutorOptions",
"text": "RuleExecutorOptions"
},
"<TParams, TState, Record<string, any>, TInstanceContext, ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.WithoutReservedActionGroups",
"text": "WithoutReservedActionGroups"
},
"<TActionGroupIds, never>, never> & { services: ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.PersistenceServices",
"text": "PersistenceServices"
},
"; }) => Promise<{ state: TState; }>; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleDataPluginService",
"type": "Type",
"tags": [],
"label": "RuleDataPluginService",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataService",
"text": "IRuleDataService"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginConfig",
"type": "Type",
"tags": [],
"label": "RuleRegistryPluginConfig",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.Settings",
"type": "Type",
"tags": [],
"label": "Settings",
"description": [],
"signature": [
"IndicesIndexSettingsKeys",
" & { [property: string]: any; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertService",
"type": "Type",
"tags": [],
"label": "SuppressedAlertService",
"description": [],
"signature": [
"<T extends ",
"SuppressionFields8170",
">(alerts: { _id: string; _source: T; subAlerts?: { _id: string; _source: T; }[] | undefined; }[], suppressionWindow: string, enrichAlerts?: ((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined, currentTimeOverride?: Date | undefined, isRuleExecutionOnly?: boolean | undefined, maxAlerts?: number | undefined) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.SuppressedAlertServiceResult",
"text": "SuppressedAlertServiceResult"
},
"<T>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertService.$1",
"type": "Array",
"tags": [],
"label": "alerts",
"description": [],
"signature": [
"{ _id: string; _source: T; subAlerts?: { _id: string; _source: T; }[] | undefined; }[]"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertService.$2",
"type": "string",
"tags": [],
"label": "suppressionWindow",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertService.$3",
"type": "Function",
"tags": [],
"label": "enrichAlerts",
"description": [],
"signature": [
"((alerts: { _id: string; _source: T; }[], params: { spaceId: string; }) => Promise<{ _id: string; _source: T; }[]>) | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertService.$4",
"type": "Object",
"tags": [],
"label": "currentTimeOverride",
"description": [],
"signature": [
"Date | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertService.$5",
"type": "CompoundType",
"tags": [],
"label": "isRuleExecutionOnly",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.SuppressedAlertService.$6",
"type": "number",
"tags": [],
"label": "maxAlerts",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/utils/persistence_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.Version",
"type": "Type",
"tags": [],
"label": "Version",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_plugin_service/index_options.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.WaitResult",
"type": "Type",
"tags": [],
"label": "WaitResult",
"description": [],
"signature": [
"Left",
"<Error> | ",
"Right",
"<",
"ElasticsearchClient",
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/rule_data_client/rule_data_client.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.operationAlertAuditActionMap",
"type": "Object",
"tags": [],
"label": "operationAlertAuditActionMap",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.operationAlertAuditActionMap.WriteOperations.Update",
"type": "Enum",
"tags": [],
"label": "[WriteOperations.Update]",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertAuditAction",
"text": "AlertAuditAction"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.operationAlertAuditActionMap.ReadOperations.Find",
"type": "Enum",
"tags": [],
"label": "[ReadOperations.Find]",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertAuditAction",
"text": "AlertAuditAction"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.operationAlertAuditActionMap.ReadOperations.Get",
"type": "Enum",
"tags": [],
"label": "[ReadOperations.Get]",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertAuditAction",
"text": "AlertAuditAction"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/alert_data_client/audit_events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"setup": {
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract",
"type": "Interface",
"tags": [],
"label": "RuleRegistryPluginSetupContract",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract.ruleDataService",
"type": "Object",
"tags": [],
"label": "ruleDataService",
"description": [],
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataService",
"text": "IRuleDataService"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract.dataset",
"type": "Object",
"tags": [],
"label": "dataset",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.Dataset",
"text": "Dataset"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract",
"type": "Interface",
"tags": [],
"label": "RuleRegistryPluginStartContract",
"description": [],
"path": "x-pack/platform/plugins/shared/rule_registry/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest",
"type": "Function",
"tags": [],
"label": "getRacClientWithRequest",
"description": [],
"signature": [
"(req: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertsClient",
"text": "AlertsClient"
},
">"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest.$1",
"type": "Object",
"tags": [],
"label": "req",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginStartContract.alerting",
"type": "Object",
"tags": [],
"label": "alerting",
"description": [],
"signature": [
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.AlertingServerStart",
"text": "AlertingServerStart"
}
],
"path": "x-pack/platform/plugins/shared/rule_registry/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.parseTechnicalFields",
"type": "Function",
"tags": [],
"label": "parseTechnicalFields",
"description": [],
"signature": [
"(input: unknown, partial?: boolean) => OutputOf<SetOptional<{ readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.created_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.description\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.enabled\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.from\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.interval\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.license\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.note\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.references\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.rule_name_override\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.to\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.updated_by\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.docs_count\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.suppression.terms.field\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.suppression.terms.value\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status_updated_at\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"@timestamp\": { readonly type: \"date\"; readonly required: true; readonly array: false; }; readonly \"event.action\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.execution.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.revision\": { readonly type: \"long\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"event.kind\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"event.original\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly ignore_above: 1024; }; readonly \"kibana.alert.action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.case_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.consecutive_matches\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.flapping_history\": { readonly type: \"boolean\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.intended_timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.last_detected\": { readonly type: \"date\"; readonly required: false; readonly array: false; }; readonly \"kibana.alert.maintenance_window_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.previous_action_group\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; readonly multi_fields: ",
{
"pluginId": "@kbn/alerts-as-data-utils",
"scope": "common",
"docId": "kibKbnAlertsAsDataUtilsPluginApi",
"section": "def-common.MultiField",
"text": "MultiField"
},
"[]; }; readonly \"kibana.alert.rule.execution.timestamp\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.execution.type\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.parameters\": { readonly array: false; readonly type: \"flattened\"; readonly ignore_above: 4096; readonly required: false; }; readonly \"kibana.alert.rule.tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.severity_improving\": { readonly type: \"boolean\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.time_range\": { readonly type: \"date_range\"; readonly format: \"epoch_millis||strict_date_optional_time\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.url\": { readonly type: \"keyword\"; readonly array: false; readonly index: false; readonly required: false; readonly ignore_above: 2048; }; readonly \"kibana.alert.workflow_assignee_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_tags\": { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; }>>"
],
"path": "x-pack/platform/plugins/shared/rule_registry/common/parse_technical_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.parseTechnicalFields.$1",
"type": "Unknown",
"tags": [],
"label": "input",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/plugins/shared/rule_registry/common/parse_technical_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.parseTechnicalFields.$2",
"type": "boolean",
"tags": [],
"label": "partial",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/platform/plugins/shared/rule_registry/common/parse_technical_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField",
"type": "Interface",
"tags": [],
"label": "BrowserField",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.category",
"type": "string",
"tags": [],
"label": "category",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.example",
"type": "CompoundType",
"tags": [],
"label": "example",
"description": [],
"signature": [
"string | number | null | undefined"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.fields",
"type": "Object",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"{ readonly [x: string]: Partial<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">; }"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.format",
"type": "Object",
"tags": [],
"label": "format",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<{}, ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.indexes",
"type": "Array",
"tags": [],
"label": "indexes",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.subType",
"type": "CompoundType",
"tags": [],
"label": "subType",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.IFieldSubType",
"text": "IFieldSubType"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.readFromDocValues",
"type": "boolean",
"tags": [],
"label": "readFromDocValues",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserField.runtimeField",
"type": "Object",
"tags": [],
"label": "runtimeField",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.RuleRegistrySearchRequestPagination",
"type": "Interface",
"tags": [],
"label": "RuleRegistrySearchRequestPagination",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/search_strategy_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.RuleRegistrySearchRequestPagination.pageIndex",
"type": "number",
"tags": [],
"label": "pageIndex",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/search_strategy_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.RuleRegistrySearchRequestPagination.pageSize",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"path": "src/platform/packages/shared/kbn-alerting-types/search_strategy_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.RuleRegistrySearchResponse",
"type": "Interface",
"tags": [],
"label": "RuleRegistrySearchResponse",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleRegistrySearchResponse",
"text": "RuleRegistrySearchResponse"
},
" extends ",
{
"pluginId": "@kbn/search-types",
"scope": "common",
"docId": "kibKbnSearchTypesPluginApi",
"section": "def-common.IEsSearchResponse",
"text": "IEsSearchResponse"
},
"<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
">"
],
"path": "src/platform/packages/shared/kbn-alerting-types/search_strategy_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.RuleRegistrySearchResponse.inspect",
"type": "Object",
"tags": [],
"label": "inspect",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleRegistryInspect",
"text": "RuleRegistryInspect"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-alerting-types/search_strategy_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "ruleRegistry",
"id": "def-common.Alert",
"type": "Type",
"tags": [],
"label": "Alert",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.BasicFields",
"text": "BasicFields"
},
" & { \"@timestamp\"?: string[] | undefined; \"event.action\"?: string[] | undefined; tags?: string[] | undefined; kibana?: string[] | undefined; \"kibana.alert.rule.rule_type_id\"?: string[] | undefined; \"kibana.alert.rule.consumer\"?: string[] | undefined; \"kibana.alert.rule.execution.uuid\"?: string[] | undefined; \"kibana.alert.instance.id\"?: string[] | undefined; \"kibana.alert.rule.category\"?: string[] | undefined; \"kibana.alert.rule.name\"?: string[] | undefined; \"kibana.alert.rule.producer\"?: string[] | undefined; \"kibana.alert.rule.uuid\"?: string[] | undefined; \"kibana.alert.status\"?: string[] | undefined; \"kibana.alert.uuid\"?: string[] | undefined; \"kibana.space_ids\"?: string[] | undefined; \"event.kind\"?: string[] | undefined; \"kibana.alert.action_group\"?: string[] | undefined; \"kibana.alert.case_ids\"?: string[] | undefined; \"kibana.alert.duration.us\"?: string[] | undefined; \"kibana.alert.end\"?: string[] | undefined; \"kibana.alert.flapping\"?: string[] | undefined; \"kibana.alert.maintenance_window_ids\"?: string[] | undefined; \"kibana.alert.reason\"?: string[] | undefined; \"kibana.alert.rule.parameters\"?: string[] | undefined; \"kibana.alert.rule.tags\"?: string[] | undefined; \"kibana.alert.start\"?: string[] | undefined; \"kibana.alert.time_range\"?: string[] | undefined; \"kibana.alert.workflow_assignee_ids\"?: string[] | undefined; \"kibana.alert.workflow_status\"?: string[] | undefined; \"kibana.alert.workflow_tags\"?: string[] | undefined; \"kibana.version\"?: string[] | undefined; \"kibana.alert.context\"?: string[] | undefined; \"kibana.alert.evaluation.threshold\"?: string[] | undefined; \"kibana.alert.evaluation.value\"?: string[] | undefined; \"kibana.alert.evaluation.values\"?: string[] | undefined; \"kibana.alert.group\"?: string[] | undefined; \"ecs.version\"?: string[] | undefined; \"kibana.alert.risk_score\"?: string[] | undefined; \"kibana.alert.rule.author\"?: string[] | undefined; \"kibana.alert.rule.created_at\"?: string[] | undefined; \"kibana.alert.rule.created_by\"?: string[] | undefined; \"kibana.alert.rule.description\"?: string[] | undefined; \"kibana.alert.rule.enabled\"?: string[] | undefined; \"kibana.alert.rule.from\"?: string[] | undefined; \"kibana.alert.rule.interval\"?: string[] | undefined; \"kibana.alert.rule.license\"?: string[] | undefined; \"kibana.alert.rule.note\"?: string[] | undefined; \"kibana.alert.rule.references\"?: string[] | undefined; \"kibana.alert.rule.rule_id\"?: string[] | undefined; \"kibana.alert.rule.rule_name_override\"?: string[] | undefined; \"kibana.alert.rule.to\"?: string[] | undefined; \"kibana.alert.rule.type\"?: string[] | undefined; \"kibana.alert.rule.updated_at\"?: string[] | undefined; \"kibana.alert.rule.updated_by\"?: string[] | undefined; \"kibana.alert.rule.version\"?: string[] | undefined; \"kibana.alert.severity\"?: string[] | undefined; \"kibana.alert.suppression.docs_count\"?: string[] | undefined; \"kibana.alert.suppression.end\"?: string[] | undefined; \"kibana.alert.suppression.start\"?: string[] | undefined; \"kibana.alert.suppression.terms.field\"?: string[] | undefined; \"kibana.alert.suppression.terms.value\"?: string[] | undefined; \"kibana.alert.system_status\"?: string[] | undefined; \"kibana.alert.workflow_reason\"?: string[] | undefined; \"kibana.alert.workflow_user\"?: string[] | undefined; \"event.module\"?: string[] | undefined; \"kibana.alert.rule.threat.framework\"?: string[] | undefined; \"kibana.alert.rule.threat.tactic.id\"?: string[] | undefined; \"kibana.alert.rule.threat.tactic.name\"?: string[] | undefined; \"kibana.alert.rule.threat.tactic.reference\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.id\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.name\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.reference\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.subtechnique.id\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.subtechnique.name\"?: string[] | undefined; \"kibana.alert.rule.threat.technique.subtechnique.reference\"?: string[] | undefined; \"kibana.alert.building_block_type\"?: string[] | undefined; \"kibana.alert\"?: string[] | undefined; \"kibana.alert.rule\"?: string[] | undefined; \"kibana.alert.suppression.terms\"?: string[] | undefined; \"kibana.alert.group.field\"?: string[] | undefined; \"kibana.alert.group.value\"?: string[] | undefined; \"kibana.alert.rule.exceptions_list\"?: string[] | undefined; \"kibana.alert.rule.namespace\"?: string[] | undefined; } & { [x: string]: unknown[]; }"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BASE_RAC_ALERTS_API_PATH",
"type": "string",
"tags": [],
"label": "BASE_RAC_ALERTS_API_PATH",
"description": [],
"signature": [
"\"/internal/rac/alerts\""
],
"path": "x-pack/platform/plugins/shared/rule_registry/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.BrowserFields",
"type": "Type",
"tags": [],
"label": "BrowserFields",
"description": [],
"signature": [
"{ [x: string]: Partial<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">; }"
],
"path": "src/platform/packages/shared/kbn-alerting-types/alert_fields_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.ParsedTechnicalFields",
"type": "Type",
"tags": [],
"label": "ParsedTechnicalFields",
"description": [],
"signature": [
"{ readonly \"@timestamp\": string; readonly \"kibana.alert.rule.rule_type_id\": string; readonly \"kibana.alert.rule.consumer\": string; readonly \"kibana.alert.instance.id\": string; readonly \"kibana.alert.rule.category\": string; readonly \"kibana.alert.rule.name\": string; readonly \"kibana.alert.rule.producer\": string; readonly \"kibana.alert.rule.revision\": number; readonly \"kibana.alert.rule.uuid\": string; readonly \"kibana.alert.status\": string; readonly \"kibana.alert.uuid\": string; readonly \"kibana.space_ids\": string[]; readonly \"event.action\"?: string | undefined; readonly tags?: string[] | undefined; readonly \"kibana.alert.rule.execution.uuid\"?: string | undefined; readonly \"event.kind\"?: string | undefined; readonly \"event.original\"?: string | undefined; readonly \"kibana.alert.action_group\"?: string | undefined; readonly \"kibana.alert.case_ids\"?: string[] | undefined; readonly \"kibana.alert.consecutive_matches\"?: number | undefined; readonly \"kibana.alert.duration.us\"?: number | undefined; readonly \"kibana.alert.end\"?: string | undefined; readonly \"kibana.alert.flapping\"?: boolean | undefined; readonly \"kibana.alert.flapping_history\"?: boolean[] | undefined; readonly \"kibana.alert.intended_timestamp\"?: string | undefined; readonly \"kibana.alert.last_detected\"?: string | undefined; readonly \"kibana.alert.maintenance_window_ids\"?: string[] | undefined; readonly \"kibana.alert.previous_action_group\"?: string | undefined; readonly \"kibana.alert.reason\"?: string | undefined; readonly \"kibana.alert.rule.execution.timestamp\"?: string | undefined; readonly \"kibana.alert.rule.execution.type\"?: string | undefined; readonly \"kibana.alert.rule.parameters\"?: { [key: string]: unknown; } | undefined; readonly \"kibana.alert.rule.tags\"?: string[] | undefined; readonly \"kibana.alert.severity_improving\"?: boolean | undefined; readonly \"kibana.alert.start\"?: string | undefined; readonly \"kibana.alert.time_range\"?: unknown; readonly \"kibana.alert.url\"?: string | undefined; readonly \"kibana.alert.workflow_assignee_ids\"?: string[] | undefined; readonly \"kibana.alert.workflow_status\"?: string | undefined; readonly \"kibana.alert.workflow_tags\"?: string[] | undefined; readonly \"kibana.version\"?: string | undefined; readonly \"ecs.version\"?: string | undefined; readonly \"kibana.alert.risk_score\"?: number | undefined; readonly \"kibana.alert.rule.author\"?: string | undefined; readonly \"kibana.alert.rule.created_at\"?: string | undefined; readonly \"kibana.alert.rule.created_by\"?: string | undefined; readonly \"kibana.alert.rule.description\"?: string | undefined; readonly \"kibana.alert.rule.enabled\"?: string | undefined; readonly \"kibana.alert.rule.from\"?: string | undefined; readonly \"kibana.alert.rule.interval\"?: string | undefined; readonly \"kibana.alert.rule.license\"?: string | undefined; readonly \"kibana.alert.rule.note\"?: string | undefined; readonly \"kibana.alert.rule.references\"?: string[] | undefined; readonly \"kibana.alert.rule.rule_id\"?: string | undefined; readonly \"kibana.alert.rule.rule_name_override\"?: string | undefined; readonly \"kibana.alert.rule.to\"?: string | undefined; readonly \"kibana.alert.rule.type\"?: string | undefined; readonly \"kibana.alert.rule.updated_at\"?: string | undefined; readonly \"kibana.alert.rule.updated_by\"?: string | undefined; readonly \"kibana.alert.rule.version\"?: string | undefined; readonly \"kibana.alert.severity\"?: string | undefined; readonly \"kibana.alert.suppression.docs_count\"?: number | undefined; readonly \"kibana.alert.suppression.end\"?: string | undefined; readonly \"kibana.alert.suppression.start\"?: string | undefined; readonly \"kibana.alert.suppression.terms.field\"?: string[] | undefined; readonly \"kibana.alert.suppression.terms.value\"?: string[] | undefined; readonly \"kibana.alert.system_status\"?: string | undefined; readonly \"kibana.alert.workflow_reason\"?: string | undefined; readonly \"kibana.alert.workflow_status_updated_at\"?: string | undefined; readonly \"kibana.alert.workflow_user\"?: string | undefined; }"
],
"path": "x-pack/platform/plugins/shared/rule_registry/common/parse_technical_fields.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-common.RuleRegistrySearchRequest",
"type": "Type",
"tags": [],
"label": "RuleRegistrySearchRequest",
"description": [],
"signature": [
{
"pluginId": "@kbn/search-types",
"scope": "common",
"docId": "kibKbnSearchTypesPluginApi",
"section": "def-common.IEsSearchRequest",
"text": "IEsSearchRequest"
},
"<",
{
"pluginId": "@kbn/search-types",
"scope": "common",
"docId": "kibKbnSearchTypesPluginApi",
"section": "def-common.ISearchRequestParams",
"text": "ISearchRequestParams"
},
"> & { ruleTypeIds: string[]; consumers?: string[] | undefined; fields?: ",
"QueryDslFieldAndFormat",
"[] | undefined; query?: Pick<",
"QueryDslQueryContainer",
", \"ids\" | \"bool\"> | undefined; sort?: ",
"SortCombinations",
"[] | undefined; pagination?: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleRegistrySearchRequestPagination",
"text": "RuleRegistrySearchRequestPagination"
},
" | undefined; runtimeMappings?: ",
"MappingRuntimeFields",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-alerting-types/search_strategy_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink