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

3027 lines
No EOL
109 KiB
JSON
Raw Blame History

{
"id": "@kbn/response-ops-rule-form",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.createRule",
"type": "Function",
"tags": [],
"label": "createRule",
"description": [],
"signature": [
"({\n http,\n rule,\n}: { http: ",
"HttpSetup",
"; rule: ",
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.CreateRuleBody",
"text": "CreateRuleBody"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">; }) => Promise<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">>"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.createRule.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n rule,\n}",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/create_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.createRule.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/create_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.createRule.$1.rule",
"type": "Object",
"tags": [],
"label": "rule",
"description": [],
"signature": [
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.CreateRuleBody",
"text": "CreateRuleBody"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/create_rule.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.fetchUiConfig",
"type": "Function",
"tags": [],
"label": "fetchUiConfig",
"description": [],
"signature": [
"({ http }: { http: ",
"HttpSetup",
"; }) => Promise<",
"UiConfig",
">"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/fetch_ui_config/fetch_ui_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.fetchUiConfig.$1",
"type": "Object",
"tags": [],
"label": "{ http }",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/fetch_ui_config/fetch_ui_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.fetchUiConfig.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/fetch_ui_config/fetch_ui_config.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.resolveRule",
"type": "Function",
"tags": [],
"label": "resolveRule",
"description": [],
"signature": [
"({\n http,\n id,\n}: { http: ",
"HttpSetup",
"; id: string; }) => Promise<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ResolvedRule",
"text": "ResolvedRule"
},
">"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/resolve_rule/resolve_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.resolveRule.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n id,\n}",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/resolve_rule/resolve_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.resolveRule.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/resolve_rule/resolve_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.resolveRule.$1.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/resolve_rule/resolve_rule.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleActionsAlertsFilter",
"type": "Function",
"tags": [],
"label": "RuleActionsAlertsFilter",
"description": [],
"signature": [
"({ action, onChange, appName, ruleTypeId, plugins: propsPlugins, }: ",
"RuleActionsAlertsFilterProps",
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_actions/rule_actions_alerts_filter.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleActionsAlertsFilter.$1",
"type": "Object",
"tags": [],
"label": "{\n action,\n onChange,\n appName,\n ruleTypeId,\n plugins: propsPlugins,\n}",
"description": [],
"signature": [
"RuleActionsAlertsFilterProps"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_actions/rule_actions_alerts_filter.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleActionsAlertsFilterTimeframe",
"type": "Function",
"tags": [],
"label": "RuleActionsAlertsFilterTimeframe",
"description": [],
"signature": [
"({ action, settings, onChange, }: ",
"RuleActionsAlertsFilterTimeframeProps",
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_actions/rule_actions_alerts_filter_timeframe.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleActionsAlertsFilterTimeframe.$1",
"type": "Object",
"tags": [],
"label": "{\n action,\n settings,\n onChange,\n}",
"description": [],
"signature": [
"RuleActionsAlertsFilterTimeframeProps"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_actions/rule_actions_alerts_filter_timeframe.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleActionsNotifyWhen",
"type": "Function",
"tags": [],
"label": "RuleActionsNotifyWhen",
"description": [],
"signature": [
"({ hasAlertsMappings, frequency, throttle, throttleUnit, showMinimumThrottleWarning, showMinimumThrottleUnitWarning, notifyWhenSelectOptions, onChange, onUseDefaultMessage, }: ",
"RuleActionsNotifyWhenProps",
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_actions/rule_actions_notify_when.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleActionsNotifyWhen.$1",
"type": "Object",
"tags": [],
"label": "{\n hasAlertsMappings,\n frequency = DEFAULT_FREQUENCY,\n throttle,\n throttleUnit,\n showMinimumThrottleWarning,\n showMinimumThrottleUnitWarning,\n notifyWhenSelectOptions = NOTIFY_WHEN_OPTIONS,\n onChange,\n onUseDefaultMessage,\n}",
"description": [],
"signature": [
"RuleActionsNotifyWhenProps"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_actions/rule_actions_notify_when.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleForm",
"type": "Function",
"tags": [],
"label": "RuleForm",
"description": [],
"signature": [
"(props: ",
"RuleFormProps",
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleForm.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RuleFormProps"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_form.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModalComponent",
"type": "Function",
"tags": [],
"label": "RuleTypeModalComponent",
"description": [],
"signature": [
"({ http, toasts, filteredRuleTypes, registeredRuleTypes, ...rest }: ",
"RuleTypeModalComponentProps",
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_type_modal/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModalComponent.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n toasts,\n filteredRuleTypes = EMPTY_ARRAY,\n registeredRuleTypes,\n ...rest\n}",
"description": [],
"signature": [
"RuleTypeModalComponentProps"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/rule_type_modal/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.transformCreateRuleBody",
"type": "Function",
"tags": [],
"label": "transformCreateRuleBody",
"description": [],
"signature": [
"({ ruleTypeId, actions, alertDelay, flapping, ...res }: ",
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.CreateRuleBody",
"text": "CreateRuleBody"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => any"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/transform_create_rule_body.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.transformCreateRuleBody.$1",
"type": "Object",
"tags": [],
"label": "{\n ruleTypeId,\n actions = [],\n alertDelay,\n flapping,\n ...res\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.CreateRuleBody",
"text": "CreateRuleBody"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/transform_create_rule_body.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.transformUpdateRuleBody",
"type": "Function",
"tags": [],
"label": "transformUpdateRuleBody",
"description": [],
"signature": [
"({ actions, alertDelay, flapping, ...res }: ",
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => any"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/transform_update_rule_body.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.transformUpdateRuleBody.$1",
"type": "Object",
"tags": [],
"label": "{\n actions = [],\n alertDelay,\n flapping,\n ...res\n}",
"description": [],
"signature": [
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/transform_update_rule_body.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.updateRule",
"type": "Function",
"tags": [],
"label": "updateRule",
"description": [],
"signature": [
"({\n http,\n rule,\n id,\n}: { http: ",
"HttpSetup",
"; rule: ",
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">; id: string; }) => Promise<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">>"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.updateRule.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n rule,\n id,\n}",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.updateRule.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/update_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.updateRule.$1.rule",
"type": "Object",
"tags": [],
"label": "rule",
"description": [],
"signature": [
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/update_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.updateRule.$1.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/update_rule.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody",
"type": "Interface",
"tags": [],
"label": "CreateRuleBody",
"description": [],
"signature": [
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.CreateRuleBody",
"text": "CreateRuleBody"
},
"<Params>"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.consumer",
"type": "string",
"tags": [],
"label": "consumer",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.params",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"Params"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.schedule",
"type": "Object",
"tags": [],
"label": "schedule",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
}
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.actions",
"type": "Array",
"tags": [],
"label": "actions",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.throttle",
"type": "CompoundType",
"tags": [],
"label": "throttle",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.notifyWhen",
"type": "CompoundType",
"tags": [],
"label": "notifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.alertDelay",
"type": "CompoundType",
"tags": [],
"label": "alertDelay",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.AlertDelay",
"text": "AlertDelay"
},
" | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CreateRuleBody.flapping",
"type": "CompoundType",
"tags": [],
"label": "flapping",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.Flapping",
"text": "Flapping"
},
" | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/create_rule/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.MinimumScheduleInterval",
"type": "Interface",
"tags": [],
"label": "MinimumScheduleInterval",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.MinimumScheduleInterval.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.MinimumScheduleInterval.enforce",
"type": "boolean",
"tags": [],
"label": "enforce",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormActionsErrors",
"type": "Interface",
"tags": [],
"label": "RuleFormActionsErrors",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormActionsErrors.filterQuery",
"type": "Array",
"tags": [],
"label": "filterQuery",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors",
"type": "Interface",
"tags": [],
"label": "RuleFormBaseErrors",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors.name",
"type": "Array",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors.interval",
"type": "Array",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors.consumer",
"type": "Array",
"tags": [],
"label": "consumer",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors.ruleTypeId",
"type": "Array",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors.actionConnectors",
"type": "Array",
"tags": [],
"label": "actionConnectors",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors.alertDelay",
"type": "Array",
"tags": [],
"label": "alertDelay",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormBaseErrors.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData",
"type": "Interface",
"tags": [],
"label": "RuleFormData",
"description": [],
"signature": [
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.RuleFormData",
"text": "RuleFormData"
},
"<Params>"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.params",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"Params"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.schedule",
"type": "Object",
"tags": [],
"label": "schedule",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.IntervalSchedule",
"text": "IntervalSchedule"
}
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.consumer",
"type": "string",
"tags": [],
"label": "consumer",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.actions",
"type": "Array",
"tags": [],
"label": "actions",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.alertDelay",
"type": "CompoundType",
"tags": [],
"label": "alertDelay",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.AlertDelay",
"text": "AlertDelay"
},
" | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.notifyWhen",
"type": "CompoundType",
"tags": [],
"label": "notifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.throttle",
"type": "CompoundType",
"tags": [],
"label": "throttle",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.ruleTypeId",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormData.flapping",
"type": "CompoundType",
"tags": [],
"label": "flapping",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.Flapping",
"text": "Flapping"
},
" | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormParamsErrors",
"type": "Interface",
"tags": [],
"label": "RuleFormParamsErrors",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormParamsErrors.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: string | string[] | RuleFormParamsErrors",
"description": [],
"signature": [
"[key: string]: string | string[] | ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormParamsErrors",
"text": "RuleFormParamsErrors"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins",
"type": "Interface",
"tags": [],
"label": "RuleFormPlugins",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.i18n",
"type": "Object",
"tags": [],
"label": "i18n",
"description": [],
"signature": [
"I18nStart"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.theme",
"type": "Object",
"tags": [],
"label": "theme",
"description": [],
"signature": [
"ThemeServiceSetup"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.userProfile",
"type": "Object",
"tags": [],
"label": "userProfile",
"description": [],
"signature": [
"UserProfileService"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.application",
"type": "Object",
"tags": [],
"label": "application",
"description": [],
"signature": [
"ApplicationStart"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.notifications",
"type": "Object",
"tags": [],
"label": "notifications",
"description": [],
"signature": [
"NotificationsStart"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.charts",
"type": "Object",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
}
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
"SettingsStart"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.unifiedSearch",
"type": "Object",
"tags": [],
"label": "unifiedSearch",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
}
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.docLinks",
"type": "Object",
"tags": [],
"label": "docLinks",
"description": [],
"signature": [
"DocLinksStart"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">; list: () => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">[]; register: (objectType: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void; has: (id: string) => boolean; }"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormPlugins.actionTypeRegistry",
"type": "Object",
"tags": [],
"label": "actionTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>; list: () => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>[]; register: (objectType: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionTypeModel",
"text": "ActionTypeModel"
},
"<unknown, unknown, any>) => void; has: (id: string) => boolean; }"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState",
"type": "Interface",
"tags": [],
"label": "RuleFormState",
"description": [],
"signature": [
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.RuleFormState",
"text": "RuleFormState"
},
"<Params>"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.formData",
"type": "Object",
"tags": [],
"label": "formData",
"description": [],
"signature": [
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.RuleFormData",
"text": "RuleFormData"
},
"<Params>"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.plugins",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
{
"pluginId": "@kbn/response-ops-rule-form",
"scope": "public",
"docId": "kibKbnResponseOpsRuleFormPluginApi",
"section": "def-public.RuleFormPlugins",
"text": "RuleFormPlugins"
}
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.connectors",
"type": "Array",
"tags": [],
"label": "connectors",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ActionConnector",
"text": "ActionConnector"
},
"<Record<string, unknown>, Record<string, unknown>>[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.connectorTypes",
"type": "Array",
"tags": [],
"label": "connectorTypes",
"description": [],
"signature": [
{
"pluginId": "@kbn/actions-types",
"scope": "common",
"docId": "kibKbnActionsTypesPluginApi",
"section": "def-common.ActionType",
"text": "ActionType"
},
"[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.aadTemplateFields",
"type": "Array",
"tags": [],
"label": "aadTemplateFields",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionVariable",
"text": "ActionVariable"
},
"[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.availableRuleTypes",
"type": "Array",
"tags": [],
"label": "availableRuleTypes",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeWithDescription",
"text": "RuleTypeWithDescription"
},
"[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.baseErrors",
"type": "Object",
"tags": [],
"label": "baseErrors",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormBaseErrors",
"text": "RuleFormBaseErrors"
},
" | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.paramsErrors",
"type": "Object",
"tags": [],
"label": "paramsErrors",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormParamsErrors",
"text": "RuleFormParamsErrors"
},
" | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.actionsErrors",
"type": "Object",
"tags": [],
"label": "actionsErrors",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormActionsErrors",
"text": "RuleFormActionsErrors"
},
"> | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.actionsParamsErrors",
"type": "Object",
"tags": [],
"label": "actionsParamsErrors",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormParamsErrors",
"text": "RuleFormParamsErrors"
},
"> | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.selectedRuleType",
"type": "CompoundType",
"tags": [],
"label": "selectedRuleType",
"description": [],
"signature": [
{
"pluginId": "@kbn/triggers-actions-ui-types",
"scope": "common",
"docId": "kibKbnTriggersActionsUiTypesPluginApi",
"section": "def-common.RuleType",
"text": "RuleType"
},
"<string, string> & { description?: string | undefined; }"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.selectedRuleTypeModel",
"type": "Object",
"tags": [],
"label": "selectedRuleTypeModel",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<Params>"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.multiConsumerSelection",
"type": "CompoundType",
"tags": [],
"label": "multiConsumerSelection",
"description": [],
"signature": [
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.RuleCreationValidConsumer",
"text": "RuleCreationValidConsumer"
},
" | null | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.showMustacheAutocompleteSwitch",
"type": "CompoundType",
"tags": [],
"label": "showMustacheAutocompleteSwitch",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"Record<string, unknown> | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.minimumScheduleInterval",
"type": "Object",
"tags": [],
"label": "minimumScheduleInterval",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.MinimumScheduleInterval",
"text": "MinimumScheduleInterval"
},
" | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.canShowConsumerSelection",
"type": "CompoundType",
"tags": [],
"label": "canShowConsumerSelection",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.validConsumers",
"type": "Array",
"tags": [],
"label": "validConsumers",
"description": [],
"signature": [
{
"pluginId": "@kbn/rule-data-utils",
"scope": "common",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-common.RuleCreationValidConsumer",
"text": "RuleCreationValidConsumer"
},
"[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.flappingSettings",
"type": "CompoundType",
"tags": [],
"label": "flappingSettings",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RulesSettingsFlapping",
"text": "RulesSettingsFlapping"
},
" | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleFormState.touched",
"type": "CompoundType",
"tags": [],
"label": "touched",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel",
"type": "Interface",
"tags": [],
"label": "RuleTypeModel",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<Params>"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.iconClass",
"type": "string",
"tags": [],
"label": "iconClass",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.documentationUrl",
"type": "CompoundType",
"tags": [],
"label": "documentationUrl",
"description": [],
"signature": [
"string | ((docLinks: ",
"DocLinksStart",
") => string) | null"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"(ruleParams: Params, isServerless?: boolean | undefined) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.ValidationResult",
"text": "ValidationResult"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.validate.$1",
"type": "Uncategorized",
"tags": [],
"label": "ruleParams",
"description": [],
"signature": [
"Params"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.validate.$2",
"type": "CompoundType",
"tags": [],
"label": "isServerless",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.ruleParamsExpression",
"type": "Function",
"tags": [],
"label": "ruleParamsExpression",
"description": [],
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParamsExpressionProps",
"text": "RuleTypeParamsExpressionProps"
},
"<Params, Record<string, unknown>, string>>>"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.ruleParamsExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.requiresAppContext",
"type": "boolean",
"tags": [],
"label": "requiresAppContext",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.defaultActionMessage",
"type": "string",
"tags": [],
"label": "defaultActionMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.defaultRecoveryMessage",
"type": "string",
"tags": [],
"label": "defaultRecoveryMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.defaultSummaryMessage",
"type": "string",
"tags": [],
"label": "defaultSummaryMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeModel.alertDetailsAppSection",
"type": "CompoundType",
"tags": [],
"label": "alertDetailsAppSection",
"description": [],
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<any>> | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps",
"type": "Interface",
"tags": [],
"label": "RuleTypeParamsExpressionProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParamsExpressionProps",
"text": "RuleTypeParamsExpressionProps"
},
"<Params, MetaData, ActionGroupIds>"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.ruleParams",
"type": "Uncategorized",
"tags": [],
"label": "ruleParams",
"description": [],
"signature": [
"Params"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.ruleInterval",
"type": "string",
"tags": [],
"label": "ruleInterval",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.ruleThrottle",
"type": "string",
"tags": [],
"label": "ruleThrottle",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.alertNotifyWhen",
"type": "CompoundType",
"tags": [],
"label": "alertNotifyWhen",
"description": [],
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams",
"type": "Function",
"tags": [],
"label": "setRuleParams",
"description": [],
"signature": [
"<Key extends keyof Params>(property: Key, value: Params[Key] | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams.$1",
"type": "Uncategorized",
"tags": [],
"label": "property",
"description": [],
"signature": [
"Key"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleParams.$2",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"Params[Key] | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty",
"type": "Function",
"tags": [],
"label": "setRuleProperty",
"description": [],
"signature": [
"<Prop extends \"params\" | \"id\" | \"consumer\" | \"name\" | \"monitoring\" | \"tags\" | \"actions\" | \"enabled\" | \"schedule\" | \"mapped_params\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"apiKeyCreatedByUser\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\" | \"snoozeSchedule\" | \"activeSnoozes\" | \"isSnoozedUntil\" | \"lastRun\" | \"nextRun\" | \"revision\" | \"running\" | \"viewInAppRelativeUrl\" | \"alertDelay\" | \"flapping\" | \"ruleTypeId\">(key: Prop, value: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>[Prop] | null) => void"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty.$1",
"type": "Uncategorized",
"tags": [],
"label": "key",
"description": [],
"signature": [
"Prop"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.setRuleProperty.$2",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>[Prop] | null"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.onChangeMetaData",
"type": "Function",
"tags": [],
"label": "onChangeMetaData",
"description": [],
"signature": [
"(metadata: MetaData) => void"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.onChangeMetaData.$1",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"MetaData"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleFormParamsErrors",
"text": "RuleFormParamsErrors"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.defaultActionGroupId",
"type": "string",
"tags": [],
"label": "defaultActionGroupId",
"description": [],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.actionGroups",
"type": "Array",
"tags": [],
"label": "actionGroups",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ActionGroup",
"text": "ActionGroup"
},
"<ActionGroupIds>[]"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.metadata",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"MetaData | undefined"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.charts",
"type": "Object",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParamsExpressionProps.unifiedSearch",
"type": "Object",
"tags": [],
"label": "unifiedSearch",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.ValidationResult",
"type": "Interface",
"tags": [],
"label": "ValidationResult",
"description": [],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.ValidationResult.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.CREATE_RULE_ROUTE",
"type": "string",
"tags": [],
"label": "CREATE_RULE_ROUTE",
"description": [],
"signature": [
"\"/rule/create/:ruleTypeId\""
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.EDIT_RULE_ROUTE",
"type": "string",
"tags": [],
"label": "EDIT_RULE_ROUTE",
"description": [],
"signature": [
"\"/rule/edit/:id\""
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.InitialRule",
"type": "Type",
"tags": [],
"label": "InitialRule",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">> & Pick<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.Rule",
"text": "Rule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">, \"params\" | \"consumer\" | \"tags\" | \"actions\" | \"schedule\">"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.ResolvedRule",
"type": "Type",
"tags": [],
"label": "ResolvedRule",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.ResolvedSanitizedRule",
"text": "ResolvedSanitizedRule"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">, \"actions\" | \"alertTypeId\" | \"systemActions\"> & { ruleTypeId: string; actions: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.Rule",
"type": "Type",
"tags": [],
"label": "Rule",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>, \"actions\" | \"alertTypeId\" | \"systemActions\"> & { ruleTypeId: string; actions: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeIndexWithDescriptions",
"type": "Type",
"tags": [],
"label": "RuleTypeIndexWithDescriptions",
"description": [],
"signature": [
"Map<string, ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeWithDescription",
"text": "RuleTypeWithDescription"
},
">"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeParams",
"type": "Type",
"tags": [],
"label": "RuleTypeParams",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeRegistryContract",
"type": "Type",
"tags": [],
"label": "RuleTypeRegistryContract",
"description": [],
"signature": [
"{ get: (id: string) => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">; list: () => ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">[]; register: (objectType: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeModel",
"text": "RuleTypeModel"
},
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">) => void; has: (id: string) => boolean; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleTypeWithDescription",
"type": "Type",
"tags": [],
"label": "RuleTypeWithDescription",
"description": [],
"signature": [
{
"pluginId": "@kbn/triggers-actions-ui-types",
"scope": "common",
"docId": "kibKbnTriggersActionsUiTypesPluginApi",
"section": "def-common.RuleType",
"text": "RuleType"
},
"<string, string> & { description?: string | undefined; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.RuleUiAction",
"type": "Type",
"tags": [],
"label": "RuleUiAction",
"description": [],
"signature": [
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedRuleAction",
"text": "SanitizedRuleAction"
},
" | ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleSystemAction",
"text": "RuleSystemAction"
}
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.SanitizedRule",
"type": "Type",
"tags": [],
"label": "SanitizedRule",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>, \"actions\" | \"alertTypeId\" | \"systemActions\"> & { ruleTypeId: string; actions: ",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleUiAction",
"text": "RuleUiAction"
},
"[]; }"
],
"path": "src/platform/packages/shared/kbn-alerts-ui-shared/src/common/types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.SanitizedRuleAction",
"type": "Type",
"tags": [],
"label": "SanitizedRuleAction",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.RuleAction",
"text": "RuleAction"
},
", \"alertsFilter\"> & { alertsFilter?: ",
{
"pluginId": "@kbn/alerting-types",
"scope": "common",
"docId": "kibKbnAlertingTypesPluginApi",
"section": "def-common.SanitizedAlertsFilter",
"text": "SanitizedAlertsFilter"
},
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-alerting-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/response-ops-rule-form",
"id": "def-public.UPDATE_FIELDS_WITH_ACTIONS",
"type": "Array",
"tags": [],
"label": "UPDATE_FIELDS_WITH_ACTIONS",
"description": [],
"signature": [
"(keyof ",
"UpdateRuleBody",
"<",
{
"pluginId": "@kbn/alerts-ui-shared",
"scope": "public",
"docId": "kibKbnAlertsUiSharedPluginApi",
"section": "def-public.RuleTypeParams",
"text": "RuleTypeParams"
},
">)[]"
],
"path": "src/platform/packages/shared/response-ops/rule_form/src/common/apis/update_rule/update_rule.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink