{ "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": "public", "docId": "kibKbnCorePluginsBrowserPluginApi", "section": "def-public.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": "public", "docId": "kibKbnCorePluginsBrowserPluginApi", "section": "def-public.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" }, " extends ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.SubActionConnector", "text": "SubActionConnector" }, " 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" }, "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.Unnamed.$2", "type": "Object", "tags": [], "label": "pushToServiceIncidentParamsSchema", "description": [], "signature": [ "Record>" ], "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; }, connectorUsageCollector: ", "ConnectorUsageCollector", ") => Promise" ], "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 } ] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.addComment.$2", "type": "Object", "tags": [], "label": "connectorUsageCollector", "description": [], "signature": [ "ConnectorUsageCollector" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.createIncident", "type": "Function", "tags": [], "label": "createIncident", "description": [], "signature": [ "(incident: Incident, connectorUsageCollector: ", "ConnectorUsageCollector", ") => 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": "Uncategorized", "tags": [], "label": "incident", "description": [], "signature": [ "Incident" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.createIncident.$2", "type": "Object", "tags": [], "label": "connectorUsageCollector", "description": [], "signature": [ "ConnectorUsageCollector" ], "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: Incident; }, connectorUsageCollector: ", "ConnectorUsageCollector", ") => 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": "Uncategorized", "tags": [], "label": "incident", "description": [], "signature": [ "Incident" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.updateIncident.$2", "type": "Object", "tags": [], "label": "connectorUsageCollector", "description": [], "signature": [ "ConnectorUsageCollector" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.getIncident", "type": "Function", "tags": [], "label": "getIncident", "description": [], "signature": [ "({ id }: { id: string; }, connectorUsageCollector: ", "ConnectorUsageCollector", ") => Promise" ], "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 } ] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.getIncident.$2", "type": "Object", "tags": [], "label": "connectorUsageCollector", "description": [], "signature": [ "ConnectorUsageCollector" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.pushToService", "type": "Function", "tags": [], "label": "pushToService", "description": [], "signature": [ "(params: { incident: { externalId: string | null; } & Incident; comments: { commentId: string; comment: string; }[]; }, connectorUsageCollector: ", "ConnectorUsageCollector", ") => 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": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.pushToService.$1.incident", "type": "CompoundType", "tags": [], "label": "incident", "description": [], "signature": [ "{ externalId: string | null; } & Incident" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.pushToService.$1.comments", "type": "Array", "tags": [], "label": "comments", "description": [], "signature": [ "{ commentId: string; comment: string; }[]" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.pushToService.$2", "type": "Object", "tags": [], "label": "connectorUsageCollector", "description": [], "signature": [ "ConnectorUsageCollector" ], "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" }, "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.SubActionConnector.kibanaRequest", "type": "Object", "tags": [], "label": "kibanaRequest", "description": [], "signature": [ { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | undefined" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.logger", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.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.esClient", "type": "Object", "tags": [], "label": "esClient", "description": [], "signature": [ "{ create: { (this: That, params: ", "CreateRequest", " | ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "CreateRequest", " | ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "CreateRequest", " | ", "CreateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; update: { (this: That, params: ", "UpdateRequest", " | ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateResponse", ">; (this: That, params: ", "UpdateRequest", " | ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateResponse", ", unknown>>; (this: That, params: ", "UpdateRequest", " | ", "UpdateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", ">; }; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetResponse", ">; (this: That, params: ", "GetRequest", " | ", "GetRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetResponse", ", unknown>>; (this: That, params: ", "GetRequest", " | ", "GetRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetResponse", ">; }; delete: { (this: That, params: ", "DeleteRequest", " | ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "DeleteRequest", " | ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "DeleteRequest", " | ", "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; helpers: ", "default", "; search: { >(this: That, params?: ", "SearchRequest", " | ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchResponse", ">; >(this: That, params?: ", "SearchRequest", " | ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchResponse", ", unknown>>; >(this: That, params?: ", "SearchRequest", " | ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchResponse", ">; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kConnector]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kProfiling]: symbol | null; [kQueryRules]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSimulate]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", ") => ", "default", "; asyncSearch: ", "default", "; autoscaling: ", "default", "; bulk: { (this: That, params: ", "BulkRequest", " | ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "BulkResponse", ">; (this: That, params: ", "BulkRequest", " | ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "BulkResponse", ", unknown>>; (this: That, params: ", "BulkRequest", " | ", "BulkRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "BulkResponse", ">; }; capabilities: { (this: That, params?: ", "TODO", " | ", "TODO", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TODO", ">; (this: That, params?: ", "TODO", " | ", "TODO", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TODO", ", unknown>>; (this: That, params?: ", "TODO", " | ", "TODO", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "TODO", ">; }; cat: ", "default", "; ccr: ", "default", "; clearScroll: { (this: That, params?: ", "ClearScrollRequest", " | ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClearScrollResponse", ">; (this: That, params?: ", "ClearScrollRequest", " | ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClearScrollResponse", ", unknown>>; (this: That, params?: ", "ClearScrollRequest", " | ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClearScrollResponse", ">; }; closePointInTime: { (this: That, params: ", "ClosePointInTimeRequest", " | ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClosePointInTimeResponse", ">; (this: That, params: ", "ClosePointInTimeRequest", " | ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClosePointInTimeResponse", ", unknown>>; (this: That, params: ", "ClosePointInTimeRequest", " | ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", ">; }; cluster: ", "default", "; connector: ", "default", "; count: { (this: That, params?: ", "CountRequest", " | ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "CountResponse", ">; (this: That, params?: ", "CountRequest", " | ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "CountResponse", ", unknown>>; (this: That, params?: ", "CountRequest", " | ", "CountRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "CountResponse", ">; }; danglingIndices: ", "default", "; deleteByQuery: { (this: That, params: ", "DeleteByQueryRequest", " | ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "DeleteByQueryResponse", ">; (this: That, params: ", "DeleteByQueryRequest", " | ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "DeleteByQueryResponse", ", unknown>>; (this: That, params: ", "DeleteByQueryRequest", " | ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "DeleteByQueryResponse", ">; }; deleteByQueryRethrottle: { (this: That, params: ", "DeleteByQueryRethrottleRequest", " | ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TasksTaskListResponseBase", ">; (this: That, params: ", "DeleteByQueryRethrottleRequest", " | ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TasksTaskListResponseBase", ", unknown>>; (this: That, params: ", "DeleteByQueryRethrottleRequest", " | ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TasksTaskListResponseBase", ">; }; deleteScript: { (this: That, params: ", "DeleteScriptRequest", " | ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "DeleteScriptRequest", " | ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "DeleteScriptRequest", " | ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; enrich: ", "default", "; eql: ", "default", "; esql: ", "default", "; exists: { (this: That, params: ", "ExistsRequest", " | ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsRequest", " | ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsRequest", " | ", "ExistsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; existsSource: { (this: That, params: ", "ExistsSourceRequest", " | ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsSourceRequest", " | ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsSourceRequest", " | ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; explain: { (this: That, params: ", "ExplainRequest", " | ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ExplainResponse", ">; (this: That, params: ", "ExplainRequest", " | ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ExplainResponse", ", unknown>>; (this: That, params: ", "ExplainRequest", " | ", "ExplainRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ExplainResponse", ">; }; features: ", "default", "; fieldCaps: { (this: That, params?: ", "FieldCapsRequest", " | ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "FieldCapsResponse", ">; (this: That, params?: ", "FieldCapsRequest", " | ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "FieldCapsResponse", ", unknown>>; (this: That, params?: ", "FieldCapsRequest", " | ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "FieldCapsResponse", ">; }; fleet: ", "default", "; getScript: { (this: That, params: ", "GetScriptRequest", " | ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptResponse", ">; (this: That, params: ", "GetScriptRequest", " | ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptResponse", ", unknown>>; (this: That, params: ", "GetScriptRequest", " | ", "GetScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptResponse", ">; }; getScriptContext: { (this: That, params?: ", "GetScriptContextRequest", " | ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptContextResponse", ">; (this: That, params?: ", "GetScriptContextRequest", " | ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptContextResponse", ", unknown>>; (this: That, params?: ", "GetScriptContextRequest", " | ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptContextResponse", ">; }; getScriptLanguages: { (this: That, params?: ", "GetScriptLanguagesRequest", " | ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; (this: That, params?: ", "GetScriptLanguagesRequest", " | ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptLanguagesResponse", ", unknown>>; (this: That, params?: ", "GetScriptLanguagesRequest", " | ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; }; getSource: { (this: That, params: ", "GetSourceRequest", " | ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "GetSourceRequest", " | ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "GetSourceRequest", " | ", "GetSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; graph: ", "default", "; healthReport: { (this: That, params?: ", "HealthReportRequest", " | ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "HealthReportResponse", ">; (this: That, params?: ", "HealthReportRequest", " | ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "HealthReportResponse", ", unknown>>; (this: That, params?: ", "HealthReportRequest", " | ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "HealthReportResponse", ">; }; ilm: ", "default", "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "IndexRequest", " | ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "IndexRequest", " | ", "IndexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; indices: ", "default", "; inference: ", "default", "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "InfoResponse", ">; (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "InfoResponse", ", unknown>>; (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "InfoResponse", ">; }; ingest: ", "default", "; knnSearch: { (this: That, params: ", "KnnSearchRequest", " | ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "KnnSearchResponse", ">; (this: That, params: ", "KnnSearchRequest", " | ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "KnnSearchResponse", ", unknown>>; (this: That, params: ", "KnnSearchRequest", " | ", "KnnSearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "KnnSearchResponse", ">; }; license: ", "default", "; logstash: ", "default", "; mget: { (this: That, params?: ", "MgetRequest", " | ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MgetResponse", ">; (this: That, params?: ", "MgetRequest", " | ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MgetResponse", ", unknown>>; (this: That, params?: ", "MgetRequest", " | ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MgetResponse", ">; }; migration: ", "default", "; ml: ", "default", "; monitoring: ", "default", "; msearch: { >(this: That, params: ", "MsearchRequest", " | ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchResponse", ">; >(this: That, params: ", "MsearchRequest", " | ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchResponse", ", unknown>>; >(this: That, params: ", "MsearchRequest", " | ", "MsearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchResponse", ">; }; msearchTemplate: { >(this: That, params: ", "MsearchTemplateRequest", " | ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchTemplateResponse", ">; >(this: That, params: ", "MsearchTemplateRequest", " | ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchTemplateResponse", ", unknown>>; >(this: That, params: ", "MsearchTemplateRequest", " | ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchTemplateResponse", ">; }; mtermvectors: { (this: That, params?: ", "MtermvectorsRequest", " | ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MtermvectorsResponse", ">; (this: That, params?: ", "MtermvectorsRequest", " | ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MtermvectorsResponse", ", unknown>>; (this: That, params?: ", "MtermvectorsRequest", " | ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", ">; }; nodes: ", "default", "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "OpenPointInTimeResponse", ">; (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "OpenPointInTimeResponse", ", unknown>>; (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", ">; }; ping: { (this: That, params?: ", "PingRequest", " | ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params?: ", "PingRequest", " | ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params?: ", "PingRequest", " | ", "PingRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise; }; profiling: ", "default", "; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; queryRules: ", "default", "; rankEval: { (this: That, params: ", "RankEvalRequest", " | ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RankEvalResponse", ">; (this: That, params: ", "RankEvalRequest", " | ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RankEvalResponse", ", unknown>>; (this: That, params: ", "RankEvalRequest", " | ", "RankEvalRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "RankEvalResponse", ">; }; reindex: { (this: That, params: ", "ReindexRequest", " | ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexResponse", ">; (this: That, params: ", "ReindexRequest", " | ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexResponse", ", unknown>>; (this: That, params: ", "ReindexRequest", " | ", "ReindexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexResponse", ">; }; reindexRethrottle: { (this: That, params: ", "ReindexRethrottleRequest", " | ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexRethrottleResponse", ">; (this: That, params: ", "ReindexRethrottleRequest", " | ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexRethrottleResponse", ", unknown>>; (this: That, params: ", "ReindexRethrottleRequest", " | ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexRethrottleResponse", ">; }; renderSearchTemplate: { (this: That, params?: ", "RenderSearchTemplateRequest", " | ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; (this: That, params?: ", "RenderSearchTemplateRequest", " | ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RenderSearchTemplateResponse", ", unknown>>; (this: That, params?: ", "RenderSearchTemplateRequest", " | ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; }; rollup: ", "default", "; scriptsPainlessExecute: { (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScriptsPainlessExecuteResponse", ", unknown>>; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; }; scroll: { >(this: That, params: ", "ScrollRequest", " | ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScrollResponse", ">; >(this: That, params: ", "ScrollRequest", " | ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScrollResponse", ", unknown>>; >(this: That, params: ", "ScrollRequest", " | ", "ScrollRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScrollResponse", ">; }; searchApplication: ", "default", "; searchMvt: { (this: That, params: ", "SearchMvtRequest", " | ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "SearchMvtRequest", " | ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "SearchMvtRequest", " | ", "SearchMvtRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; searchShards: { (this: That, params?: ", "SearchShardsRequest", " | ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchShardsResponse", ">; (this: That, params?: ", "SearchShardsRequest", " | ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchShardsResponse", ", unknown>>; (this: That, params?: ", "SearchShardsRequest", " | ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchShardsResponse", ">; }; searchTemplate: { (this: That, params?: ", "SearchTemplateRequest", " | ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchTemplateResponse", ">; (this: That, params?: ", "SearchTemplateRequest", " | ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchTemplateResponse", ", unknown>>; (this: That, params?: ", "SearchTemplateRequest", " | ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", "; security: ", "default", "; shutdown: ", "default", "; simulate: ", "default", "; slm: ", "default", "; snapshot: ", "default", "; sql: ", "default", "; ssl: ", "default", "; synonyms: ", "default", "; tasks: ", "default", "; termsEnum: { (this: That, params: ", "TermsEnumRequest", " | ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermsEnumResponse", ">; (this: That, params: ", "TermsEnumRequest", " | ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermsEnumResponse", ", unknown>>; (this: That, params: ", "TermsEnumRequest", " | ", "TermsEnumRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermsEnumResponse", ">; }; termvectors: { (this: That, params: ", "TermvectorsRequest", " | ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermvectorsResponse", ">; (this: That, params: ", "TermvectorsRequest", " | ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermvectorsResponse", ", unknown>>; (this: That, params: ", "TermvectorsRequest", " | ", "TermvectorsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermvectorsResponse", ">; }; textStructure: ", "default", "; transform: ", "default", "; updateByQuery: { (this: That, params: ", "UpdateByQueryRequest", " | ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryResponse", ">; (this: That, params: ", "UpdateByQueryRequest", " | ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRequest", " | ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryResponse", ">; }; updateByQueryRethrottle: { (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryRethrottleResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; }; watcher: ", "default", "; xpack: ", "default", "; }" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.savedObjectsClient", "type": "Object", "tags": [], "label": "savedObjectsClient", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-api-server", "scope": "server", "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", "section": "def-server.SavedObjectsClientContract", "text": "SavedObjectsClientContract" } ], "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" }, "" ], "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" ], "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", ") => 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", "" ], "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": [ "({ url, data, method, responseSchema, headers, timeout, ...config }: ", "SubActionRequestParams", ", connectorUsageCollector: ", "ConnectorUsageCollector", ") => Promise<", "AxiosResponse", ">" ], "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 timeout,\n ...config\n }", "description": [], "signature": [ "SubActionRequestParams", "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.request.$2", "type": "Object", "tags": [], "label": "connectorUsageCollector", "description": [], "signature": [ "ConnectorUsageCollector" ], "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": "opts", "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.execute", "type": "Function", "tags": [], "label": "execute", "description": [], "signature": [ "({ requesterId, id, params, relatedSavedObjects, spaceId, }: UnsecuredExecuteOptions) => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, ">" ], "path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.UnsecuredActionsClient.execute.$1", "type": "CompoundType", "tags": [], "label": "{\n requesterId,\n id,\n params,\n relatedSavedObjects,\n spaceId,\n }", "description": [], "signature": [ "UnsecuredExecuteOptions" ], "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<", "ExecutionResponse", ">" ], "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": [] }, { "parentPluginId": "actions", "id": "def-server.UnsecuredActionsClient.getAll", "type": "Function", "tags": [], "label": "getAll", "description": [], "signature": [ "(spaceId: string) => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[]>" ], "path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.UnsecuredActionsClient.getAll.$1", "type": "string", "tags": [], "label": "spaceId", "description": [], "signature": [ "string" ], "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" }, ") => ", "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" }, "" ], "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.asNotificationExecutionSource", "type": "Function", "tags": [], "label": "asNotificationExecutionSource", "description": [], "signature": [ "(source: ", "NotificationSource", ") => ", "NotificationExecutionSource" ], "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.asNotificationExecutionSource.$1", "type": "Object", "tags": [], "label": "source", "description": [], "signature": [ "NotificationSource" ], "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.getBasicAuthHeader", "type": "Function", "tags": [], "label": "getBasicAuthHeader", "description": [], "signature": [ "({ username, password }: GetBasicAuthHeaderArgs) => { Authorization: string; }" ], "path": "x-pack/plugins/actions/server/lib/get_basic_auth_header.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.getBasicAuthHeader.$1", "type": "Object", "tags": [], "label": "{ username, password }", "description": [], "signature": [ "GetBasicAuthHeaderArgs" ], "path": "x-pack/plugins/actions/server/lib/get_basic_auth_header.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.urlAllowListValidator", "type": "Function", "tags": [], "label": "urlAllowListValidator", "description": [], "signature": [ "(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.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" }, "" ], "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", "; config: ", "ValidatorType", "; secrets: ", "ValidatorType", "; connector?: ((config: Config, secrets: Secrets) => string | null) | undefined; }" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.isSystemActionType", "type": "CompoundType", "tags": [], "label": "isSystemActionType", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.getKibanaPrivileges", "type": "Function", "tags": [], "label": "getKibanaPrivileges", "description": [ "\nAdditional Kibana privileges to be checked by the actions framework.\nUse it if you want to perform extra authorization checks based on a Kibana feature.\nFor example, you can define the privileges a users needs to have to execute\na Case or OsQuery system action.\n\nThe list of the privileges follows the Kibana privileges format usually generated with `security.authz.actions.*.get(...)`.\n\nIt only works with system actions and only when executing an action.\nFor all other scenarios they will be ignored" ], "signature": [ "((args?: { params?: Params | undefined; } | undefined) => string[]) | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionType.getKibanaPrivileges.$1", "type": "Object", "tags": [], "label": "args", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionType.getKibanaPrivileges.$1.params", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates", "type": "Function", "tags": [], "label": "renderParameterTemplates", "description": [], "signature": [ "RenderParameterTemplates", " | 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" }, ") => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, ">" ], "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" }, "" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "actions", "id": "def-server.ActionType.getService", "type": "Function", "tags": [], "label": "getService", "description": [], "signature": [ "((params: ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ServiceParams", "text": "ServiceParams" }, ") => ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.SubActionConnector", "text": "SubActionConnector" }, ") | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionType.getService.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ServiceParams", "text": "ServiceParams" }, "" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "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" }, "" ], "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": "CompoundType", "tags": [], "label": "services", "description": [], "signature": [ "Services", " | ", "UnsecuredServices" ], "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": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.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 }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.source", "type": "Object", "tags": [], "label": "source", "description": [], "signature": [ "ActionExecutionSource", " | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.connectorUsageCollector", "type": "Object", "tags": [], "label": "connectorUsageCollector", "description": [], "signature": [ "ConnectorUsageCollector" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ConnectorWithExtraFindData", "type": "Interface", "tags": [], "label": "ConnectorWithExtraFindData", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, " extends ", "Connector" ], "path": "x-pack/plugins/actions/server/application/connector/types/connector.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ConnectorWithExtraFindData.referencedByCount", "type": "number", "tags": [], "label": "referencedByCount", "description": [], "path": "x-pack/plugins/actions/server/application/connector/types/connector.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.InMemoryConnector", "type": "Interface", "tags": [], "label": "InMemoryConnector", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.InMemoryConnector", "text": "InMemoryConnector" }, " extends ", "Connector" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.InMemoryConnector.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.InMemoryConnector.config", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "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.getAll", "type": "Function", "tags": [], "label": "getAll", "description": [], "signature": [ "(spaceId: string) => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[]>" ], "path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.IUnsecuredActionsClient.getAll.$1", "type": "string", "tags": [], "label": "spaceId", "description": [], "signature": [ "string" ], "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.IUnsecuredActionsClient.execute", "type": "Function", "tags": [], "label": "execute", "description": [], "signature": [ "(opts: UnsecuredExecuteOptions) => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, ">" ], "path": "x-pack/plugins/actions/server/unsecured_actions_client/unsecured_actions_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.IUnsecuredActionsClient.execute.$1", "type": "CompoundType", "tags": [], "label": "opts", "description": [], "signature": [ "UnsecuredExecuteOptions" ], "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.IUnsecuredActionsClient.bulkEnqueueExecution", "type": "Function", "tags": [], "label": "bulkEnqueueExecution", "description": [], "signature": [ "(requesterId: string, actionsToExecute: ", "ExecuteOptions", "[]) => Promise<", "ExecutionResponse", ">" ], "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.ServiceParams", "type": "Interface", "tags": [], "label": "ServiceParams", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ServiceParams", "text": "ServiceParams" }, "" ], "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": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.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 }, { "parentPluginId": "actions", "id": "def-server.ServiceParams.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | undefined" ], "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.ActionResult", "type": "Type", "tags": [], "label": "ActionResult", "description": [], "signature": [ "Connector" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionsAuthorization", "type": "Type", "tags": [], "label": "ActionsAuthorization", "description": [], "signature": [ "{ ensureAuthorized: ({ operation, actionTypeId, additionalPrivileges, }: { operation: string; actionTypeId?: string | undefined; additionalPrivileges?: string[] | undefined; }) => Promise; }" ], "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": [ "{ execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<", "ExecuteOptions", ", \"actionExecutionId\" | \"request\">) => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, ">; create: ({ action: { actionTypeId, name, config, secrets }, options, }: ", "CreateOptions", ") => Promise<", "Connector", ">; update: ({ id, action }: ", "UpdateOptions", ") => Promise<", "Connector", ">; get: ({ id, throwIfSystemAction, }: { id: string; throwIfSystemAction?: boolean | undefined; }) => Promise<", "Connector", ">; getAll: ({ includeSystemActions }?: { includeSystemActions?: boolean | undefined; }) => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[]>; getAllSystemConnectors: () => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ConnectorWithExtraFindData", "text": "ConnectorWithExtraFindData" }, "[]>; getBulk: ({ ids, throwIfSystemAction, }: { ids: string[]; throwIfSystemAction?: boolean | undefined; }) => Promise<", "Connector", "[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { type: \"jwt\" | \"client\"; options: Readonly<{} & { tokenUrl: string; config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { tokenUrl: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; secrets: Readonly<{} & { clientSecret: string; }>; scope: string; }>; }>, configurationUtilities: ", "ActionsConfigurationUtilities", ") => Promise<{ accessToken: string | null; }>; delete: ({ id }: { id: string; }) => Promise<{}>; bulkEnqueueExecution: (options: ", "ExecuteOptions", "[]) => Promise<", "ExecutionResponse", ">; ephemeralEnqueuedExecution: (options: ", "ExecuteOptions", ") => Promise<", { "pluginId": "taskManager", "scope": "server", "docId": "kibTaskManagerPluginApi", "section": "def-server.RunNowResult", "text": "RunNowResult" }, ">; listTypes: ({ featureId, includeSystemActionTypes, }?: ", "ListTypesParams", ") => Promise<", "ConnectorType", "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; isSystemAction: (connectorId: string) => boolean; getGlobalExecutionLogWithAuth: ({ dateStart, dateEnd, filter, page, perPage, sort, namespaces, }: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.GetGlobalExecutionLogParams", "text": "GetGlobalExecutionLogParams" }, ") => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.IExecutionLogResult", "text": "IExecutionLogResult" }, ">; getGlobalExecutionKpiWithAuth: ({ dateStart, dateEnd, filter, namespaces, }: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.GetGlobalExecutionKPIParams", "text": "GetGlobalExecutionKPIParams" }, ") => Promise<{ success: number; unknown: number; failure: number; warning: number; }>; }" ], "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": [ "(actionType: ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionType", "text": "ActionType" }, ") => 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" }, "" ], "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": [ "(connector: ", "SubActionConnectorType", ") => 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", "" ], "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": [ "() => ", "IServiceAbstract", "" ], "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": [ "() => ", "ICaseServiceAbstract", "" ], "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": [] }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.getActionsConfigurationUtilities", "type": "Function", "tags": [], "label": "getActionsConfigurationUtilities", "description": [], "signature": [ "() => ", "ActionsConfigurationUtilities" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.setEnabledConnectorTypes", "type": "Function", "tags": [], "label": "setEnabledConnectorTypes", "description": [], "signature": [ "(connectorTypes: string[]) => void" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.setEnabledConnectorTypes.$1", "type": "Array", "tags": [], "label": "connectorTypes", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.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.PluginSetupContract.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.PluginSetupContract.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.PluginSetupContract.isActionTypeEnabled.$2.notifyUsage", "type": "boolean", "tags": [], "label": "notifyUsage", "description": [], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "trackAdoption": false } ] } ], "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" }, ") => Promise<", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.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" }, "" ], "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" }, ") => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.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" }, "" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.inMemoryConnectors", "type": "Array", "tags": [], "label": "inMemoryConnectors", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.InMemoryConnector", "text": "InMemoryConnector" }, "<", "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": [ "(actionTypeId: string, actionId: string, params: Params, variables: Record) => 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" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isSystemActionConnector", "type": "Function", "tags": [], "label": "isSystemActionConnector", "description": [], "signature": [ "(connectorId: string) => boolean" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isSystemActionConnector.$1", "type": "string", "tags": [], "label": "connectorId", "description": [], "signature": [ "string" ], "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) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record; } | 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" ], "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.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 }, { "parentPluginId": "actions", "id": "def-common.ActionType.isSystemActionType", "type": "boolean", "tags": [], "label": "isSystemActionType", "description": [], "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" }, "" ], "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": [ "\"ok\" | \"error\"" ], "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 }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.errorSource", "type": "CompoundType", "tags": [], "label": "errorSource", "description": [], "signature": [ { "pluginId": "taskManager", "scope": "common", "docId": "kibTaskManagerPluginApi", "section": "def-common.TaskErrorSource", "text": "TaskErrorSource" }, " | undefined" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionKPIParams", "type": "Interface", "tags": [], "label": "GetGlobalExecutionKPIParams", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionKPIParams.dateStart", "type": "string", "tags": [], "label": "dateStart", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionKPIParams.dateEnd", "type": "string", "tags": [], "label": "dateEnd", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionKPIParams.filter", "type": "string", "tags": [], "label": "filter", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionKPIParams.namespaces", "type": "Array", "tags": [], "label": "namespaces", "description": [], "signature": [ "(string | undefined)[] | undefined" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams", "type": "Interface", "tags": [], "label": "GetGlobalExecutionLogParams", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams.dateStart", "type": "string", "tags": [], "label": "dateStart", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams.dateEnd", "type": "string", "tags": [], "label": "dateEnd", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams.filter", "type": "string", "tags": [], "label": "filter", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams.page", "type": "number", "tags": [], "label": "page", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams.perPage", "type": "number", "tags": [], "label": "perPage", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams.sort", "type": "CompoundType", "tags": [], "label": "sort", "description": [], "signature": [ "SortCombinations", " | ", "SortCombinations", "[]" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GetGlobalExecutionLogParams.namespaces", "type": "Array", "tags": [], "label": "namespaces", "description": [], "signature": [ "(string | undefined)[] | undefined" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog", "type": "Interface", "tags": [], "label": "IExecutionLog", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.IExecutionLog.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.timestamp", "type": "string", "tags": [], "label": "timestamp", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.duration_ms", "type": "number", "tags": [], "label": "duration_ms", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.status", "type": "string", "tags": [], "label": "status", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.message", "type": "string", "tags": [], "label": "message", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.version", "type": "string", "tags": [], "label": "version", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.schedule_delay_ms", "type": "number", "tags": [], "label": "schedule_delay_ms", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.space_ids", "type": "Array", "tags": [], "label": "space_ids", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.connector_name", "type": "string", "tags": [], "label": "connector_name", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.connector_id", "type": "string", "tags": [], "label": "connector_id", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.timed_out", "type": "boolean", "tags": [], "label": "timed_out", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLog.source", "type": "string", "tags": [], "label": "source", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLogResult", "type": "Interface", "tags": [], "label": "IExecutionLogResult", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.IExecutionLogResult.total", "type": "number", "tags": [], "label": "total", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionLogResult.data", "type": "Array", "tags": [], "label": "data", "description": [], "signature": [ { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.IExecutionLog", "text": "IExecutionLog" }, "[]" ], "path": "x-pack/plugins/actions/common/execution_log_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" }, " & { 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; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record; } | 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>>]: K extends \"frequency\" ? ", { "pluginId": "@kbn/actions-types", "scope": "common", "docId": "kibKbnActionsTypesPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, " : T[K]; }" ], "path": "packages/kbn-actions-types/rewrite_request_case_types.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.DEFAULT_MICROSOFT_EXCHANGE_URL", "type": "string", "tags": [], "label": "DEFAULT_MICROSOFT_EXCHANGE_URL", "description": [], "signature": [ "\"https://login.microsoftonline.com\"" ], "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.DEFAULT_MICROSOFT_GRAPH_API_SCOPE", "type": "string", "tags": [], "label": "DEFAULT_MICROSOFT_GRAPH_API_SCOPE", "description": [], "signature": [ "\"https://graph.microsoft.com/.default\"" ], "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.DEFAULT_MICROSOFT_GRAPH_API_URL", "type": "string", "tags": [], "label": "DEFAULT_MICROSOFT_GRAPH_API_URL", "description": [], "signature": [ "\"https://graph.microsoft.com/v1.0\"" ], "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ExecutionLogSortFields", "type": "Type", "tags": [], "label": "ExecutionLogSortFields", "description": [], "signature": [ "\"timestamp\" | \"execution_duration\" | \"schedule_delay\"" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForObservabilityConnectorFeatureId", "type": "string", "tags": [], "label": "GenerativeAIForObservabilityConnectorFeatureId", "description": [], "signature": [ "\"generativeAIForObservability\"" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSearchPlaygroundConnectorFeatureId", "type": "string", "tags": [], "label": "GenerativeAIForSearchPlaygroundConnectorFeatureId", "description": [], "signature": [ "\"generativeAIForSearchPlayground\"" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSecurityConnectorFeatureId", "type": "string", "tags": [], "label": "GenerativeAIForSecurityConnectorFeatureId", "description": [], "signature": [ "\"generativeAIForSecurity\"" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.IExecutionKPIResult", "type": "Type", "tags": [], "label": "IExecutionKPIResult", "description": [], "signature": [ "{ success: number; unknown: number; failure: number; warning: number; }" ], "path": "x-pack/plugins/actions/common/execution_log_types.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": "@kbn/actions-types", "scope": "common", "docId": "kibKbnActionsTypesPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, ") => T" ], "path": "packages/kbn-actions-types/rewrite_request_case_types.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>>]: K extends \"frequency\" ? ", { "pluginId": "@kbn/actions-types", "scope": "common", "docId": "kibKbnActionsTypesPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, " : T[K]; }" ], "path": "packages/kbn-actions-types/rewrite_request_case_types.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": "@kbn/actions-types", "scope": "common", "docId": "kibKbnActionsTypesPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, "[] : ", { "pluginId": "@kbn/actions-types", "scope": "common", "docId": "kibKbnActionsTypesPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, "" ], "path": "packages/kbn-actions-types/rewrite_request_case_types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "actions", "id": "def-common.RewriteResponseCase.$1", "type": "Uncategorized", "tags": [], "label": "responded", "description": [], "signature": [ "T" ], "path": "packages/kbn-actions-types/rewrite_request_case_types.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": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.AlertingConnectorFeature.compatibility", "type": "string", "tags": [], "label": "compatibility", "description": [], "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": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.CasesConnectorFeature.compatibility", "type": "string", "tags": [], "label": "compatibility", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.EMPTY_EXECUTION_KPI_RESULT", "type": "Object", "tags": [], "label": "EMPTY_EXECUTION_KPI_RESULT", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.EMPTY_EXECUTION_KPI_RESULT.success", "type": "number", "tags": [], "label": "success", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.EMPTY_EXECUTION_KPI_RESULT.unknown", "type": "number", "tags": [], "label": "unknown", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.EMPTY_EXECUTION_KPI_RESULT.failure", "type": "number", "tags": [], "label": "failure", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.EMPTY_EXECUTION_KPI_RESULT.warning", "type": "number", "tags": [], "label": "warning", "description": [], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.executionLogSortableColumns", "type": "Object", "tags": [], "label": "executionLogSortableColumns", "description": [], "signature": [ "readonly [\"timestamp\", \"execution_duration\", \"schedule_delay\"]" ], "path": "x-pack/plugins/actions/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForObservabilityFeature", "type": "Object", "tags": [], "label": "GenerativeAIForObservabilityFeature", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.GenerativeAIForObservabilityFeature.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.GenerativeAIForObservabilityFeature.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForObservabilityFeature.compatibility", "type": "string", "tags": [], "label": "compatibility", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSearchPlaygroundFeature", "type": "Object", "tags": [], "label": "GenerativeAIForSearchPlaygroundFeature", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSearchPlaygroundFeature.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.GenerativeAIForSearchPlaygroundFeature.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSearchPlaygroundFeature.compatibility", "type": "string", "tags": [], "label": "compatibility", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSecurityFeature", "type": "Object", "tags": [], "label": "GenerativeAIForSecurityFeature", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSecurityFeature.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.GenerativeAIForSecurityFeature.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.GenerativeAIForSecurityFeature.compatibility", "type": "string", "tags": [], "label": "compatibility", "description": [], "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": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.SecuritySolutionFeature.compatibility", "type": "string", "tags": [], "label": "compatibility", "description": [], "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": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "actions", "id": "def-common.UptimeConnectorFeature.compatibility", "type": "string", "tags": [], "label": "compatibility", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ] } }