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/stack_alerts.devdocs.json

449 lines
No EOL
13 KiB
JSON
Raw Blame History

{
"id": "stackAlerts",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "stackAlerts",
"id": "def-public.DataViewSelectPopover",
"type": "Function",
"tags": [],
"label": "DataViewSelectPopover",
"description": [],
"signature": [
"({ dependencies: { dataViews, dataViewEditor }, metadata, dataView, onSelectDataView, onChangeMetaData, }: React.PropsWithChildren<",
"DataViewSelectPopoverProps",
">) => JSX.Element | null"
],
"path": "x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-public.DataViewSelectPopover.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n dependencies: { dataViews, dataViewEditor },\n metadata = { adHocDataViewList: [], isManagementPage: true },\n dataView,\n onSelectDataView,\n onChangeMetaData,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
"DataViewSelectPopoverProps",
">"
],
"path": "x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "stackAlerts",
"id": "def-server.Config",
"type": "Type",
"tags": [],
"label": "Config",
"description": [],
"signature": [
"{}"
],
"path": "x-pack/plugins/stack_alerts/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-server.ID",
"type": "string",
"tags": [],
"label": "ID",
"description": [],
"signature": [
"\".index-threshold\""
],
"path": "x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "stackAlerts",
"id": "def-server.configSchema",
"type": "Object",
"tags": [],
"label": "configSchema",
"description": [],
"signature": [
{
"pluginId": "@kbn/config-schema",
"scope": "common",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-common.ObjectType",
"text": "ObjectType"
},
"<{}>"
],
"path": "x-pack/plugins/stack_alerts/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.getComparatorScript",
"type": "Function",
"tags": [],
"label": "getComparatorScript",
"description": [],
"signature": [
"(comparator: ",
"Comparator",
", threshold: number[], fieldName: string) => string"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.getComparatorScript.$1",
"type": "Enum",
"tags": [],
"label": "comparator",
"description": [],
"signature": [
"Comparator"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.getComparatorScript.$2",
"type": "Array",
"tags": [],
"label": "threshold",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.getComparatorScript.$3",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.getHumanReadableComparator",
"type": "Function",
"tags": [],
"label": "getHumanReadableComparator",
"description": [],
"signature": [
"(comparator: ",
"Comparator",
") => string | undefined"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.getHumanReadableComparator.$1",
"type": "Enum",
"tags": [],
"label": "comparator",
"description": [],
"signature": [
"Comparator"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.rowToDocument",
"type": "Function",
"tags": [],
"label": "rowToDocument",
"description": [],
"signature": [
"(columns: EsqlResultColumn[], row: EsqlResultRow) => EsqlDocument"
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.rowToDocument.$1",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"EsqlResultColumn[]"
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.rowToDocument.$2",
"type": "Array",
"tags": [],
"label": "row",
"description": [],
"signature": [
"EsqlResultRow"
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.toEsQueryHits",
"type": "Function",
"tags": [],
"label": "toEsQueryHits",
"description": [],
"signature": [
"(results: ",
{
"pluginId": "stackAlerts",
"scope": "common",
"docId": "kibStackAlertsPluginApi",
"section": "def-common.EsqlTable",
"text": "EsqlTable"
},
") => { hits: EsqlHit[]; total: number; }"
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.toEsQueryHits.$1",
"type": "Object",
"tags": [],
"label": "results",
"description": [],
"signature": [
{
"pluginId": "stackAlerts",
"scope": "common",
"docId": "kibStackAlertsPluginApi",
"section": "def-common.EsqlTable",
"text": "EsqlTable"
}
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.transformDatatableToEsqlTable",
"type": "Function",
"tags": [],
"label": "transformDatatableToEsqlTable",
"description": [],
"signature": [
"(results: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
") => ",
{
"pluginId": "stackAlerts",
"scope": "common",
"docId": "kibStackAlertsPluginApi",
"section": "def-common.EsqlTable",
"text": "EsqlTable"
}
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.transformDatatableToEsqlTable.$1",
"type": "Object",
"tags": [],
"label": "results",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.EsqlTable",
"type": "Interface",
"tags": [],
"label": "EsqlTable",
"description": [],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.EsqlTable.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"EsqlResultColumn[]"
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.EsqlTable.values",
"type": "Array",
"tags": [],
"label": "values",
"description": [],
"signature": [
"EsqlResultRow[]"
],
"path": "x-pack/plugins/stack_alerts/common/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.ComparatorFnNames",
"type": "Object",
"tags": [],
"label": "ComparatorFnNames",
"description": [],
"signature": [
"Set<",
"Comparator",
">"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.ComparatorFns",
"type": "Object",
"tags": [],
"label": "ComparatorFns",
"description": [],
"signature": [
"Map<",
"Comparator",
", ",
"ComparatorFn",
">"
],
"path": "x-pack/plugins/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink