kibana/api_docs/kbn_alerting_rule_utils.devdocs.json

{
  "id": "@kbn/alerting-rule-utils",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/alerting-rule-utils",
        "id": "def-common.getEcsGroups",
        "type": "Function",
        "tags": [],
        "label": "getEcsGroups",
        "description": [],
        "signature": [
          "(groups?: ",
          {
            "pluginId": "@kbn/alerting-rule-utils",
            "scope": "common",
            "docId": "kibKbnAlertingRuleUtilsPluginApi",
            "section": "def-common.Group",
            "text": "Group"
          },
          "[]) => Record<string, string>"
        ],
        "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/get_ecs_groups.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.getEcsGroups.$1",
            "type": "Array",
            "tags": [],
            "label": "groups",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/alerting-rule-utils",
                "scope": "common",
                "docId": "kibKbnAlertingRuleUtilsPluginApi",
                "section": "def-common.Group",
                "text": "Group"
              },
              "[]"
            ],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/get_ecs_groups.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/alerting-rule-utils",
        "id": "def-common.getFormattedGroupBy",
        "type": "Function",
        "tags": [],
        "label": "getFormattedGroupBy",
        "description": [],
        "signature": [
          "(groupBy: string | string[] | undefined, groupSet: Set<string>) => Record<string, ",
          {
            "pluginId": "@kbn/alerting-rule-utils",
            "scope": "common",
            "docId": "kibKbnAlertingRuleUtilsPluginApi",
            "section": "def-common.Group",
            "text": "Group"
          },
          "[]>"
        ],
        "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.getFormattedGroupBy.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "groupBy",
            "description": [],
            "signature": [
              "string | string[] | undefined"
            ],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          },
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.getFormattedGroupBy.$2",
            "type": "Object",
            "tags": [],
            "label": "groupSet",
            "description": [],
            "signature": [
              "Set<string>"
            ],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/alerting-rule-utils",
        "id": "def-common.getGroupByObject",
        "type": "Function",
        "tags": [],
        "label": "getGroupByObject",
        "description": [],
        "signature": [
          "(groupBy: string | string[] | undefined, groupValueSet: Set<string>) => Record<string, unknown>"
        ],
        "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.getGroupByObject.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "groupBy",
            "description": [],
            "signature": [
              "string | string[] | undefined"
            ],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          },
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.getGroupByObject.$2",
            "type": "Object",
            "tags": [],
            "label": "groupValueSet",
            "description": [],
            "signature": [
              "Set<string>"
            ],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/alerting-rule-utils",
        "id": "def-common.FieldsObject",
        "type": "Interface",
        "tags": [],
        "label": "FieldsObject",
        "description": [],
        "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.FieldsObject.Unnamed",
            "type": "IndexSignature",
            "tags": [],
            "label": "[x: string]: any",
            "description": [],
            "signature": [
              "[x: string]:  any"
            ],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/alerting-rule-utils",
        "id": "def-common.Group",
        "type": "Interface",
        "tags": [],
        "label": "Group",
        "description": [],
        "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.Group.field",
            "type": "string",
            "tags": [],
            "label": "field",
            "description": [],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/alerting-rule-utils",
            "id": "def-common.Group.value",
            "type": "string",
            "tags": [],
            "label": "value",
            "description": [],
            "path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}