2021-04-15 22:47:21 +02:00
{
"id" : "ruleRegistry" ,
"client" : {
2021-05-20 22:11:31 +02:00
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"server" : {
2021-05-06 21:08:20 +02:00
"classes" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient" ,
2021-05-06 21:08:20 +02:00
"type" : "Class" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"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."
2021-05-06 21:08:20 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-06 21:08:20 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.Unnamed" ,
2021-05-06 21:08:20 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-06 21:08:20 +02:00
"label" : "Constructor" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-05-06 21:08:20 +02:00
"signature" : [
"any"
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-06 21:08:20 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.Unnamed.$1" ,
2021-05-06 21:08:20 +02:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-06 21:08:20 +02:00
"label" : "options" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-05-06 21:08:20 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"ConstructorOptions"
2021-05-06 21:08:20 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-06 21:08:20 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-06 21:08:20 +02:00
} ,
2021-08-02 22:44:47 +02:00
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.get" ,
2021-08-02 22:44:47 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "get" ,
2021-08-02 22:44:47 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"({ id, index }: GetAlertParams) => Promise<OutputOf<" ,
"Optional" ,
2021-10-11 19:58:18 +02:00
"<{ readonly \"kibana.alert.rule.params\": { readonly type: \"keyword\"; readonly index: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { 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.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.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 \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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 \" k i b a n a . a l e
2021-08-02 22:44:47 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.AlertsClient.get.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "{ id, index }" ,
"description" : [ ] ,
"signature" : [
"GetAlertParams"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
2021-08-02 22:44:47 +02:00
"returnComment" : [ ]
} ,
2021-05-06 21:08:20 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.update" ,
2021-05-06 21:08:20 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "update" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-05-06 21:08:20 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"<Params extends Record<string, unknown> = never>({ id, status, _version, index, }: " ,
"UpdateOptions" ,
"<Params>) => Promise<{ _version: string | undefined; get?: " ,
"InlineGet" ,
"<OutputOf<" ,
"Optional" ,
2021-10-11 19:58:18 +02:00
"<{ readonly \"kibana.alert.rule.params\": { readonly type: \"keyword\"; readonly index: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { 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.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.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 \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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 \" k i b a n a . a l e
2021-08-30 17:02:04 +02:00
"Result" ,
"; _seq_no: number; _shards: " ,
"ShardStatistics" ,
"; _type?: string | undefined; forced_refresh?: boolean | undefined; }>"
2021-05-06 21:08:20 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-06 21:08:20 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.update.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "{\n id,\n status,\n _version,\n index,\n }" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-08-30 17:02:04 +02:00
"signature" : [
"UpdateOptions" ,
"<Params>"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"isRequired" : true
2021-05-06 21:08:20 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-06 21:08:20 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.bulkUpdate" ,
2021-05-06 21:08:20 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "bulkUpdate" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-05-06 21:08:20 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"<Params extends Record<string, unknown> = never>({ ids, query, index, status, }: " ,
"BulkUpdateOptions" ,
"<Params>) => Promise<" ,
"ApiResponse" ,
"<" ,
"BulkResponse" ,
", unknown> | " ,
"ApiResponse" ,
"<" ,
"UpdateByQueryResponse" ,
", unknown>>"
2021-05-06 21:08:20 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-06 21:08:20 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.bulkUpdate.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "{\n ids,\n query,\n index,\n status,\n }" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-08-30 17:02:04 +02:00
"signature" : [
"BulkUpdateOptions" ,
"<Params>"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"isRequired" : true
2021-05-06 21:08:20 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-06 21:08:20 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.AlertsClient.find" ,
2021-05-06 21:08:20 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "find" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-05-06 21:08:20 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"<Params extends Record<string, unknown> = never>({ query, aggs, _source, track_total_hits: trackTotalHits, size, index, }: { query?: object | undefined; aggs?: object | undefined; index: string | undefined; track_total_hits?: boolean | undefined; _source?: string[] | undefined; size?: number | undefined; }) => Promise<" ,
"SearchResponse" ,
"<OutputOf<" ,
"Optional" ,
2021-10-11 19:58:18 +02:00
"<{ readonly \"kibana.alert.rule.params\": { readonly type: \"keyword\"; readonly index: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { 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.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.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 \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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 \" k i b a n a . a l e
2021-05-06 21:08:20 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertsClient.find.$1" ,
2021-05-06 23:59:11 +02:00
"type" : "Object" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "{\n query,\n aggs,\n _source,\n track_total_hits: trackTotalHits,\n size,\n index,\n }" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-20 22:11:31 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertsClient.find.$1.query" ,
2021-08-30 17:02:04 +02:00
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "query" ,
"description" : [ ] ,
"signature" : [
"object | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertsClient.find.$1.aggs" ,
2021-08-30 17:02:04 +02:00
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "aggs" ,
"description" : [ ] ,
"signature" : [
"object | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertsClient.find.$1.index" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "index" ,
2021-05-20 22:11:31 +02:00
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertsClient.find.$1.track_total_hits" ,
2021-08-30 17:02:04 +02:00
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "track_total_hits" ,
"description" : [ ] ,
"signature" : [
"boolean | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertsClient.find.$1._source" ,
2021-08-30 17:02:04 +02:00
"type" : "Array" ,
"tags" : [ ] ,
"label" : "_source" ,
"description" : [ ] ,
"signature" : [
"string[] | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.AlertsClient.find.$1.size" ,
2021-08-30 17:02:04 +02:00
"type" : "number" ,
"tags" : [ ] ,
"label" : "size" ,
"description" : [ ] ,
"signature" : [
"number | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false
}
]
2021-05-06 23:59:11 +02:00
}
] ,
2021-05-06 21:08:20 +02:00
"returnComment" : [ ]
2021-08-30 17:02:04 +02:00
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.AlertsClient.getAuthorizedAlertsIndices" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getAuthorizedAlertsIndices" ,
"description" : [ ] ,
"signature" : [
"(featureIds: string[]) => Promise<string[] | undefined>"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.AlertsClient.getAuthorizedAlertsIndices.$1" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "featureIds" ,
"description" : [ ] ,
"signature" : [
"string[]"
] ,
"path" : "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
2021-05-06 21:08:20 +02:00
}
] ,
"initialIsOpen" : false
2021-08-05 18:26:16 +02:00
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataClient" ,
2021-08-05 18:26:16 +02:00
"type" : "Class" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "RuleDataClient" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
2021-08-30 17:02:04 +02:00
"signature" : [
2021-08-05 18:26:16 +02:00
{
2021-08-30 17:02:04 +02:00
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.RuleDataClient" ,
"text" : "RuleDataClient"
2021-08-05 18:26:16 +02:00
} ,
2021-08-30 17:02:04 +02:00
" implements " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
}
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
"deprecated" : false ,
"children" : [
2021-08-05 18:26:16 +02:00
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataClient.Unnamed" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
"label" : "Constructor" ,
"description" : [ ] ,
"signature" : [
"any"
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataClient.Unnamed.$1" ,
2021-08-05 18:26:16 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "options" ,
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"ConstructorOptions"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataClient.indexName" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "indexName" ,
"description" : [ ] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataClient.kibanaVersion" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "kibanaVersion" ,
"description" : [ ] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataClient.isWriteEnabled" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "isWriteEnabled" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"() => boolean"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataClient.getReader" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "getReader" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"(options?: { namespace?: string | undefined; }) => " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.IRuleDataReader" ,
"text" : "IRuleDataReader"
}
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.RuleDataClient.getReader.$1" ,
2021-08-05 18:26:16 +02:00
"type" : "Object" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "options" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.RuleDataClient.getReader.$1.namespace" ,
2021-08-30 17:02:04 +02:00
"type" : "string" ,
"tags" : [ ] ,
"label" : "namespace" ,
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
"deprecated" : false
}
]
2021-08-05 18:26:16 +02:00
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataClient.getWriter" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "getWriter" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"(options?: { namespace?: string | undefined; }) => " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.IRuleDataWriter" ,
"text" : "IRuleDataWriter"
}
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.RuleDataClient.getWriter.$1" ,
2021-08-30 17:02:04 +02:00
"type" : "Object" ,
2021-08-05 18:26:16 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "options" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.RuleDataClient.getWriter.$1.namespace" ,
2021-08-30 17:02:04 +02:00
"type" : "string" ,
"tags" : [ ] ,
"label" : "namespace" ,
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
"deprecated" : false
}
]
2021-08-05 18:26:16 +02:00
}
] ,
"returnComment" : [ ]
2021-08-30 17:02:04 +02:00
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataPluginService" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "RuleDataPluginService" ,
"description" : [
"\nA service for creating and using Elasticsearch indices for alerts-as-data."
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
"deprecated" : false ,
"children" : [
2021-08-05 18:26:16 +02:00
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.Unnamed" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "Constructor" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"any"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.Unnamed.$1" ,
2021-08-05 18:26:16 +02:00
"type" : "Object" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "options" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"ConstructorOptions"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.getResourcePrefix" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"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."
] ,
2021-08-05 18:26:16 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"() => string"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataPluginService.getResourceName" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getResourceName" ,
"description" : [
"\nPrepends a relative resource name with the resource prefix."
] ,
"signature" : [
"(relativeName: string) => string"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.getResourceName.$1" ,
2021-08-05 18:26:16 +02:00
"type" : "string" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "relativeName" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
"string"
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
2021-08-30 17:02:04 +02:00
"returnComment" : [
"Full name of the resource."
]
2021-08-05 18:26:16 +02:00
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.isWriteEnabled" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "isWriteEnabled" ,
"description" : [
"\nIf write is enabled, everything works as usual.\nIf it's disabled, writing to all alerts-as-data indices will be disabled,\nand also Elasticsearch resources associated with the indices will not be\ninstalled."
] ,
2021-08-05 18:26:16 +02:00
"signature" : [
"() => boolean"
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.initializeService" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "initializeService" ,
"description" : [
"\nInstalls common Elasticsearch resources used by all alerts-as-data indices."
] ,
2021-08-05 18:26:16 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"() => void"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.initializeIndex" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "initializeIndex" ,
"description" : [
"\nInitializes alerts-as-data index and starts index bootstrapping right away."
] ,
2021-08-05 18:26:16 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"(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"
}
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataPluginService.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/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [
"Client for reading and writing data to this index."
]
2021-08-05 18:26:16 +02:00
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.findIndexByName" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "findIndexByName" ,
"description" : [
"\nLooks up the index information associated with the given registration context and dataset."
] ,
2021-08-05 18:26:16 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"(registrationContext: string, dataset: " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.Dataset" ,
"text" : "Dataset"
} ,
") => " ,
"IndexInfo" ,
" | null"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataPluginService.findIndexByName.$1" ,
2021-08-05 18:26:16 +02:00
"type" : "string" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "registrationContext" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"string"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataPluginService.findIndexByName.$2" ,
"type" : "Enum" ,
"tags" : [ ] ,
"label" : "dataset" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.Dataset" ,
"text" : "Dataset"
}
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataPluginService.findIndicesByFeature" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "findIndicesByFeature" ,
"description" : [
"\nLooks up the index information associated with the given Kibana \"feature\".\nNote: features are used in RBAC."
] ,
"signature" : [
"(featureId: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/rule-data-utils" ,
"scope" : "server" ,
"docId" : "kibKbnRuleDataUtilsPluginApi" ,
"section" : "def-server.AlertConsumers" ,
"text" : "AlertConsumers"
} ,
2021-08-30 17:02:04 +02:00
", dataset?: " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.Dataset" ,
"text" : "Dataset"
} ,
" | undefined) => " ,
"IndexInfo" ,
"[]"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataPluginService.findIndicesByFeature.$1" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "featureId" ,
"description" : [ ] ,
"signature" : [
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/rule-data-utils" ,
"scope" : "server" ,
"docId" : "kibKbnRuleDataUtilsPluginApi" ,
"section" : "def-server.AlertConsumers" ,
"text" : "AlertConsumers"
}
2021-08-30 17:02:04 +02:00
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleDataPluginService.findIndicesByFeature.$2" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "dataset" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.Dataset" ,
"text" : "Dataset"
} ,
" | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
2021-08-30 17:02:04 +02:00
}
] ,
"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"
2021-08-05 18:26:16 +02:00
} ,
2021-08-30 17:02:04 +02:00
" extends Error"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/errors.ts" ,
"deprecated" : false ,
"children" : [
2021-08-05 18:26:16 +02:00
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataWriteDisabledError.Unnamed" ,
2021-08-05 18:26:16 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "Constructor" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"any"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/errors.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.RuleDataWriteDisabledError.Unnamed.$1" ,
2021-08-05 18:26:16 +02:00
"type" : "string" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "message" ,
2021-08-05 18:26:16 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"string | undefined"
2021-08-05 18:26:16 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/errors.ts" ,
2021-08-05 18:26:16 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"isRequired" : false
2021-08-05 18:26:16 +02:00
}
] ,
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
2021-05-06 21:08:20 +02:00
}
] ,
2021-05-20 22:11:31 +02:00
"functions" : [
2021-05-06 21:08:20 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-02 22:44:47 +02:00
"id" : "def-server.createLifecycleExecutor" ,
2021-05-20 22:11:31 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-02 22:44:47 +02:00
"label" : "createLifecycleExecutor" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-05-06 21:08:20 +02:00
"signature" : [
2021-08-02 22:44:47 +02:00
"(logger: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
} ,
2021-08-02 22:44:47 +02:00
", ruleDataClient: Pick<" ,
2021-05-06 21:08:20 +02:00
{
"pluginId" : "ruleRegistry" ,
2021-05-20 22:11:31 +02:00
"scope" : "server" ,
2021-05-06 21:08:20 +02:00
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-05-20 22:11:31 +02:00
} ,
2021-08-30 17:02:04 +02:00
", \"indexName\" | \"kibanaVersion\" | \"isWriteEnabled\" | \"getReader\" | \"getWriter\">) => <Params extends Record<string, unknown> = never, State extends Record<string, unknown> = never, InstanceState extends { [x: string]: unknown; } = never, InstanceContext extends { [x: string]: unknown; } = never, ActionGroupIds extends string = never>(wrappedExecutor: " ,
2021-08-02 22:44:47 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.LifecycleRuleExecutor" ,
"text" : "LifecycleRuleExecutor"
} ,
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>) => (options: " ,
2021-05-20 22:11:31 +02:00
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertExecutorOptions" ,
"text" : "AlertExecutorOptions"
} ,
2021-08-02 22:44:47 +02:00
"<Params, " ,
"WrappedLifecycleRuleState" ,
"<State>, InstanceState, InstanceContext, ActionGroupIds>) => Promise<" ,
"WrappedLifecycleRuleState" ,
"<State>>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
2021-05-20 22:11:31 +02:00
{
2021-08-02 22:44:47 +02:00
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.createLifecycleExecutor.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "logger" ,
"description" : [ ] ,
"signature" : [
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
}
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
} ,
{
2021-08-02 22:44:47 +02:00
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.createLifecycleExecutor.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "ruleDataClient" ,
"description" : [ ] ,
"signature" : [
"Pick<" ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-08-02 22:44:47 +02:00
} ,
2021-08-30 17:02:04 +02:00
", \"indexName\" | \"kibanaVersion\" | \"isWriteEnabled\" | \"getReader\" | \"getWriter\">"
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.createLifecycleRuleTypeFactory" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "createLifecycleRuleTypeFactory" ,
"description" : [ ] ,
"signature" : [
2021-09-28 22:58:56 +02:00
"({ logger, ruleDataClient }: { logger: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
} ,
2021-08-09 18:51:00 +02:00
"; ruleDataClient: " ,
2021-08-02 22:44:47 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-05-20 22:11:31 +02:00
} ,
2021-08-02 22:44:47 +02:00
"; }) => <TParams extends Record<string, unknown>, TAlertInstanceContext extends { [x: string]: unknown; }, TServices extends { alertWithLifecycle: " ,
2021-05-20 22:11:31 +02:00
{
2021-08-02 22:44:47 +02:00
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.LifecycleAlertService" ,
"text" : "LifecycleAlertService"
2021-05-20 22:11:31 +02:00
} ,
2021-08-09 18:51:00 +02:00
"<Record<string, any>, TAlertInstanceContext, string>; }>(type: " ,
2021-05-20 22:11:31 +02:00
{
2021-08-02 22:44:47 +02:00
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.AlertTypeWithExecutor" ,
"text" : "AlertTypeWithExecutor"
2021-05-20 22:11:31 +02:00
} ,
2021-08-09 18:51:00 +02:00
"<Record<string, any>, TParams, TAlertInstanceContext, TServices>) => " ,
2021-05-20 22:11:31 +02:00
{
2021-08-02 22:44:47 +02:00
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.AlertTypeWithExecutor" ,
"text" : "AlertTypeWithExecutor"
2021-05-06 21:08:20 +02:00
} ,
2021-08-09 18:51:00 +02:00
"<Record<string, any>, TParams, TAlertInstanceContext, any>"
2021-05-06 21:08:20 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-06 21:08:20 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.createLifecycleRuleTypeFactory.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-09-28 22:58:56 +02:00
"label" : "{ logger, ruleDataClient }" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-08-02 22:44:47 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.createLifecycleRuleTypeFactory.$1.logger" ,
2021-08-02 22:44:47 +02:00
"type" : "Object" ,
"tags" : [ ] ,
2021-08-09 18:51:00 +02:00
"label" : "logger" ,
2021-08-02 22:44:47 +02:00
"description" : [ ] ,
"signature" : [
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
}
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.createLifecycleRuleTypeFactory.$1.ruleDataClient" ,
2021-08-02 22:44:47 +02:00
"type" : "Object" ,
"tags" : [ ] ,
2021-08-09 18:51:00 +02:00
"label" : "ruleDataClient" ,
2021-08-02 22:44:47 +02:00
"description" : [ ] ,
"signature" : [
2021-08-09 18:51:00 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-08-09 18:51:00 +02:00
}
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false
}
]
2021-05-20 22:11:31 +02:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
2021-05-31 19:33:12 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.createPersistenceRuleTypeFactory" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "createPersistenceRuleTypeFactory" ,
"description" : [ ] ,
"signature" : [
2021-09-28 22:58:56 +02:00
"({ logger, ruleDataClient }: { ruleDataClient: " ,
2021-05-31 19:33:12 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-05-31 19:33:12 +02:00
} ,
"; logger: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
} ,
2021-08-09 18:51:00 +02:00
"; }) => <TState extends Record<string, unknown>, TParams extends Record<string, unknown>, TServices extends " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.PersistenceServices" ,
"text" : "PersistenceServices"
} ,
"<TAlertInstanceContext>, TAlertInstanceContext extends { [x: string]: unknown; } = {}>(type: " ,
2021-08-02 22:44:47 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.AlertTypeWithExecutor" ,
"text" : "AlertTypeWithExecutor"
} ,
2021-08-09 18:51:00 +02:00
"<TState, TParams, TAlertInstanceContext, TServices>) => { executor: (options: " ,
2021-05-31 19:33:12 +02:00
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertExecutorOptions" ,
"text" : "AlertExecutorOptions"
} ,
2021-08-09 18:51:00 +02:00
"<TParams, TState, { [x: string]: unknown; }, TAlertInstanceContext, never> & { services: TServices; }) => Promise<void | TState>; id: string; name: string; validate?: { params?: " ,
2021-05-31 19:33:12 +02:00
"AlertTypeParamsValidator" ,
"<TParams> | undefined; } | undefined; actionGroups: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<string>[]; defaultActionGroupId: string; recoveryActionGroup?: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionGroup" ,
"text" : "ActionGroup"
} ,
"<string> | undefined; producer: string; actionVariables?: { context?: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionVariable" ,
"text" : "ActionVariable"
} ,
"[] | undefined; state?: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionVariable" ,
"text" : "ActionVariable"
} ,
"[] | undefined; params?: " ,
{
"pluginId" : "alerting" ,
"scope" : "common" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-common.ActionVariable" ,
"text" : "ActionVariable"
} ,
2021-08-02 22:44:47 +02:00
"[] | 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" ,
2021-10-11 19:58:18 +02:00
"[]) => TParams; } | undefined; isExportable: boolean; ruleTaskTimeout?: string | undefined; }"
2021-05-31 19:33:12 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts" ,
2021-05-31 19:33:12 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.createPersistenceRuleTypeFactory.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
2021-09-28 22:58:56 +02:00
"label" : "{ logger, ruleDataClient }" ,
2021-05-31 19:33:12 +02:00
"description" : [ ] ,
"signature" : [
"{ ruleDataClient: " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-05-31 19:33:12 +02:00
} ,
"; logger: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
} ,
2021-05-31 19:33:12 +02:00
"; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts" ,
2021-05-31 19:33:12 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
2021-08-30 17:02:04 +02:00
}
] ,
"interfaces" : [
2021-05-20 22:11:31 +02:00
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.ComponentTemplateOptions" ,
"type" : "Interface" ,
2021-05-20 22:11:31 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"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/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
"children" : [
2021-05-20 22:11:31 +02:00
{
2021-08-30 17:02:04 +02:00
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.ComponentTemplateOptions.name" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "name" ,
"description" : [ ] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.ComponentTemplateOptions.mappings" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "mappings" ,
"description" : [ ] ,
"signature" : [
"MappingTypeMapping" ,
" | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.ComponentTemplateOptions.settings" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "settings" ,
"description" : [ ] ,
"signature" : [
"IndicesIndexSettings" ,
" | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false
2021-05-06 21:08:20 +02:00
} ,
2021-08-30 17:02:04 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.ComponentTemplateOptions._meta" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "_meta" ,
"description" : [ ] ,
"signature" : [
"Record<string, any> | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : 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"
2021-05-20 22:11:31 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
2021-05-06 21:08:20 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"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" : [
"\"logs\" | \"apm\" | \"observability\" | \"uptime\" | \"infrastructure\" | \"siem\""
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : 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/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : 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/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : 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/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : 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/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IndexOptions.indexTemplate" ,
2021-08-02 22:44:47 +02:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "indexTemplate" ,
"description" : [
"\nAdditional properties for the namespaced index template."
] ,
2021-05-06 21:08:20 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
{
2021-08-30 17:02:04 +02:00
"pluginId" : "ruleRegistry" ,
2021-05-20 22:11:31 +02:00
"scope" : "server" ,
2021-08-30 17:02:04 +02:00
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.IndexTemplateOptions" ,
"text" : "IndexTemplateOptions"
2021-05-20 22:11:31 +02:00
} ,
2021-08-30 17:02:04 +02:00
" | undefined"
2021-05-06 21:08:20 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : 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" : [
"Pick<" ,
"IlmPolicy" ,
", \"phases\"> | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : 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/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false
2021-05-06 21:08:20 +02:00
}
] ,
2021-04-15 22:47:21 +02:00
"initialIsOpen" : false
2021-08-30 17:02:04 +02:00
} ,
{
"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/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IndexTemplateOptions._meta" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "_meta" ,
"description" : [ ] ,
"signature" : [
"Record<string, any> | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-04-15 22:47:21 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-05-20 22:11:31 +02:00
"id" : "def-server.IRuleDataClient" ,
2021-04-15 22:47:21 +02:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-20 22:11:31 +02:00
"label" : "IRuleDataClient" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-15 22:47:21 +02:00
"children" : [
2021-08-30 17:02:04 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataClient.indexName" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "indexName" ,
"description" : [ ] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataClient.kibanaVersion" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "kibanaVersion" ,
"description" : [ ] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataClient.isWriteEnabled" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "isWriteEnabled" ,
"description" : [ ] ,
"signature" : [
"() => boolean"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
} ,
2021-04-15 22:47:21 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-05-20 22:11:31 +02:00
"id" : "def-server.IRuleDataClient.getReader" ,
2021-04-15 22:47:21 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-20 22:11:31 +02:00
"label" : "getReader" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-04-15 22:47:21 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"(options?: { namespace?: string | undefined; } | undefined) => " ,
2021-08-30 17:02:04 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.IRuleDataReader" ,
"text" : "IRuleDataReader"
}
2021-04-15 22:47:21 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-15 22:47:21 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.IRuleDataClient.getReader.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-20 22:11:31 +02:00
"label" : "options" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-20 22:11:31 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.IRuleDataClient.getReader.$1.namespace" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
"label" : "namespace" ,
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false
}
]
2021-04-15 22:47:21 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-06 21:08:20 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-05-20 22:11:31 +02:00
"id" : "def-server.IRuleDataClient.getWriter" ,
2021-05-06 21:08:20 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-20 22:11:31 +02:00
"label" : "getWriter" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-05-06 21:08:20 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"(options?: { namespace?: string | undefined; } | undefined) => " ,
2021-08-30 17:02:04 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.IRuleDataWriter" ,
"text" : "IRuleDataWriter"
}
2021-05-06 21:08:20 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-20 22:11:31 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.IRuleDataClient.getWriter.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "options" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.IRuleDataClient.getWriter.$1.namespace" ,
2021-05-20 22:11:31 +02:00
"type" : "string" ,
"tags" : [ ] ,
"label" : "namespace" ,
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false
}
]
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-08-30 17:02:04 +02:00
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataReader" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "IRuleDataReader" ,
"description" : [ ] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false ,
"children" : [
2021-04-15 22:47:21 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.IRuleDataReader.search" ,
2021-04-15 22:47:21 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "search" ,
2021-08-02 22:44:47 +02:00
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"<TSearchRequest extends " ,
"SearchRequest" ,
">(request: TSearchRequest) => Promise<" ,
"InferSearchResponseOf" ,
2021-10-11 19:58:18 +02:00
"<Partial<Record<\"tags\" | \"kibana\" | \"@timestamp\" | \"event.kind\" | \"kibana.consumers\" | \"ecs.version\" | \"event.action\" | \"kibana.alert.action_group\" | \"kibana.alert.duration.us\" | \"kibana.alert.end\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.instance.id\" | \"kibana.alert.rule.consumer\" | \"kibana.alert.rule.producer\" | \"kibana.alert.reason\" | \"kibana.alert.risk_score\" | \"kibana.alert.rule.author\" | \"kibana.alert.rule.created_at\" | \"kibana.alert.rule.created_by\" | \"kibana.alert.rule.description\" | \"kibana.alert.rule.enabled\" | \"kibana.alert.rule.from\" | \"kibana.alert.rule.interval\" | \"kibana.alert.rule.license\" | \"kibana.alert.rule.name\" | \"kibana.alert.rule.note\" | \"kibana.alert.rule.params\" | \"kibana.alert.rule.references\" | \"kibana.alert.rule.risk_score\" | \"kibana.alert.rule.risk_score_mapping\" | \"kibana.alert.rule.rule_id\" | \"kibana.alert.rule.rule_name_override\" | \"kibana.alert.rule.severity\" | \"kibana.alert.rule.severity_mapping\" | \"kibana.alert.rule.tags\" | \"kibana.alert.rule.to\" | \"kibana.alert.rule.type\" | \"kibana.alert.rule.rule_type_id\" | \"kibana.alert.rule.updated_at\" | \"kibana.alert.rule.updated_by\" | \"kibana.alert.rule.version\" | \"kibana.alert.start\" | \"kibana.alert.severity\" | \"kibana.alert.status\" | \"kibana.alert.system_status\" | \"kibana.alert.uuid\" | \"kibana.alert.workflow_reason\" | \"kibana.alert.workflow_status\" | \"kibana.alert.workflow_user\" | \"kibana.alert.rule.uuid\" | \"kibana.alert.rule.category\" | \"kibana.space_ids\" | \"kibana.version\" | \"kibana.alert\" | \"kibana.alert.rule\", unknown[]>>, TSearchRequest, { restTotalHitsAsInt: false; }>>"
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataReader.search.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "request" ,
"description" : [ ] ,
"signature" : [
"TSearchRequest"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false ,
"isRequired" : true
}
] ,
2021-08-02 22:44:47 +02:00
"returnComment" : [ ]
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.IRuleDataReader.getDynamicIndexPattern" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getDynamicIndexPattern" ,
"description" : [ ] ,
"signature" : [
"(target?: string | undefined) => Promise<{ title: string; timeFieldName: string; fields: " ,
{
2021-10-11 19:58:18 +02:00
"pluginId" : "dataViews" ,
2021-08-30 17:02:04 +02:00
"scope" : "server" ,
2021-10-11 19:58:18 +02:00
"docId" : "kibDataViewsPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.FieldDescriptor" ,
"text" : "FieldDescriptor"
} ,
"[]; }>"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataReader.getDynamicIndexPattern.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "target" ,
"description" : [ ] ,
"signature" : [
"string | undefined"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataWriter" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "IRuleDataWriter" ,
"description" : [ ] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.IRuleDataWriter.bulk" ,
2021-08-02 22:44:47 +02:00
"type" : "Function" ,
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "bulk" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-04-15 22:47:21 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"(request: " ,
"BulkRequest" ,
"<unknown>) => Promise<" ,
"ApiResponse" ,
"<" ,
"BulkResponse" ,
", unknown>>"
2021-04-15 22:47:21 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-15 22:47:21 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.IRuleDataWriter.bulk.$1" ,
2021-04-15 22:47:21 +02:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "request" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-08-30 17:02:04 +02:00
"signature" : [
"BulkRequest" ,
"<unknown>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/types.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-08-30 17:02:04 +02:00
"isRequired" : true
2021-04-15 22:47:21 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-04-15 22:47:21 +02:00
}
] ,
"initialIsOpen" : false
} ,
2021-08-02 22:44:47 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.LifecycleAlertServices" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "LifecycleAlertServices" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.LifecycleAlertServices" ,
"text" : "LifecycleAlertServices"
} ,
"<InstanceState, InstanceContext, ActionGroupIds>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.LifecycleAlertServices.alertWithLifecycle" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "alertWithLifecycle" ,
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"(alert: { id: string; fields: ExplicitAlertFields; }) => Pick<" ,
2021-08-02 22:44:47 +02:00
"AlertInstance" ,
"<InstanceState, InstanceContext, ActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.LifecycleAlertServices.alertWithLifecycle.$1" ,
2021-08-02 22:44:47 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "alert" ,
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"{ id: string; fields: ExplicitAlertFields; }"
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false
}
]
}
] ,
"initialIsOpen" : false
} ,
2021-08-09 18:51:00 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.PersistenceServices" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "PersistenceServices" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.PersistenceServices" ,
"text" : "PersistenceServices"
} ,
"<TAlertInstanceContext>"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.PersistenceServices.alertWithPersistence" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "alertWithPersistence" ,
"description" : [ ] ,
"signature" : [
"(alerts: { id: string; fields: Record<string, unknown>; }[], refresh: " ,
"Refresh" ,
") => Promise<" ,
"ApiResponse" ,
"<" ,
"BulkResponse" ,
", unknown>>"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.PersistenceServices.alertWithPersistence.$1" ,
2021-08-09 18:51:00 +02:00
"type" : "Array" ,
"tags" : [ ] ,
"label" : "alerts" ,
"description" : [ ] ,
"signature" : [
"{ id: string; fields: Record<string, unknown>; }[]"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.PersistenceServices.alertWithPersistence.$2" ,
2021-08-09 18:51:00 +02:00
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "refresh" ,
"description" : [ ] ,
"signature" : [
"boolean | \"wait_for\""
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false
}
]
}
] ,
"initialIsOpen" : false
} ,
2021-08-02 22:44:47 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RacApiRequestHandlerContext" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "RacApiRequestHandlerContext" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RacApiRequestHandlerContext.getAlertsClient" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getAlertsClient" ,
"description" : [ ] ,
"signature" : [
"() => Promise<" ,
2021-08-30 17:02:04 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.AlertsClient" ,
"text" : "AlertsClient"
} ,
2021-08-02 22:44:47 +02:00
">"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-08-02 22:44:47 +02:00
}
] ,
"initialIsOpen" : false
2021-08-30 17:02:04 +02:00
}
] ,
"enums" : [
2021-04-15 22:47:21 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-08-30 17:02:04 +02:00
"id" : "def-server.Dataset" ,
"type" : "Enum" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-30 17:02:04 +02:00
"label" : "Dataset" ,
"description" : [
"\nDataset suffix restricted to a few values. All alerts-as-data indices\nare designed to contain only documents of these \"kinds\"."
2021-05-06 21:08:20 +02:00
] ,
2021-08-30 17:02:04 +02:00
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
2021-04-15 22:47:21 +02:00
"initialIsOpen" : false
}
] ,
2021-05-06 21:08:20 +02:00
"misc" : [
2021-08-02 22:44:47 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.AlertTypeWithExecutor" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "AlertTypeWithExecutor" ,
"description" : [ ] ,
"signature" : [
"Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertType" ,
"text" : "AlertType"
} ,
2021-10-11 19:58:18 +02:00
"<TParams, TParams, TState, { [x: string]: unknown; }, TAlertInstanceContext, string, string>, \"id\" | \"name\" | \"validate\" | \"actionGroups\" | \"defaultActionGroupId\" | \"recoveryActionGroup\" | \"producer\" | \"actionVariables\" | \"minimumLicenseRequired\" | \"useSavedObjectReferences\" | \"isExportable\" | \"ruleTaskTimeout\"> & { executor: " ,
2021-08-02 22:44:47 +02:00
"AlertTypeExecutor" ,
2021-08-09 18:51:00 +02:00
"<TState, TParams, TAlertInstanceContext, TServices>; }"
2021-08-02 22:44:47 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/types.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"initialIsOpen" : false
} ,
2021-08-09 18:51:00 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.CreatePersistenceRuleTypeFactory" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "CreatePersistenceRuleTypeFactory" ,
"description" : [ ] ,
"signature" : [
"(options: { ruleDataClient: " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-08-09 18:51:00 +02:00
} ,
"; logger: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
} ,
2021-08-09 18:51:00 +02:00
"; }) => <TState extends Record<string, unknown>, TParams extends Record<string, unknown>, TServices extends " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.PersistenceServices" ,
"text" : "PersistenceServices"
} ,
"<TAlertInstanceContext>, TAlertInstanceContext extends { [x: string]: unknown; } = {}>(type: " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.AlertTypeWithExecutor" ,
"text" : "AlertTypeWithExecutor"
} ,
"<TState, TParams, TAlertInstanceContext, TServices>) => " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.AlertTypeWithExecutor" ,
"text" : "AlertTypeWithExecutor"
} ,
"<TState, TParams, TAlertInstanceContext, TServices>"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.CreatePersistenceRuleTypeFactory.$1" ,
2021-08-09 18:51:00 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "options" ,
"description" : [ ] ,
"signature" : [
"{ ruleDataClient: " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
2021-08-30 17:02:04 +02:00
"section" : "def-server.IRuleDataClient" ,
"text" : "IRuleDataClient"
2021-08-09 18:51:00 +02:00
} ,
"; logger: " ,
2021-10-11 19:58:18 +02:00
{
"pluginId" : "@kbn/logging" ,
"scope" : "server" ,
"docId" : "kibKbnLoggingPluginApi" ,
"section" : "def-server.Logger" ,
"text" : "Logger"
} ,
2021-08-09 18:51:00 +02:00
"; }"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-08-30 17:02:04 +02:00
{
"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" : [
"{ phases: " ,
"IlmPhases" ,
"; }"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.INDEX_PREFIX" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "INDEX_PREFIX" ,
"description" : [ ] ,
"signature" : [
"\".alerts\""
] ,
"path" : "x-pack/plugins/rule_registry/server/config.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.INDEX_PREFIX_FOR_BACKING_INDICES" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "INDEX_PREFIX_FOR_BACKING_INDICES" ,
"description" : [ ] ,
"signature" : [
"\".internal.alerts\""
] ,
"path" : "x-pack/plugins/rule_registry/server/config.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
2021-08-02 22:44:47 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.LifecycleAlertService" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "LifecycleAlertService" ,
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"(alert: { id: string; fields: ExplicitAlertFields; }) => Pick<" ,
2021-08-02 22:44:47 +02:00
"AlertInstance" ,
2021-08-09 18:51:00 +02:00
"<InstanceState, InstanceContext, ActionGroupIds>, \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"
2021-08-02 22:44:47 +02:00
] ,
2021-08-09 18:51:00 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.LifecycleAlertService.$1" ,
2021-08-09 18:51:00 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "alert" ,
"description" : [ ] ,
"signature" : [
2021-08-30 17:02:04 +02:00
"{ id: string; fields: ExplicitAlertFields; }"
2021-08-09 18:51:00 +02:00
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
"deprecated" : false
}
] ,
2021-08-02 22:44:47 +02:00
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.LifecycleRuleExecutor" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "LifecycleRuleExecutor" ,
"description" : [ ] ,
"signature" : [
"(options: " ,
"AlertExecutorOptionsWithExtraServices" ,
"<Params, State, InstanceState, InstanceContext, ActionGroupIds, " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.LifecycleAlertServices" ,
"text" : "LifecycleAlertServices"
} ,
"<InstanceState, InstanceContext, ActionGroupIds>>) => Promise<void | State>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.LifecycleRuleExecutor.$1" ,
2021-08-09 18:51:00 +02:00
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "options" ,
"description" : [ ] ,
"signature" : [
"Pick<" ,
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertExecutorOptions" ,
"text" : "AlertExecutorOptions"
} ,
2021-08-30 17:02:04 +02:00
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>, \"name\" | \"tags\" | \"params\" | \"spaceId\" | \"rule\" | \"createdBy\" | \"updatedBy\" | \"previousStartedAt\" | \"state\" | \"alertId\" | \"namespace\" | \"startedAt\"> & { services: " ,
2021-08-09 18:51:00 +02:00
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.AlertServices" ,
"text" : "AlertServices"
} ,
"<InstanceState, InstanceContext, ActionGroupIds> & " ,
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.LifecycleAlertServices" ,
"text" : "LifecycleAlertServices"
} ,
"<InstanceState, InstanceContext, ActionGroupIds>; }"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-08-30 17:02:04 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.Mappings" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "Mappings" ,
"description" : [ ] ,
"signature" : [
"MappingTypeMapping"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.Meta" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "Meta" ,
"description" : [ ] ,
"signature" : [
"{ [x: string]: any; }"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
2021-08-09 18:51:00 +02:00
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.PersistenceAlertQueryService" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "PersistenceAlertQueryService" ,
"description" : [ ] ,
"signature" : [
"(query: " ,
"SearchRequest" ,
") => Promise<Record<string, unknown>[]>"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.PersistenceAlertQueryService.$1" ,
2021-08-09 18:51:00 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "query" ,
"description" : [ ] ,
"signature" : [
"SearchRequest"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.PersistenceAlertService" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "PersistenceAlertService" ,
"description" : [ ] ,
"signature" : [
"(alerts: { id: string; fields: Record<string, unknown>; }[], refresh: " ,
"Refresh" ,
") => Promise<" ,
"ApiResponse" ,
"<" ,
"BulkResponse" ,
", unknown>>"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.PersistenceAlertService.$1" ,
2021-08-09 18:51:00 +02:00
"type" : "Array" ,
"tags" : [ ] ,
"label" : "alerts" ,
"description" : [ ] ,
"signature" : [
"{ id: string; fields: Record<string, unknown>; }[]"
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
2021-09-14 16:44:20 +02:00
"id" : "def-server.PersistenceAlertService.$2" ,
2021-08-09 18:51:00 +02:00
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "refresh" ,
"description" : [ ] ,
"signature" : [
"boolean | \"wait_for\""
] ,
"path" : "x-pack/plugins/rule_registry/server/utils/persistence_types.ts" ,
"deprecated" : false
}
] ,
2021-08-02 22:44:47 +02:00
"initialIsOpen" : false
} ,
2021-05-06 21:08:20 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-05-20 22:11:31 +02:00
"id" : "def-server.RuleRegistryPluginConfig" ,
2021-05-06 21:08:20 +02:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-20 22:11:31 +02:00
"label" : "RuleRegistryPluginConfig" ,
2021-05-06 21:08:20 +02:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-09-28 22:58:56 +02:00
"any"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/config.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-06 21:08:20 +02:00
"initialIsOpen" : false
2021-08-30 17:02:04 +02:00
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.Settings" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "Settings" ,
"description" : [ ] ,
"signature" : [
"IndicesIndexSettings"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.Version" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "Version" ,
"description" : [ ] ,
"signature" : [
"number"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.WaitResult" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "WaitResult" ,
"description" : [ ] ,
"signature" : [
"Left" ,
"<Error> | " ,
"Right" ,
"<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.ElasticsearchClient" ,
"text" : "ElasticsearchClient"
} ,
">"
] ,
"path" : "x-pack/plugins/rule_registry/server/rule_data_client/rule_data_client.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
2021-05-20 22:11:31 +02:00
}
] ,
"objects" : [ ] ,
"setup" : {
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleRegistryPluginSetupContract" ,
2021-05-31 19:33:12 +02:00
"type" : "Interface" ,
2021-05-20 22:11:31 +02:00
"tags" : [ ] ,
"label" : "RuleRegistryPluginSetupContract" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-05-31 19:33:12 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleRegistryPluginSetupContract.ruleDataService" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "ruleDataService" ,
"description" : [ ] ,
"signature" : [
2021-08-05 18:26:16 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.RuleDataPluginService" ,
"text" : "RuleDataPluginService"
}
2021-05-31 19:33:12 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/plugin.ts" ,
2021-05-31 19:33:12 +02:00
"deprecated" : false
}
] ,
2021-05-20 22:11:31 +02:00
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleRegistryPluginStartContract" ,
2021-08-02 22:44:47 +02:00
"type" : "Interface" ,
2021-05-20 22:11:31 +02:00
"tags" : [ ] ,
"label" : "RuleRegistryPluginStartContract" ,
"description" : [ ] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-02 22:44:47 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getRacClientWithRequest" ,
"description" : [ ] ,
"signature" : [
"(req: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => Promise<" ,
2021-08-30 17:02:04 +02:00
{
"pluginId" : "ruleRegistry" ,
"scope" : "server" ,
"docId" : "kibRuleRegistryPluginApi" ,
"section" : "def-server.AlertsClient" ,
"text" : "AlertsClient"
} ,
2021-08-02 22:44:47 +02:00
">"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/plugin.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
2021-08-09 18:51:00 +02:00
"id" : "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest.$1" ,
2021-08-02 22:44:47 +02:00
"type" : "Object" ,
"tags" : [ ] ,
"label" : "req" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-08-02 22:44:47 +02:00
}
2021-08-09 18:51:00 +02:00
] ,
"returnComment" : [ ]
2021-08-02 22:44:47 +02:00
} ,
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-server.RuleRegistryPluginStartContract.alerting" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "alerting" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "alerting" ,
"scope" : "server" ,
"docId" : "kibAlertingPluginApi" ,
"section" : "def-server.PluginStartContract" ,
"text" : "PluginStartContract"
}
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/server/plugin.ts" ,
2021-08-02 22:44:47 +02:00
"deprecated" : false
}
] ,
2021-05-20 22:11:31 +02:00
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"common" : {
"classes" : [ ] ,
"functions" : [
2021-05-06 21:08:20 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "ruleRegistry" ,
2021-05-20 22:11:31 +02:00
"id" : "def-common.parseTechnicalFields" ,
"type" : "Function" ,
2021-05-06 21:08:20 +02:00
"tags" : [ ] ,
2021-05-20 22:11:31 +02:00
"label" : "parseTechnicalFields" ,
2021-05-06 21:08:20 +02:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"(input: unknown) => OutputOf<" ,
"Optional" ,
2021-10-11 19:58:18 +02:00
"<{ readonly \"kibana.alert.rule.params\": { readonly type: \"keyword\"; readonly index: false; }; readonly \"kibana.alert.rule.rule_type_id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.consumer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.rule.producer\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; readonly required: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.instance.id\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; readonly required: true; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.version\": { readonly type: \"version\"; readonly array: false; readonly required: false; }; readonly \"ecs.version\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.severity\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.risk_score\": { readonly type: \"float\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.workflow_user\": { 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.system_status\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.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 \"kibana.alert.rule.author\": { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly \"kibana.alert.rule.category\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; readonly \"kibana.alert.rule.uuid\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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.name\": { readonly type: \"keyword\"; readonly array: false; readonly required: true; }; 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 \" k i b a n a . a l e r t . r
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/common/parse_technical_fields.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-05-20 22:11:31 +02:00
"children" : [
{
"parentPluginId" : "ruleRegistry" ,
"id" : "def-common.parseTechnicalFields.$1" ,
"type" : "Unknown" ,
"tags" : [ ] ,
"label" : "input" ,
"description" : [ ] ,
"signature" : [
"unknown"
] ,
2021-08-05 18:26:16 +02:00
"path" : "x-pack/plugins/rule_registry/common/parse_technical_fields.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"isRequired" : true
}
2021-05-06 23:59:11 +02:00
] ,
2021-05-20 22:11:31 +02:00
"returnComment" : [ ] ,
2021-05-06 21:08:20 +02:00
"initialIsOpen" : false
}
] ,
2021-05-20 22:11:31 +02:00
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
2021-04-15 22:47:21 +02:00
}
}