kibana/api_docs/kbn_ml_ui_actions.devdocs.json

{
  "id": "@kbn/ml-ui-actions",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "@kbn/ml-ui-actions",
        "id": "def-common.CategorizeFieldContext",
        "type": "Interface",
        "tags": [],
        "label": "CategorizeFieldContext",
        "description": [],
        "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CategorizeFieldContext.field",
            "type": "Object",
            "tags": [],
            "label": "field",
            "description": [],
            "signature": [
              {
                "pluginId": "dataViews",
                "scope": "common",
                "docId": "kibDataViewsPluginApi",
                "section": "def-common.DataViewField",
                "text": "DataViewField"
              }
            ],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CategorizeFieldContext.dataView",
            "type": "Object",
            "tags": [],
            "label": "dataView",
            "description": [],
            "signature": [
              {
                "pluginId": "dataViews",
                "scope": "common",
                "docId": "kibDataViewsPluginApi",
                "section": "def-common.DataView",
                "text": "DataView"
              }
            ],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CategorizeFieldContext.originatingApp",
            "type": "string",
            "tags": [],
            "label": "originatingApp",
            "description": [],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CategorizeFieldContext.additionalFilter",
            "type": "Object",
            "tags": [],
            "label": "additionalFilter",
            "description": [],
            "signature": [
              "{ from: number; to: number; field?: { name: string; value: string; } | undefined; } | undefined"
            ],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-ui-actions",
        "id": "def-common.CreateCategorizationADJobContext",
        "type": "Interface",
        "tags": [],
        "label": "CreateCategorizationADJobContext",
        "description": [],
        "path": "x-pack/platform/packages/private/ml/ui_actions/src/ml/ui_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CreateCategorizationADJobContext.field",
            "type": "Object",
            "tags": [],
            "label": "field",
            "description": [],
            "signature": [
              {
                "pluginId": "dataViews",
                "scope": "common",
                "docId": "kibDataViewsPluginApi",
                "section": "def-common.DataViewField",
                "text": "DataViewField"
              }
            ],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/ml/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CreateCategorizationADJobContext.dataView",
            "type": "Object",
            "tags": [],
            "label": "dataView",
            "description": [],
            "signature": [
              {
                "pluginId": "dataViews",
                "scope": "common",
                "docId": "kibDataViewsPluginApi",
                "section": "def-common.DataView",
                "text": "DataView"
              }
            ],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/ml/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CreateCategorizationADJobContext.query",
            "type": "Object",
            "tags": [],
            "label": "query",
            "description": [],
            "signature": [
              "QueryDslQueryContainer"
            ],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/ml/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.CreateCategorizationADJobContext.timeRange",
            "type": "Object",
            "tags": [],
            "label": "timeRange",
            "description": [],
            "signature": [
              "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
            ],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/ml/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/ml-ui-actions",
        "id": "def-common.ACTION_CATEGORIZE_FIELD",
        "type": "string",
        "tags": [],
        "label": "ACTION_CATEGORIZE_FIELD",
        "description": [],
        "signature": [
          "\"ACTION_CATEGORIZE_FIELD\""
        ],
        "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-ui-actions",
        "id": "def-common.CATEGORIZE_FIELD_TRIGGER",
        "type": "string",
        "tags": [],
        "label": "CATEGORIZE_FIELD_TRIGGER",
        "description": [],
        "signature": [
          "\"CATEGORIZE_FIELD_TRIGGER\""
        ],
        "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-ui-actions",
        "id": "def-common.CREATE_PATTERN_ANALYSIS_TO_ML_AD_JOB_ACTION",
        "type": "string",
        "tags": [],
        "label": "CREATE_PATTERN_ANALYSIS_TO_ML_AD_JOB_ACTION",
        "description": [],
        "signature": [
          "\"createMLADCategorizationJobAction\""
        ],
        "path": "x-pack/platform/packages/private/ml/ui_actions/src/ml/ui_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-ui-actions",
        "id": "def-common.CREATE_PATTERN_ANALYSIS_TO_ML_AD_JOB_TRIGGER",
        "type": "string",
        "tags": [],
        "label": "CREATE_PATTERN_ANALYSIS_TO_ML_AD_JOB_TRIGGER",
        "description": [],
        "signature": [
          "\"CREATE_PATTERN_ANALYSIS_TO_ML_AD_JOB_TRIGGER\""
        ],
        "path": "x-pack/platform/packages/private/ml/ui_actions/src/ml/ui_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/ml-ui-actions",
        "id": "def-common.categorizeFieldTrigger",
        "type": "Object",
        "tags": [],
        "label": "categorizeFieldTrigger",
        "description": [],
        "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.categorizeFieldTrigger.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.categorizeFieldTrigger.title",
            "type": "string",
            "tags": [],
            "label": "title",
            "description": [],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-ui-actions",
            "id": "def-common.categorizeFieldTrigger.description",
            "type": "string",
            "tags": [],
            "label": "description",
            "description": [],
            "path": "x-pack/platform/packages/private/ml/ui_actions/src/aiops/ui_actions.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}