mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
3957 lines
No EOL
130 KiB
JSON
3957 lines
No EOL
130 KiB
JSON
{
|
|
"id": "actions",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.Plugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "Plugin",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "public",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-public.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "@kbn/core-plugins-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnCorePluginsBrowserPluginApi",
|
|
"section": "def-common.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "public",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-public.ActionsPublicPluginSetup",
|
|
"text": "ActionsPublicPluginSetup"
|
|
},
|
|
", void, object, object>"
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.Plugin.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.Plugin.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ctx",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-plugins-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnCorePluginsBrowserPluginApi",
|
|
"section": "def-common.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<",
|
|
"Config",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.Plugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "public",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-public.ActionsPublicPluginSetup",
|
|
"text": "ActionsPublicPluginSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.Plugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.ActionsPublicPluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionsPublicPluginSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateEmailAddresses",
|
|
"description": [],
|
|
"signature": [
|
|
"(emails: string[], options?: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidateEmailAddressesOptions",
|
|
"text": "ValidateEmailAddressesOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidatedEmail",
|
|
"text": "ValidatedEmail"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "emails",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidateEmailAddressesOptions",
|
|
"text": "ValidateEmailAddressesOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/public/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "CaseConnector",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.CaseConnector",
|
|
"text": "CaseConnector"
|
|
},
|
|
"<Config, Secrets> extends ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.SubActionConnector",
|
|
"text": "SubActionConnector"
|
|
},
|
|
"<Config, Secrets> implements ",
|
|
"CaseConnectorInterface"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ServiceParams",
|
|
"text": "ServiceParams"
|
|
},
|
|
"<Config, Secrets>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.addComment",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addComment",
|
|
"description": [],
|
|
"signature": [
|
|
"({ incidentId, comment, }: { incidentId: string; comment: string; }) => Promise<unknown>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.addComment.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n incidentId,\n comment,\n }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.addComment.$1.incidentId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "incidentId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.addComment.$1.comment",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "comment",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.createIncident",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createIncident",
|
|
"description": [],
|
|
"signature": [
|
|
"(incident: Record<string, unknown>) => Promise<",
|
|
"ExternalServiceIncidentResponse",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.createIncident.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "incident",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.updateIncident",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateIncident",
|
|
"description": [],
|
|
"signature": [
|
|
"({ incidentId, incident, }: { incidentId: string; incident: Record<string, unknown>; }) => Promise<",
|
|
"ExternalServiceIncidentResponse",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.updateIncident.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n incidentId,\n incident,\n }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.updateIncident.$1.incidentId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "incidentId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.updateIncident.$1.incident",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "incident",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.getIncident",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIncident",
|
|
"description": [],
|
|
"signature": [
|
|
"({ id }: { id: string; }) => Promise<",
|
|
"ExternalServiceIncidentResponse",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.getIncident.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ id }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.getIncident.$1.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.pushToService",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pushToService",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: ",
|
|
"PushToServiceParams",
|
|
") => Promise<",
|
|
"PushToServiceResponse",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.CaseConnector.pushToService.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"PushToServiceParams"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SubActionConnector",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.SubActionConnector",
|
|
"text": "SubActionConnector"
|
|
},
|
|
"<Config, Secrets>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "server",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-server.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.connector",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "connector",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; type: string; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.config",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Config"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.secrets",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "secrets",
|
|
"description": [],
|
|
"signature": [
|
|
"Secrets"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ServiceParams",
|
|
"text": "ServiceParams"
|
|
},
|
|
"<Config, Secrets>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.registerSubAction",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerSubAction",
|
|
"description": [],
|
|
"signature": [
|
|
"(subAction: ",
|
|
"SubAction",
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.registerSubAction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "subAction",
|
|
"description": [],
|
|
"signature": [
|
|
"SubAction"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.removeNullOrUndefinedFields",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeNullOrUndefinedFields",
|
|
"description": [],
|
|
"signature": [
|
|
"(data: unknown) => unknown"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.removeNullOrUndefinedFields.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.getSubActions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSubActions",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Map<string, ",
|
|
"SubAction",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.getResponseErrorMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getResponseErrorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: ",
|
|
"AxiosError",
|
|
"<unknown, any>) => string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.getResponseErrorMessage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"AxiosError",
|
|
"<unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.request",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"<R>({ url, data, method, responseSchema, headers, ...config }: ",
|
|
"SubActionRequestParams",
|
|
"<R>) => Promise<",
|
|
"AxiosResponse",
|
|
"<R, any>>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.SubActionConnector.request.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n url,\n data,\n method = 'get',\n responseSchema,\n headers,\n ...config\n }",
|
|
"description": [],
|
|
"signature": [
|
|
"SubActionRequestParams",
|
|
"<R>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.UnsecuredActionsClient",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "UnsecuredActionsClient",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.UnsecuredActionsClient.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.UnsecuredActionsClient.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"UnsecuredActionsClientOpts"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.UnsecuredActionsClient.bulkEnqueueExecution",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkEnqueueExecution",
|
|
"description": [],
|
|
"signature": [
|
|
"(requesterId: string, actionsToExecute: ",
|
|
"ExecuteOptions",
|
|
"[]) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.UnsecuredActionsClient.bulkEnqueueExecution.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "requesterId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.UnsecuredActionsClient.bulkEnqueueExecution.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "actionsToExecute",
|
|
"description": [],
|
|
"signature": [
|
|
"ExecuteOptions",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asHttpRequestExecutionSource",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asHttpRequestExecutionSource",
|
|
"description": [],
|
|
"signature": [
|
|
"(source: ",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
"HttpRequestExecutionSource"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asHttpRequestExecutionSource.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asSavedObjectExecutionSource",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asSavedObjectExecutionSource",
|
|
"description": [],
|
|
"signature": [
|
|
"(source: Omit<",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
", \"name\">) => ",
|
|
"SavedObjectExecutionSource"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asSavedObjectExecutionSource.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
", \"name\">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.urlAllowListValidator",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "urlAllowListValidator",
|
|
"description": [],
|
|
"signature": [
|
|
"<T>(urlKey: string) => (obj: T, validatorServices: ",
|
|
"ValidatorServices",
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/helpers/validators.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.urlAllowListValidator.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "urlKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/helpers/validators.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Config>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.actionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.isMissingSecrets",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isMissingSecrets",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.config",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Config | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.isPreconfigured",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isPreconfigured",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.isDeprecated",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isDeprecated",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsApiRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionsApiRequestHandlerContext",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsApiRequestHandlerContext.getActionsClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionsClient",
|
|
"text": "ActionsClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsApiRequestHandlerContext.listTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "listTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"(featureId?: string | undefined) => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsApiRequestHandlerContext.listTypes.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "featureId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/action_type_registry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsPlugin",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionsPlugin",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsPlugin.setup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsPlugin.start",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PluginStartContract",
|
|
"text": "PluginStartContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.maxAttempts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxAttempts",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.supportedFeatureIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "supportedFeatureIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.validate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [],
|
|
"signature": [
|
|
"{ params?: ",
|
|
"ValidatorType",
|
|
"<Params> | undefined; config?: ",
|
|
"ValidatorType",
|
|
"<Config> | undefined; secrets?: ",
|
|
"ValidatorType",
|
|
"<Secrets> | undefined; connector?: ((config: Config, secrets: Secrets) => string | null) | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.renderParameterTemplates",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderParameterTemplates",
|
|
"description": [],
|
|
"signature": [
|
|
"RenderParameterTemplates",
|
|
"<Params> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.executor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "executor",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionTypeExecutorOptions",
|
|
"text": "ActionTypeExecutorOptions"
|
|
},
|
|
"<Config, Secrets, Params>) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<ExecutorResultData>>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.executor.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionTypeExecutorOptions",
|
|
"text": "ActionTypeExecutorOptions"
|
|
},
|
|
"<Config, Secrets, Params>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionTypeExecutorOptions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionTypeExecutorOptions",
|
|
"text": "ActionTypeExecutorOptions"
|
|
},
|
|
"<Config, Secrets, Params>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.actionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"signature": [
|
|
"Services"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.config",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Config"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.secrets",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "secrets",
|
|
"description": [],
|
|
"signature": [
|
|
"Secrets"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "server",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-server.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.isEphemeral",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isEphemeral",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.taskInfo",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "taskInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"TaskInfo",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.configurationUtilities",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "configurationUtilities",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionsConfigurationUtilities"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.FindActionResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FindActionResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.FindActionResult",
|
|
"text": "FindActionResult"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<",
|
|
"ActionTypeConfig",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.FindActionResult.referencedByCount",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "referencedByCount",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.IUnsecuredActionsClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IUnsecuredActionsClient",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.IUnsecuredActionsClient.bulkEnqueueExecution",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkEnqueueExecution",
|
|
"description": [],
|
|
"signature": [
|
|
"(requesterId: string, actionsToExecute: ",
|
|
"ExecuteOptions",
|
|
"[]) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.IUnsecuredActionsClient.bulkEnqueueExecution.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "requesterId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.IUnsecuredActionsClient.bulkEnqueueExecution.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "actionsToExecute",
|
|
"description": [],
|
|
"signature": [
|
|
"ExecuteOptions",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PreConfiguredAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PreConfiguredAction",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PreConfiguredAction",
|
|
"text": "PreConfiguredAction"
|
|
},
|
|
"<Config, Secrets> extends ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Config>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PreConfiguredAction.secrets",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "secrets",
|
|
"description": [],
|
|
"signature": [
|
|
"Secrets"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ServiceParams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ServiceParams",
|
|
"text": "ServiceParams"
|
|
},
|
|
"<Config, Secrets>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceParams.connector",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "connector",
|
|
"description": [
|
|
"\nThe type is the connector type id. For example \".servicenow\"\nThe id is the connector's SavedObject UUID."
|
|
],
|
|
"signature": [
|
|
"{ id: string; type: string; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceParams.config",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Config"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceParams.configurationUtilities",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "configurationUtilities",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionsConfigurationUtilities"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceParams.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "server",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-server.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceParams.secrets",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "secrets",
|
|
"description": [],
|
|
"signature": [
|
|
"Secrets"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceParams.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"signature": [
|
|
"Services"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ACTION_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACTION_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"action\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/constants/saved_objects.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsAuthorization",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionsAuthorization",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise<void>; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsClient",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ get: ({ id }: { id: string; }) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<",
|
|
"ActionTypeConfig",
|
|
">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: ({ action: { actionTypeId, name, config, secrets }, }: ",
|
|
"CreateOptions",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<",
|
|
"ActionTypeConfig",
|
|
">>; update: ({ id, action }: ",
|
|
"UpdateOptions",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<",
|
|
"ActionTypeConfig",
|
|
">>; execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<",
|
|
"ExecuteOptions",
|
|
"<unknown>, \"request\">) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<unknown>>; getAll: () => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.FindActionResult",
|
|
"text": "FindActionResult"
|
|
},
|
|
"[]>; getBulk: (ids: string[]) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<",
|
|
"ActionTypeConfig",
|
|
">[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { options: Readonly<{} & { config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; tokenUrl: string; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { scope: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; tokenUrl: string; secrets: Readonly<{} & { clientSecret: string; }>; }>; type: \"client\" | \"jwt\"; }>, configurationUtilities: ",
|
|
"ActionsConfigurationUtilities",
|
|
") => Promise<{ accessToken: string | null; }>; enqueueExecution: (options: ",
|
|
"ExecuteOptions",
|
|
") => Promise<void>; bulkEnqueueExecution: (options: ",
|
|
"ExecuteOptions",
|
|
"[]) => Promise<void>; ephemeralEnqueuedExecution: (options: ",
|
|
"ExecuteOptions",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.RunNowResult",
|
|
"text": "RunNowResult"
|
|
},
|
|
">; listTypes: (featureId?: string | undefined) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginSetupContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.registerType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerType",
|
|
"description": [],
|
|
"signature": [
|
|
"<Config extends ",
|
|
"ActionTypeConfig",
|
|
" = ",
|
|
"ActionTypeConfig",
|
|
", Secrets extends ",
|
|
"ActionTypeSecrets",
|
|
" = ",
|
|
"ActionTypeSecrets",
|
|
", Params extends ",
|
|
"ActionTypeParams",
|
|
" = ",
|
|
"ActionTypeParams",
|
|
", ExecutorResultData = void>(actionType: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>) => void"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.registerType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actionType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.registerSubActionConnectorType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerSubActionConnectorType",
|
|
"description": [],
|
|
"signature": [
|
|
"<Config extends ",
|
|
"ActionTypeConfig",
|
|
" = ",
|
|
"ActionTypeConfig",
|
|
", Secrets extends ",
|
|
"ActionTypeSecrets",
|
|
" = ",
|
|
"ActionTypeSecrets",
|
|
">(connector: ",
|
|
"SubActionConnectorType",
|
|
"<Config, Secrets>) => void"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.registerSubActionConnectorType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "connector",
|
|
"description": [],
|
|
"signature": [
|
|
"SubActionConnectorType",
|
|
"<Config, Secrets>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.isPreconfiguredConnector",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isPreconfiguredConnector",
|
|
"description": [],
|
|
"signature": [
|
|
"(connectorId: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.isPreconfiguredConnector.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "connectorId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.getSubActionConnectorClass",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSubActionConnectorClass",
|
|
"description": [],
|
|
"signature": [
|
|
"<Config, Secrets>() => ",
|
|
"IServiceAbstract",
|
|
"<Config, Secrets>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.getCaseConnectorClass",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCaseConnectorClass",
|
|
"description": [],
|
|
"signature": [
|
|
"<Config, Secrets>() => ",
|
|
"IServiceAbstract",
|
|
"<Config, Secrets>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.getActionsHealth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionsHealth",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { hasPermanentEncryptionKey: boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginStartContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isActionTypeEnabled",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string, options?: { notifyUsage: boolean; } | undefined) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.$2.notifyUsage",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "notifyUsage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isActionExecutable",
|
|
"description": [],
|
|
"signature": [
|
|
"(actionId: string, actionTypeId: string, options?: { notifyUsage: boolean; } | undefined) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$3.notifyUsage",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "notifyUsage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getAllTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsClientWithRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionsClientWithRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.PublicMethodsOf",
|
|
"text": "PublicMethodsOf"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionsClient",
|
|
"text": "ActionsClient"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsClientWithRequest.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionsAuthorizationWithRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.PublicMethodsOf",
|
|
"text": "PublicMethodsOf"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionsAuthorization",
|
|
"text": "ActionsAuthorization"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.preconfiguredActions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "preconfiguredActions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PreConfiguredAction",
|
|
"text": "PreConfiguredAction"
|
|
},
|
|
"<",
|
|
"ActionTypeConfig",
|
|
", ",
|
|
"ActionTypeSecrets",
|
|
">[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getUnsecuredActionsClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUnsecuredActionsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.IUnsecuredActionsClient",
|
|
"text": "IUnsecuredActionsClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderActionParameterTemplates",
|
|
"description": [],
|
|
"signature": [
|
|
"<Params extends ",
|
|
"ActionTypeParams",
|
|
" = ",
|
|
"ActionTypeParams",
|
|
">(actionTypeId: string, actionId: string, params: Params, variables: Record<string, unknown>) => Params"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.areValidFeatures",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "areValidFeatures",
|
|
"description": [],
|
|
"signature": [
|
|
"(ids: string[]) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.areValidFeatures.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "ids",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.buildAlertHistoryDocument",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "buildAlertHistoryDocument",
|
|
"description": [],
|
|
"signature": [
|
|
"(variables: Record<string, unknown>) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record<string, unknown>; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record<string, unknown>; } | undefined; name?: string | undefined; id?: string | undefined; } | undefined; message?: unknown; tags?: string[] | undefined; '@timestamp': string; } | null"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.buildAlertHistoryDocument.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.getConnectorCompatibility",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConnectorCompatibility",
|
|
"description": [],
|
|
"signature": [
|
|
"(featureIds: string[] | undefined) => string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.getConnectorCompatibility.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "featureIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.getConnectorFeatureName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConnectorFeatureName",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.getConnectorFeatureName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.hasMustacheTemplate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasMustacheTemplate",
|
|
"description": [
|
|
"does the string contain `{{.*}}`?"
|
|
],
|
|
"signature": [
|
|
"(string: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/mustache_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.hasMustacheTemplate.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "string",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/mustache_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.invalidEmailsAsMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "invalidEmailsAsMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"(validatedEmails: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidatedEmail",
|
|
"text": "ValidatedEmail"
|
|
},
|
|
"[]) => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.invalidEmailsAsMessage.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "validatedEmails",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidatedEmail",
|
|
"text": "ValidatedEmail"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.isActionTypeExecutorResult",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isActionTypeExecutorResult",
|
|
"description": [],
|
|
"signature": [
|
|
"(result: unknown) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.isActionTypeExecutorResult.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "result",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.validateEmailAddresses",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateEmailAddresses",
|
|
"description": [],
|
|
"signature": [
|
|
"(allowedDomains: string[] | null, addresses: string[], options: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidateEmailAddressesOptions",
|
|
"text": "ValidateEmailAddressesOptions"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidatedEmail",
|
|
"text": "ValidatedEmail"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.validateEmailAddresses.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "allowedDomains",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | null"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.validateEmailAddresses.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "addresses",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.validateEmailAddresses.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidateEmailAddressesOptions",
|
|
"text": "ValidateEmailAddressesOptions"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.validateEmailAddressesAsAlwaysValid",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateEmailAddressesAsAlwaysValid",
|
|
"description": [],
|
|
"signature": [
|
|
"(addresses: string[]) => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ValidatedEmail",
|
|
"text": "ValidatedEmail"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.validateEmailAddressesAsAlwaysValid.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "addresses",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.withoutMustacheTemplate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "withoutMustacheTemplate",
|
|
"description": [
|
|
"filter strings that do not contain `{{.*}}`"
|
|
],
|
|
"signature": [
|
|
"(strings: string[]) => string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/mustache_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.withoutMustacheTemplate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "strings",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/mustache_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.actionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.isPreconfigured",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isPreconfigured",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionsPublicConfigType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionsPublicConfigType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionsPublicConfigType.allowedEmailDomains",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "allowedEmailDomains",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.enabledInConfig",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabledInConfig",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.enabledInLicense",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabledInLicense",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.supportedFeatureIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "supportedFeatureIds",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionTypeExecutorResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<Data>"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.actionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"error\" | \"ok\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.serviceMessage",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "serviceMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.data",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"Data | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.retry",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "retry",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | Date | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ValidatedEmail",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ValidatedEmail",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ValidatedEmail.address",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "address",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ValidatedEmail.valid",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "valid",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ValidatedEmail.reason",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "reason",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.InvalidEmailReason",
|
|
"text": "InvalidEmailReason"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ValidateEmailAddressesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ValidateEmailAddressesOptions",
|
|
"description": [
|
|
"Options that can be used when validating email addresses"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ValidateEmailAddressesOptions.treatMustacheTemplatesAsValid",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "treatMustacheTemplatesAsValid",
|
|
"description": [
|
|
"treat any address which contains a mustache template as valid"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/validate_email_addresses.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.InvalidEmailReason",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "InvalidEmailReason",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ACTIONS_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACTIONS_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"actions\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorRawResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionTypeExecutorRawResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<Data> & { error?: Error | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ALERT_HISTORY_PREFIX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ALERT_HISTORY_PREFIX",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana-alert-history-\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertHistoryDefaultIndexName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AlertHistoryDefaultIndexName",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertHistoryDocumentTemplate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "AlertHistoryDocumentTemplate",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record<string, unknown>; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record<string, unknown>; } | undefined; name?: string | undefined; id?: string | undefined; } | undefined; message?: unknown; tags?: string[] | undefined; '@timestamp': string; }> | null"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertHistoryEsIndexConnectorId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AlertHistoryEsIndexConnectorId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"preconfigured-alert-history-es-index\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertingConnectorFeatureId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AlertingConnectorFeatureId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"alerting\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AsApiContract",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AsApiContract",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: T[K]; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.BASE_ACTION_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "BASE_ACTION_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/api/actions\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.CasesConnectorFeatureId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CasesConnectorFeatureId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"cases\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.INTERNAL_BASE_ACTION_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_BASE_ACTION_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/actions\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteRequestCase",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RewriteRequestCase",
|
|
"description": [],
|
|
"signature": [
|
|
"(requested: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.AsApiContract",
|
|
"text": "AsApiContract"
|
|
},
|
|
"<T>) => T"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteRequestCase.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requested",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: T[K]; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteResponseCase",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RewriteResponseCase",
|
|
"description": [],
|
|
"signature": [
|
|
"(responded: T) => T extends (infer Item)[] ? ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.AsApiContract",
|
|
"text": "AsApiContract"
|
|
},
|
|
"<Item>[] : ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.AsApiContract",
|
|
"text": "AsApiContract"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteResponseCase.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "responded",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.SecurityConnectorFeatureId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SecurityConnectorFeatureId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"siem\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.UptimeConnectorFeatureId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UptimeConnectorFeatureId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"uptime\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertingConnectorFeature",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "AlertingConnectorFeature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertingConnectorFeature.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertingConnectorFeature.name",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertingConnectorFeature.compatibility",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "compatibility",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.CasesConnectorFeature",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "CasesConnectorFeature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.CasesConnectorFeature.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.CasesConnectorFeature.name",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.CasesConnectorFeature.compatibility",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "compatibility",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.MustacheInEmailRegExp",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "MustacheInEmailRegExp",
|
|
"description": [],
|
|
"signature": [
|
|
"RegExp"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/mustache_template.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.SecuritySolutionFeature",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "SecuritySolutionFeature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.SecuritySolutionFeature.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.SecuritySolutionFeature.name",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.SecuritySolutionFeature.compatibility",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "compatibility",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.UptimeConnectorFeature",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "UptimeConnectorFeature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.UptimeConnectorFeature.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.UptimeConnectorFeature.name",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.UptimeConnectorFeature.compatibility",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "compatibility",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |