github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/stack_alerts.devdocs.json

501 lines
No EOL
16 KiB
JSON
Raw Permalink 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, }: ",
"DataViewSelectPopoverProps",
") => React.JSX.Element"
],
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/components/data_view_select_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-public.DataViewSelectPopover.$1",
"type": "Object",
"tags": [],
"label": "{\n dependencies: { dataViews, dataViewEditor },\n metadata = { adHocDataViewList: [], isManagementPage: true },\n dataView,\n onSelectDataView,\n onChangeMetaData,\n}",
"description": [],
"signature": [
"DataViewSelectPopoverProps"
],
"path": "x-pack/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/stack_alerts/common/comparator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.getEsqlQueryHits",
"type": "Function",
"tags": [],
"label": "getEsqlQueryHits",
"description": [],
"signature": [
"(table: ",
{
"pluginId": "stackAlerts",
"scope": "common",
"docId": "kibStackAlertsPluginApi",
"section": "def-common.EsqlTable",
"text": "EsqlTable"
},
", query: string, isGroupAgg: boolean) => EsqlQueryHits"
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.getEsqlQueryHits.$1",
"type": "Object",
"tags": [],
"label": "table",
"description": [],
"signature": [
{
"pluginId": "stackAlerts",
"scope": "common",
"docId": "kibStackAlertsPluginApi",
"section": "def-common.EsqlTable",
"text": "EsqlTable"
}
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.getEsqlQueryHits.$2",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.getEsqlQueryHits.$3",
"type": "boolean",
"tags": [],
"label": "isGroupAgg",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/stack_alerts/common/es_query/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/platform/plugins/shared/stack_alerts/common/es_query/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/platform/plugins/shared/stack_alerts/common/es_query/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": [
"(datatable: ",
{
"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/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.transformDatatableToEsqlTable.$1",
"type": "Object",
"tags": [],
"label": "datatable",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/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/platform/plugins/shared/stack_alerts/common/es_query/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/platform/plugins/shared/stack_alerts/common/es_query/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/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "stackAlerts",
"id": "def-common.ALERT_ID_COLUMN",
"type": "string",
"tags": [],
"label": "ALERT_ID_COLUMN",
"description": [],
"signature": [
"\"Alert ID\""
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.ALERT_ID_SUGGESTED_MAX",
"type": "number",
"tags": [],
"label": "ALERT_ID_SUGGESTED_MAX",
"description": [],
"signature": [
"10"
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.ES_QUERY_MAX_HITS_PER_EXECUTION",
"type": "number",
"tags": [],
"label": "ES_QUERY_MAX_HITS_PER_EXECUTION",
"description": [],
"signature": [
"10000"
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "stackAlerts",
"id": "def-common.ES_QUERY_MAX_HITS_PER_EXECUTION_SERVERLESS",
"type": "number",
"tags": [],
"label": "ES_QUERY_MAX_HITS_PER_EXECUTION_SERVERLESS",
"description": [],
"signature": [
"100"
],
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink