kibana/api_docs/rule_registry.json

400 lines
97 KiB
JSON
Raw Normal View History

{
"id": "ruleRegistry",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [
{
"id": "def-server.createLifecycleRuleTypeFactory",
"type": "Function",
"label": "createLifecycleRuleTypeFactory",
"signature": [
"() => TRuleRegistry extends ",
"RuleRegistry",
"<infer TFieldMap> ? CreateLifecycleRuleType<TFieldMap> : never"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/rule_type_helpers/create_lifecycle_rule_type_factory.ts",
"lineNumber": 54
},
"initialIsOpen": false
},
{
"id": "def-server.createLifecycleRuleTypeFactory",
"type": "Function",
"label": "createLifecycleRuleTypeFactory",
"signature": [
"() => CreateLifecycleRuleType<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }>"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/rule_type_helpers/create_lifecycle_rule_type_factory.ts",
"lineNumber": 60
},
"initialIsOpen": false
},
{
"id": "def-server.pickWithPatterns",
"type": "Function",
"label": "pickWithPatterns",
"signature": [
"(map: T, patterns: TPatterns) => Pick<{ [TFieldName in keyof T]: ",
"SetIntersection",
"<",
"ValuesType",
"<TPatterns>, PatternMapOf<T>[TFieldName]> extends never ? never : T[TFieldName]; }, { [Key in keyof { [TFieldName in keyof T]: ",
"SetIntersection",
"<",
"ValuesType",
"<TPatterns>, PatternMapOf<T>[TFieldName]> extends never ? never : T[TFieldName]; }]-?: [{ [TFieldName in keyof T]: ",
"SetIntersection"
],
"description": [],
"children": [
{
"id": "def-server.pickWithPatterns.$1",
"type": "Uncategorized",
"label": "map",
"isRequired": true,
"signature": [
"T"
],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts",
"lineNumber": 42
}
},
{
"id": "def-server.pickWithPatterns.$2",
"type": "Uncategorized",
"label": "patterns",
"isRequired": true,
"signature": [
"TPatterns"
],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts",
"lineNumber": 42
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/field_map/pick_with_patterns.ts",
"lineNumber": 39
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-server.ScopedRuleRegistryClient",
"type": "Interface",
"label": "ScopedRuleRegistryClient",
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.ScopedRuleRegistryClient",
"text": "ScopedRuleRegistryClient"
},
"<TFieldMap>"
],
"description": [],
"tags": [],
"children": [
{
"id": "def-server.ScopedRuleRegistryClient.search",
"type": "Function",
"label": "search",
"signature": [
"<TSearchRequest extends FieldsESSearchRequest<TFieldMap>>(request: TSearchRequest) => Promise<{ body: ",
"InferSearchResponseOf",
"<unknown, TSearchRequest, { restTotalHitsAsInt: false; }>; events: ",
"EventsOf",
"<TSearchRequest, TFieldMap>; }>"
],
"description": [],
"children": [
{
"id": "def-server.ScopedRuleRegistryClient.search.$1",
"type": "Uncategorized",
"label": "request",
"isRequired": true,
"signature": [
"TSearchRequest"
],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts",
"lineNumber": 42
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts",
"lineNumber": 41
}
},
{
"id": "def-server.ScopedRuleRegistryClient.index",
"type": "Function",
"label": "index",
"signature": [
"(doc: Pick<",
"Mutable",
"<{ [K in keyof Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ",
"OutputOf",
"<Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }]?: ",
"OutputOf",
"<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }[K]> | undefined; }>, Exclude<keyof TFieldMap, ",
"PrepopulatedRuleEventFields",
"> | Exclude<{ [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ",
"PrepopulatedRuleEventFields"
],
"description": [],
"children": [
{
"id": "def-server.ScopedRuleRegistryClient.index.$1",
"type": "Object",
"label": "doc",
"isRequired": true,
"signature": [
"Pick<",
"Mutable",
"<{ [K in keyof Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ",
"OutputOf",
"<Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }]?: ",
"OutputOf",
"<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }[K]> | undefined; }>, Exclude<keyof TFieldMap, ",
"PrepopulatedRuleEventFields",
"> | Exclude<{ [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ",
"PrepopulatedRuleEventFields"
],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts",
"lineNumber": 47
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts",
"lineNumber": 47
}
},
{
"id": "def-server.ScopedRuleRegistryClient.bulkIndex",
"type": "Function",
"label": "bulkIndex",
"signature": [
"(doc: Pick<",
"Mutable",
"<{ [K in keyof Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ",
"OutputOf",
"<Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }]?: ",
"OutputOf",
"<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }[K]> | undefined; }>, Exclude<keyof TFieldMap, ",
"PrepopulatedRuleEventFields",
"> | Exclude<{ [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ",
"PrepopulatedRuleEventFields"
],
"description": [],
"children": [
{
"id": "def-server.ScopedRuleRegistryClient.bulkIndex.$1",
"type": "Array",
"label": "doc",
"isRequired": true,
"signature": [
"Pick<",
"Mutable",
"<{ [K in keyof Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>]: ",
"OutputOf",
"<Pick<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }, { [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap]>[K]>; } & { [K in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }]?: ",
"OutputOf",
"<{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"type\"]; }[K]> | undefined; }>, Exclude<keyof TFieldMap, ",
"PrepopulatedRuleEventFields",
"> | Exclude<{ [Key in keyof { [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }]-?: [true] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] ? [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key]] extends [{ [key in keyof MapTypeValues<TFieldMap>]: MapTypeValues<TFieldMap>[key][\"required\"]; }[Key] & true] ? Key : never : never; }[keyof TFieldMap], ",
"PrepopulatedRuleEventFields"
],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts",
"lineNumber": 49
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts",
"lineNumber": 48
}
}
],
"source": {
"path": "x-pack/plugins/rule_registry/server/rule_registry/create_scoped_rule_registry_client/types.ts",
"lineNumber": 40
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-server.FieldMapOf",
"type": "Type",
"label": "FieldMapOf",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/types.ts",
"lineNumber": 98
},
"signature": [
"TRuleRegistry extends RuleRegistry<infer TFieldMap> ? TFieldMap : never"
],
"initialIsOpen": false
},
{
"id": "def-server.RuleRegistryConfig",
"type": "Type",
"label": "RuleRegistryConfig",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/index.ts",
"lineNumber": 26
},
"signature": [
"{ readonly enabled: boolean; readonly writeEnabled: boolean; }"
],
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"id": "def-server.ecsFieldMap",
"type": "Object",
"label": "ecsFieldMap",
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/generated/ecs_field_map.ts",
"lineNumber": 8
},
"signature": [
"{ readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'agent.build.original': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.ephemeral_id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.type': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'agent.version': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.address': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.as.number': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.as.organization.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.bytes': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.city_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.continent_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.country_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.location': { readonly type: \"geo_point\"; readonly array: false; readonly required: false; }; readonly 'client.geo.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_iso_code': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.geo.region_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.mac': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.nat.ip': { readonly type: \"ip\"; readonly array: false; readonly required: false; }; readonly 'client.nat.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.packets': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.port': { readonly type: \"long\"; readonly array: false; readonly required: false; }; readonly 'client.registered_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.subdomain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.top_level_domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.email': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.full_name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.domain': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.group.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.hash': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'client.user.id': { readonly type: \"keyword\"; readonly ar
],
"initialIsOpen": false
}
],
"setup": {
"id": "def-server.RuleRegistryPluginSetupContract",
"type": "Type",
"label": "RuleRegistryPluginSetupContract",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"lineNumber": 15
},
"signature": [
"RuleRegistry<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }>"
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"id": "def-common.getAlertSeverityLevelValue",
"type": "Function",
"label": "getAlertSeverityLevelValue",
"signature": [
"(level: ",
{
"pluginId": "ruleRegistry",
"scope": "common",
"docId": "kibRuleRegistryPluginApi",
"section": "def-common.AlertSeverityLevel",
"text": "AlertSeverityLevel"
},
") => number"
],
"description": [],
"children": [
{
"id": "def-common.getAlertSeverityLevelValue.$1",
"type": "Enum",
"label": "level",
"isRequired": true,
"signature": [
{
"pluginId": "ruleRegistry",
"scope": "common",
"docId": "kibRuleRegistryPluginApi",
"section": "def-common.AlertSeverityLevel",
"text": "AlertSeverityLevel"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/common/types.ts",
"lineNumber": 18
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/rule_registry/common/types.ts",
"lineNumber": 18
},
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"id": "def-common.AlertSeverityLevel",
"type": "Enum",
"label": "AlertSeverityLevel",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/rule_registry/common/types.ts",
"lineNumber": 8
},
"initialIsOpen": false
}
],
"misc": [],
"objects": []
}
}