maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/ml.json
Stacey Gammon 8aa370ba3b
Improve security plugin return types (#101492) 
* Add explicit security types

* Remove sessionTimeout, seems unused

* add comments

* Add comments and fix test since removing the unused APIs

* remove unused import

* wording cleanup

* Export some types that are part of the public API but not exported

* more improvements for api docs

* update security docs

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* remove unneccessary readonly prefix

* Update all api docs

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
2021-06-08 14:05:14 -04:00

4610 lines
141 KiB
JSON
Raw Blame History

{
"id": "ml",
"client": {
"classes": [
{
"parentPluginId": "ml",
"id": "def-public.MlUrlGenerator",
"type": "Class",
"tags": [],
"label": "MlUrlGenerator",
"description": [],
"signature": [
{
"pluginId": "ml",
"scope": "public",
"docId": "kibMlPluginApi",
"section": "def-public.MlUrlGenerator",
"text": "MlUrlGenerator"
},
" implements ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.UrlGeneratorsDefinition",
"text": "UrlGeneratorsDefinition"
},
"<\"ML_APP_URL_GENERATOR\">"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/ml_url_generator.ts",
"lineNumber": 44
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.MlUrlGenerator.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/ml_url_generator.ts",
"lineNumber": 45
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.MlUrlGenerator.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"Params"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/ml_url_generator.ts",
"lineNumber": 45
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "ml",
"id": "def-public.MlUrlGenerator.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"ML_APP_URL_GENERATOR\""
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/ml_url_generator.ts",
"lineNumber": 47
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlUrlGenerator.createUrl",
"type": "Function",
"tags": [],
"label": "createUrl",
"description": [],
"signature": [
"(mlUrlGeneratorParams: ",
"MlUrlGeneratorState",
") => Promise<string>"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/ml_url_generator.ts",
"lineNumber": 49
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.MlUrlGenerator.createUrl.$1",
"type": "CompoundType",
"tags": [],
"label": "mlUrlGeneratorParams",
"description": [],
"signature": [
"MlUrlGeneratorState"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/ml_url_generator.ts",
"lineNumber": 50
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "ml",
"id": "def-public.getFormattedSeverityScore",
"type": "Function",
"tags": [],
"label": "getFormattedSeverityScore",
"description": [
"\nReturn formatted severity score."
],
"signature": [
"(score: number) => string"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 124
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.getFormattedSeverityScore.$1",
"type": "number",
"tags": [],
"label": "score",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 124
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.getMlSharedImports",
"type": "Function",
"tags": [],
"label": "getMlSharedImports",
"description": [],
"signature": [
"() => Promise<typeof ",
"x-pack/plugins/ml/public/shared",
">"
],
"source": {
"path": "x-pack/plugins/ml/public/index.ts",
"lineNumber": 61
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.getSeverity",
"type": "Function",
"tags": [],
"label": "getSeverity",
"description": [],
"signature": [
"(normalizedScore: number) => ",
"SeverityType"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 130
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.getSeverity.$1",
"type": "number",
"tags": [],
"label": "normalizedScore",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 130
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.getSeverityColor",
"type": "Function",
"tags": [],
"label": "getSeverityColor",
"description": [],
"signature": [
"(normalizedScore: number) => string"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 185
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.getSeverityColor.$1",
"type": "number",
"tags": [],
"label": "normalizedScore",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 185
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.getSeverityType",
"type": "Function",
"tags": [],
"label": "getSeverityType",
"description": [],
"signature": [
"(normalizedScore: number) => ",
{
"pluginId": "ml",
"scope": "common",
"docId": "kibMlPluginApi",
"section": "def-common.ANOMALY_SEVERITY",
"text": "ANOMALY_SEVERITY"
}
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 146
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.getSeverityType.$1",
"type": "number",
"tags": [],
"label": "normalizedScore",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 146
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.useMlHref",
"type": "Function",
"tags": [],
"label": "useMlHref",
"description": [
"\nProvides a URL to ML plugin page\nTODO remove basePath parameter"
],
"signature": [
"(ml: { urlGenerator: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.UrlGeneratorContract",
"text": "UrlGeneratorContract"
},
"<\"ML_APP_URL_GENERATOR\"> | undefined; } | undefined, basePath: string | undefined, params: ",
"MlUrlGeneratorState",
") => string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/use_ml_href.ts",
"lineNumber": 16
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.useMlHref.$1",
"type": "Object",
"tags": [],
"label": "ml",
"description": [],
"signature": [
"{ urlGenerator: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.UrlGeneratorContract",
"text": "UrlGeneratorContract"
},
"<\"ML_APP_URL_GENERATOR\"> | undefined; } | undefined"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/use_ml_href.ts",
"lineNumber": 17
},
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "ml",
"id": "def-public.useMlHref.$2",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/use_ml_href.ts",
"lineNumber": 18
},
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "ml",
"id": "def-public.useMlHref.$3",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"MlUrlGeneratorState"
],
"source": {
"path": "x-pack/plugins/ml/public/ml_url_generator/use_ml_href.ts",
"lineNumber": 19
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord",
"type": "Interface",
"tags": [],
"label": "AnomaliesTableRecord",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 43
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.time",
"type": "number",
"tags": [],
"label": "time",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.source",
"type": "Object",
"tags": [],
"label": "source",
"description": [],
"signature": [
"AnomalyRecordDoc"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 45
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.rowId",
"type": "string",
"tags": [],
"label": "rowId",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 46
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.jobId",
"type": "string",
"tags": [],
"label": "jobId",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 47
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.detectorIndex",
"type": "number",
"tags": [],
"label": "detectorIndex",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 48
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.severity",
"type": "number",
"tags": [],
"label": "severity",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 49
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.entityName",
"type": "string",
"tags": [],
"label": "entityName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 50
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.entityValue",
"type": "Any",
"tags": [],
"label": "entityValue",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 51
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.influencers",
"type": "Array",
"tags": [],
"label": "influencers",
"description": [],
"signature": [
"{ [key: string]: any; }[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 52
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.actual",
"type": "Array",
"tags": [],
"label": "actual",
"description": [],
"signature": [
"number[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 53
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.actualSort",
"type": "Any",
"tags": [],
"label": "actualSort",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 54
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.typical",
"type": "Array",
"tags": [],
"label": "typical",
"description": [],
"signature": [
"number[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 55
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.typicalSort",
"type": "Any",
"tags": [],
"label": "typicalSort",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 56
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomaliesTableRecord.metricDescriptionSort",
"type": "number",
"tags": [],
"label": "metricDescriptionSort",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 57
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.DataRecognizerConfigResponse",
"type": "Interface",
"tags": [],
"label": "DataRecognizerConfigResponse",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/modules.ts",
"lineNumber": 93
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.DataRecognizerConfigResponse.datafeeds",
"type": "Array",
"tags": [],
"label": "datafeeds",
"description": [],
"signature": [
"DatafeedResponse",
"[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/modules.ts",
"lineNumber": 94
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.DataRecognizerConfigResponse.jobs",
"type": "Array",
"tags": [],
"label": "jobs",
"description": [],
"signature": [
"JobResponse",
"[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/modules.ts",
"lineNumber": 95
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.DataRecognizerConfigResponse.kibana",
"type": "Object",
"tags": [],
"label": "kibana",
"description": [],
"signature": [
"{ search: ",
"KibanaObjectResponse",
"[]; visualization: ",
"KibanaObjectResponse",
"[]; dashboard: ",
"KibanaObjectResponse",
"[]; }"
],
"source": {
"path": "x-pack/plugins/ml/common/types/modules.ts",
"lineNumber": 96
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.Influencer",
"type": "Interface",
"tags": [],
"label": "Influencer",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 10
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.Influencer.influencer_field_name",
"type": "string",
"tags": [],
"label": "influencer_field_name",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 11
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.Influencer.influencer_field_values",
"type": "Array",
"tags": [],
"label": "influencer_field_values",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 12
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.JobExistResult",
"type": "Interface",
"tags": [],
"label": "JobExistResult",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.JobExistResult.jobsExist",
"type": "boolean",
"tags": [],
"label": "jobsExist",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.JobExistResult.jobs",
"type": "Array",
"tags": [],
"label": "jobs",
"description": [],
"signature": [
"JobStat",
"[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 17
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.JobStat",
"type": "Interface",
"tags": [],
"label": "JobStat",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.JobStat.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 9
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.JobStat.earliestTimestampMs",
"type": "number",
"tags": [],
"label": "earliestTimestampMs",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 10
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.JobStat.latestTimestampMs",
"type": "number",
"tags": [],
"label": "latestTimestampMs",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 11
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.JobStat.latestResultsTimestampMs",
"type": "number",
"tags": [],
"label": "latestResultsTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/data_recognizer.ts",
"lineNumber": 12
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlCapabilitiesResponse",
"type": "Interface",
"tags": [],
"label": "MlCapabilitiesResponse",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 161
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.MlCapabilitiesResponse.capabilities",
"type": "CompoundType",
"tags": [],
"label": "capabilities",
"description": [],
"signature": [
"{ canAccessML: boolean; canGetJobs: boolean; canGetDatafeeds: boolean; canGetCalendars: boolean; canFindFileStructure: boolean; canGetDataFrameAnalytics: boolean; canGetAnnotations: boolean; canCreateAnnotation: boolean; canDeleteAnnotation: boolean; canUseMlAlerts: boolean; } & { canCreateJob: boolean; canDeleteJob: boolean; canOpenJob: boolean; canCloseJob: boolean; canUpdateJob: boolean; canForecastJob: boolean; canCreateDatafeed: boolean; canDeleteDatafeed: boolean; canStartStopDatafeed: boolean; canUpdateDatafeed: boolean; canPreviewDatafeed: boolean; canGetFilters: boolean; canCreateCalendar: boolean; canDeleteCalendar: boolean; canCreateFilter: boolean; canDeleteFilter: boolean; canCreateDataFrameAnalytics: boolean; canDeleteDataFrameAnalytics: boolean; canStartStopDataFrameAnalytics: boolean; canCreateMlAlerts: boolean; canUseMlAlerts: boolean; }"
],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 162
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlCapabilitiesResponse.upgradeInProgress",
"type": "boolean",
"tags": [],
"label": "upgradeInProgress",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 163
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlCapabilitiesResponse.isPlatinumOrTrialLicense",
"type": "boolean",
"tags": [],
"label": "isPlatinumOrTrialLicense",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 164
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlCapabilitiesResponse.mlFeatureEnabledInSpace",
"type": "boolean",
"tags": [],
"label": "mlFeatureEnabledInSpace",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 165
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob",
"type": "Interface",
"tags": [],
"label": "MlSummaryJob",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.groups",
"type": "Array",
"tags": [],
"label": "groups",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 18
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.processed_record_count",
"type": "number",
"tags": [],
"label": "processed_record_count",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.memory_status",
"type": "string",
"tags": [],
"label": "memory_status",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.jobState",
"type": "string",
"tags": [],
"label": "jobState",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 21
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.datafeedIndices",
"type": "Array",
"tags": [],
"label": "datafeedIndices",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.hasDatafeed",
"type": "boolean",
"tags": [],
"label": "hasDatafeed",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 23
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.datafeedId",
"type": "string",
"tags": [],
"label": "datafeedId",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.datafeedState",
"type": "string",
"tags": [],
"label": "datafeedState",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.latestTimestampMs",
"type": "number",
"tags": [],
"label": "latestTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.earliestTimestampMs",
"type": "number",
"tags": [],
"label": "earliestTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.latestResultsTimestampMs",
"type": "number",
"tags": [],
"label": "latestResultsTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.fullJob",
"type": "Object",
"tags": [],
"label": "fullJob",
"description": [],
"signature": [
"CombinedJob",
" | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 29
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.nodeName",
"type": "string",
"tags": [],
"label": "nodeName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.auditMessage",
"type": "Object",
"tags": [],
"label": "auditMessage",
"description": [],
"signature": [
"Partial<",
"AuditMessage",
"> | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.isSingleMetricViewerJob",
"type": "boolean",
"tags": [],
"label": "isSingleMetricViewerJob",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.isNotSingleMetricViewerJobMessage",
"type": "string",
"tags": [],
"label": "isNotSingleMetricViewerJobMessage",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.deleting",
"type": "CompoundType",
"tags": [],
"label": "deleting",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.latestTimestampSortValue",
"type": "number",
"tags": [],
"label": "latestTimestampSortValue",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.earliestStartTimestampMs",
"type": "number",
"tags": [],
"label": "earliestStartTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 36
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.awaitingNodeAssignment",
"type": "boolean",
"tags": [],
"label": "awaitingNodeAssignment",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 37
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-public.MlSummaryJob.alertingRules",
"type": "Array",
"tags": [],
"label": "alertingRules",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
"<",
"MlAnomalyDetectionAlertParams",
">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 38
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.UseIndexDataReturnType",
"type": "Interface",
"tags": [],
"label": "UseIndexDataReturnType",
"description": [],
"signature": [
{
"pluginId": "ml",
"scope": "public",
"docId": "kibMlPluginApi",
"section": "def-public.UseIndexDataReturnType",
"text": "UseIndexDataReturnType"
},
" extends Pick<",
"UseDataGridReturnType",
", \"status\" | \"errorMessage\" | \"baseline\" | \"chartsVisible\" | \"chartsButtonVisible\" | \"ccsWarning\" | \"columnsWithCharts\" | \"invalidSortingColumnns\" | \"noDataMessage\" | \"onChangeItemsPerPage\" | \"onChangePage\" | \"onSort\" | \"pagination\" | \"setPagination\" | \"setVisibleColumns\" | \"rowCount\" | \"rowCountRelation\" | \"sortingColumns\" | \"tableItems\" | \"toggleChartVisibility\" | \"visibleColumns\" | \"predictionFieldName\" | \"resultsField\">"
],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 57
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-public.UseIndexDataReturnType.renderCellValue",
"type": "Function",
"tags": [],
"label": "renderCellValue",
"description": [],
"signature": [
"({ rowIndex, columnId, setCellProps, }: { rowIndex: number; columnId: string; setCellProps: (props: ",
"CommonProps",
" & React.HTMLAttributes<HTMLDivElement>) => void; }) => any"
],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 84
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "ml",
"id": "def-public.__0",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ rowIndex: number; columnId: string; setCellProps: (props: ",
"CommonProps",
" & React.HTMLAttributes<HTMLDivElement>) => void; }"
],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 43
},
"deprecated": false
}
]
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "ml",
"id": "def-public.ANOMALY_SEVERITY",
"type": "Enum",
"tags": [],
"label": "ANOMALY_SEVERITY",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "ml",
"id": "def-public.ANOMALY_SWIMLANE_EMBEDDABLE_TYPE",
"type": "string",
"tags": [],
"label": "ANOMALY_SWIMLANE_EMBEDDABLE_TYPE",
"description": [],
"signature": [
"\"ml_anomaly_swimlane\""
],
"source": {
"path": "x-pack/plugins/ml/public/embeddables/constants.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.AnomalySwimlaneEmbeddableInput",
"type": "Type",
"tags": [],
"label": "AnomalySwimlaneEmbeddableInput",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
" & ",
"AnomalySwimlaneEmbeddableCustomInput"
],
"source": {
"path": "x-pack/plugins/ml/public/embeddables/types.ts",
"lineNumber": 49
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.CONTROLLED_BY_SWIM_LANE_FILTER",
"type": "string",
"tags": [],
"label": "CONTROLLED_BY_SWIM_LANE_FILTER",
"description": [],
"signature": [
"\"anomaly-swim-lane\""
],
"source": {
"path": "x-pack/plugins/ml/public/ui_actions/constants.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.EsSorting",
"type": "Type",
"tags": [],
"label": "EsSorting",
"description": [],
"signature": [
"Dictionary",
"<{ order: \"asc\" | \"desc\"; }>"
],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 53
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.GetMlSharedImportsReturnType",
"type": "Type",
"tags": [],
"label": "GetMlSharedImportsReturnType",
"description": [],
"signature": [
"typeof ",
"x-pack/plugins/ml/public/shared"
],
"source": {
"path": "x-pack/plugins/ml/public/index.ts",
"lineNumber": 66
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.RenderCellValue",
"type": "Type",
"tags": [],
"label": "RenderCellValue",
"description": [],
"signature": [
"({ rowIndex, columnId, setCellProps, }: { rowIndex: number; columnId: string; setCellProps: (props: ",
"CommonProps",
" & React.HTMLAttributes<HTMLDivElement>) => void; }) => any"
],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 43
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "ml",
"id": "def-public.ES_CLIENT_TOTAL_HITS_RELATION",
"type": "Object",
"tags": [],
"label": "ES_CLIENT_TOTAL_HITS_RELATION",
"description": [],
"signature": [
"{ GTE: ",
"SearchTotalHitsRelation",
"; EQ: ",
"SearchTotalHitsRelation",
"; }"
],
"source": {
"path": "x-pack/plugins/ml/common/types/es_client.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-public.ML_PAGES",
"type": "Object",
"tags": [],
"label": "ML_PAGES",
"description": [],
"signature": [
"{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly DATA_FRAME_ANALYTICS_MODELS_MANAGE: \"data_frame_analytics/models\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly ACCESS_DENIED: \"access-denied\"; readonly OVERVIEW: \"overview\"; }"
],
"source": {
"path": "x-pack/plugins/ml/common/constants/ml_url_generator.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
}
],
"start": {
"parentPluginId": "ml",
"id": "def-public.MlPluginStart",
"type": "Type",
"tags": [],
"label": "MlPluginStart",
"description": [],
"signature": [
"{ urlGenerator: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.UrlGeneratorContract",
"text": "UrlGeneratorContract"
},
"<\"ML_APP_URL_GENERATOR\"> | undefined; }"
],
"source": {
"path": "x-pack/plugins/ml/public/plugin.ts",
"lineNumber": 212
},
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "ml",
"id": "def-server.InsufficientMLCapabilities",
"type": "Class",
"tags": [],
"label": "InsufficientMLCapabilities",
"description": [],
"signature": [
{
"pluginId": "ml",
"scope": "server",
"docId": "kibMlPluginApi",
"section": "def-server.InsufficientMLCapabilities",
"text": "InsufficientMLCapabilities"
},
" extends Error"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 17
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.InsufficientMLCapabilities.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 18
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.InsufficientMLCapabilities.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 18
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.MLPrivilegesUninitialized",
"type": "Class",
"tags": [],
"label": "MLPrivilegesUninitialized",
"description": [],
"signature": [
{
"pluginId": "ml",
"scope": "server",
"docId": "kibMlPluginApi",
"section": "def-server.MLPrivilegesUninitialized",
"text": "MLPrivilegesUninitialized"
},
" extends Error"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.MLPrivilegesUninitialized.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.MLPrivilegesUninitialized.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 25
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.UnknownMLCapabilitiesError",
"type": "Class",
"tags": [],
"label": "UnknownMLCapabilitiesError",
"description": [],
"signature": [
{
"pluginId": "ml",
"scope": "server",
"docId": "kibMlPluginApi",
"section": "def-server.UnknownMLCapabilitiesError",
"text": "UnknownMLCapabilitiesError"
},
" extends Error"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 10
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.UnknownMLCapabilitiesError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.UnknownMLCapabilitiesError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts",
"lineNumber": 11
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "ml",
"id": "def-server.getHistogramsForFields",
"type": "Function",
"tags": [],
"label": "getHistogramsForFields",
"description": [],
"signature": [
"(client: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.IScopedClusterClient",
"text": "IScopedClusterClient"
},
", indexPatternTitle: string, query: any, fields: ",
"HistogramField",
"[], samplerShardSize: number, runtimeMappings?: Record<string, ",
"MappingRuntimeField",
"> | undefined) => Promise<ChartData[]>"
],
"source": {
"path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts",
"lineNumber": 240
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.getHistogramsForFields.$1",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.IScopedClusterClient",
"text": "IScopedClusterClient"
}
],
"source": {
"path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts",
"lineNumber": 241
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "ml",
"id": "def-server.getHistogramsForFields.$2",
"type": "string",
"tags": [],
"label": "indexPatternTitle",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts",
"lineNumber": 242
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "ml",
"id": "def-server.getHistogramsForFields.$3",
"type": "Any",
"tags": [],
"label": "query",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts",
"lineNumber": 243
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "ml",
"id": "def-server.getHistogramsForFields.$4",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"HistogramField",
"[]"
],
"source": {
"path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts",
"lineNumber": 244
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "ml",
"id": "def-server.getHistogramsForFields.$5",
"type": "number",
"tags": [],
"label": "samplerShardSize",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts",
"lineNumber": 245
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "ml",
"id": "def-server.getHistogramsForFields.$6",
"type": "Object",
"tags": [],
"label": "runtimeMappings",
"description": [],
"signature": [
"Record<string, ",
"MappingRuntimeField",
"> | undefined"
],
"source": {
"path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts",
"lineNumber": 246
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.isCombinedJobWithStats",
"type": "Function",
"tags": [],
"label": "isCombinedJobWithStats",
"description": [],
"signature": [
"(arg: any) => boolean"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.isCombinedJobWithStats.$1",
"type": "Any",
"tags": [],
"label": "arg",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 29
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord",
"type": "Interface",
"tags": [],
"label": "AnomaliesTableRecord",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 43
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.time",
"type": "number",
"tags": [],
"label": "time",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.source",
"type": "Object",
"tags": [],
"label": "source",
"description": [],
"signature": [
"AnomalyRecordDoc"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 45
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.rowId",
"type": "string",
"tags": [],
"label": "rowId",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 46
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.jobId",
"type": "string",
"tags": [],
"label": "jobId",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 47
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.detectorIndex",
"type": "number",
"tags": [],
"label": "detectorIndex",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 48
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.severity",
"type": "number",
"tags": [],
"label": "severity",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 49
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.entityName",
"type": "string",
"tags": [],
"label": "entityName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 50
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.entityValue",
"type": "Any",
"tags": [],
"label": "entityValue",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 51
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.influencers",
"type": "Array",
"tags": [],
"label": "influencers",
"description": [],
"signature": [
"{ [key: string]: any; }[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 52
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.actual",
"type": "Array",
"tags": [],
"label": "actual",
"description": [],
"signature": [
"number[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 53
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.actualSort",
"type": "Any",
"tags": [],
"label": "actualSort",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 54
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.typical",
"type": "Array",
"tags": [],
"label": "typical",
"description": [],
"signature": [
"number[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 55
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.typicalSort",
"type": "Any",
"tags": [],
"label": "typicalSort",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 56
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomaliesTableRecord.metricDescriptionSort",
"type": "number",
"tags": [],
"label": "metricDescriptionSort",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 57
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc",
"type": "Interface",
"tags": [],
"label": "AnomalyCategorizerStatsDoc",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 62
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 63
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.job_id",
"type": "string",
"tags": [],
"label": "job_id",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 64
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.result_type",
"type": "string",
"tags": [],
"label": "result_type",
"description": [],
"signature": [
"\"categorizer_stats\""
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 65
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.partition_field_name",
"type": "string",
"tags": [],
"label": "partition_field_name",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 66
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.partition_field_value",
"type": "string",
"tags": [],
"label": "partition_field_value",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 67
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.categorized_doc_count",
"type": "number",
"tags": [],
"label": "categorized_doc_count",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 68
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.total_category_count",
"type": "number",
"tags": [],
"label": "total_category_count",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 69
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.frequent_category_count",
"type": "number",
"tags": [],
"label": "frequent_category_count",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 70
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.rare_category_count",
"type": "number",
"tags": [],
"label": "rare_category_count",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 71
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.dead_category_count",
"type": "number",
"tags": [],
"label": "dead_category_count",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 72
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.failed_category_count",
"type": "number",
"tags": [],
"label": "failed_category_count",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 73
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.categorization_status",
"type": "CompoundType",
"tags": [],
"label": "categorization_status",
"description": [],
"signature": [
"\"ok\" | \"warn\""
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 74
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.log_time",
"type": "number",
"tags": [],
"label": "log_time",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 75
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyCategorizerStatsDoc.timestamp",
"type": "number",
"tags": [],
"label": "timestamp",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 76
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc",
"type": "Interface",
"tags": [],
"label": "AnomalyRecordDoc",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.job_id",
"type": "string",
"tags": [],
"label": "job_id",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.result_type",
"type": "string",
"tags": [],
"label": "result_type",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 18
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.probability",
"type": "number",
"tags": [],
"label": "probability",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.record_score",
"type": "number",
"tags": [],
"label": "record_score",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.initial_record_score",
"type": "number",
"tags": [],
"label": "initial_record_score",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 21
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.bucket_span",
"type": "number",
"tags": [],
"label": "bucket_span",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.detector_index",
"type": "number",
"tags": [],
"label": "detector_index",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 23
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.is_interim",
"type": "boolean",
"tags": [],
"label": "is_interim",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.timestamp",
"type": "number",
"tags": [],
"label": "timestamp",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.partition_field_name",
"type": "string",
"tags": [],
"label": "partition_field_name",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.partition_field_value",
"type": "CompoundType",
"tags": [],
"label": "partition_field_value",
"description": [],
"signature": [
"string | number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.function",
"type": "string",
"tags": [],
"label": "function",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.function_description",
"type": "string",
"tags": [],
"label": "function_description",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 29
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.typical",
"type": "Array",
"tags": [],
"label": "typical",
"description": [],
"signature": [
"number[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.actual",
"type": "Array",
"tags": [],
"label": "actual",
"description": [],
"signature": [
"number[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.influencers",
"type": "Array",
"tags": [],
"label": "influencers",
"description": [],
"signature": [
"Influencer",
"[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.by_field_name",
"type": "string",
"tags": [],
"label": "by_field_name",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.field_name",
"type": "string",
"tags": [],
"label": "field_name",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.by_field_value",
"type": "string",
"tags": [],
"label": "by_field_value",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.multi_bucket_impact",
"type": "number",
"tags": [],
"label": "multi_bucket_impact",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 36
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.over_field_name",
"type": "string",
"tags": [],
"label": "over_field_name",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 37
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.over_field_value",
"type": "string",
"tags": [],
"label": "over_field_value",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 38
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyRecordDoc.causes",
"type": "Array",
"tags": [],
"label": "causes",
"description": [],
"signature": [
"any[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 40
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.AuditMessage",
"type": "Interface",
"tags": [],
"label": "AuditMessage",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 41
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.AuditMessage.job_id",
"type": "string",
"tags": [],
"label": "job_id",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 42
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AuditMessage.msgTime",
"type": "number",
"tags": [],
"label": "msgTime",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 43
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AuditMessage.level",
"type": "string",
"tags": [],
"label": "level",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AuditMessage.highestLevel",
"type": "string",
"tags": [],
"label": "highestLevel",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 45
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AuditMessage.highestLevelText",
"type": "string",
"tags": [],
"label": "highestLevelText",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 46
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.AuditMessage.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 47
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.CombinedJob",
"type": "Interface",
"tags": [],
"label": "CombinedJob",
"description": [],
"signature": [
"CombinedJob",
" extends ",
"MlJob"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.CombinedJob.calendars",
"type": "Array",
"tags": [],
"label": "calendars",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.CombinedJob.datafeed_config",
"type": "Object",
"tags": [],
"label": "datafeed_config",
"description": [],
"signature": [
"MlDatafeed"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 21
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.CombinedJobWithStats",
"type": "Interface",
"tags": [],
"label": "CombinedJobWithStats",
"description": [],
"signature": [
"CombinedJobWithStats",
" extends ",
"JobWithStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.CombinedJobWithStats.calendars",
"type": "Array",
"tags": [],
"label": "calendars",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.CombinedJobWithStats.datafeed_config",
"type": "CompoundType",
"tags": [],
"label": "datafeed_config",
"description": [],
"signature": [
"MlDatafeed",
" & ",
"MlDatafeedStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 26
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.Influencer",
"type": "Interface",
"tags": [],
"label": "Influencer",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 10
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.Influencer.influencer_field_name",
"type": "string",
"tags": [],
"label": "influencer_field_name",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 11
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.Influencer.influencer_field_values",
"type": "Array",
"tags": [],
"label": "influencer_field_values",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 12
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlJobWithTimeRange",
"type": "Interface",
"tags": [],
"label": "MlJobWithTimeRange",
"description": [],
"signature": [
"MlJobWithTimeRange",
" extends ",
"CombinedJobWithStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 52
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.MlJobWithTimeRange.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 53
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlJobWithTimeRange.isRunning",
"type": "CompoundType",
"tags": [],
"label": "isRunning",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 54
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlJobWithTimeRange.isNotSingleMetricViewerJobMessage",
"type": "string",
"tags": [],
"label": "isNotSingleMetricViewerJobMessage",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 55
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlJobWithTimeRange.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
"{ from: number; to: number; fromPx: number; toPx: number; fromMoment: moment.Moment; toMoment: moment.Moment; widthPx: number; label: string; }"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 56
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob",
"type": "Interface",
"tags": [],
"label": "MlSummaryJob",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.groups",
"type": "Array",
"tags": [],
"label": "groups",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 18
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.processed_record_count",
"type": "number",
"tags": [],
"label": "processed_record_count",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.memory_status",
"type": "string",
"tags": [],
"label": "memory_status",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.jobState",
"type": "string",
"tags": [],
"label": "jobState",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 21
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.datafeedIndices",
"type": "Array",
"tags": [],
"label": "datafeedIndices",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.hasDatafeed",
"type": "boolean",
"tags": [],
"label": "hasDatafeed",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 23
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.datafeedId",
"type": "string",
"tags": [],
"label": "datafeedId",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.datafeedState",
"type": "string",
"tags": [],
"label": "datafeedState",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.latestTimestampMs",
"type": "number",
"tags": [],
"label": "latestTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.earliestTimestampMs",
"type": "number",
"tags": [],
"label": "earliestTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.latestResultsTimestampMs",
"type": "number",
"tags": [],
"label": "latestResultsTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.fullJob",
"type": "Object",
"tags": [],
"label": "fullJob",
"description": [],
"signature": [
"CombinedJob",
" | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 29
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.nodeName",
"type": "string",
"tags": [],
"label": "nodeName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.auditMessage",
"type": "Object",
"tags": [],
"label": "auditMessage",
"description": [],
"signature": [
"Partial<",
"AuditMessage",
"> | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.isSingleMetricViewerJob",
"type": "boolean",
"tags": [],
"label": "isSingleMetricViewerJob",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.isNotSingleMetricViewerJobMessage",
"type": "string",
"tags": [],
"label": "isNotSingleMetricViewerJobMessage",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.deleting",
"type": "CompoundType",
"tags": [],
"label": "deleting",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.latestTimestampSortValue",
"type": "number",
"tags": [],
"label": "latestTimestampSortValue",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.earliestStartTimestampMs",
"type": "number",
"tags": [],
"label": "earliestStartTimestampMs",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 36
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.awaitingNodeAssignment",
"type": "boolean",
"tags": [],
"label": "awaitingNodeAssignment",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 37
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJob.alertingRules",
"type": "Array",
"tags": [],
"label": "alertingRules",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.Alert",
"text": "Alert"
},
"<",
"MlAnomalyDetectionAlertParams",
">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 38
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.PerPartitionCategorization",
"type": "Interface",
"tags": [],
"label": "PerPartitionCategorization",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-server.PerPartitionCategorization.enabled",
"type": "CompoundType",
"tags": [],
"label": "enabled",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-server.PerPartitionCategorization.stop_on_warn",
"type": "CompoundType",
"tags": [],
"label": "stop_on_warn",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 29
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "ml",
"id": "def-server.Aggregation",
"type": "Type",
"tags": [],
"label": "Aggregation",
"description": [],
"signature": [
"{ [x: string]: ",
"AggregationsAggregationContainer",
"; }"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnalysisConfig",
"type": "Type",
"tags": [],
"label": "AnalysisConfig",
"description": [],
"signature": [
"MlAnalysisConfig"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 15
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnalysisLimits",
"type": "Type",
"tags": [],
"label": "AnalysisLimits",
"description": [],
"signature": [
"MlAnalysisLimits"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 19
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.AnomalyResultType",
"type": "Type",
"tags": [],
"label": "AnomalyResultType",
"description": [],
"signature": [
"\"record\" | \"bucket\" | \"influencer\""
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 81
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.BucketSpan",
"type": "Type",
"tags": [],
"label": "BucketSpan",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.ChunkingConfig",
"type": "Type",
"tags": [],
"label": "ChunkingConfig",
"description": [],
"signature": [
"MlChunkingConfig"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 14
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.CustomRule",
"type": "Type",
"tags": [],
"label": "CustomRule",
"description": [],
"signature": [
"MlDetectionRule"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 25
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.CustomSettings",
"type": "Type",
"tags": [],
"label": "CustomSettings",
"description": [],
"signature": [
"MlCustomSettings"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 32
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.DataCounts",
"type": "Type",
"tags": [],
"label": "DataCounts",
"description": [],
"signature": [
"MlDataCounts"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.DataDescription",
"type": "Type",
"tags": [],
"label": "DataDescription",
"description": [],
"signature": [
"MlDataDescription"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 21
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.Datafeed",
"type": "Type",
"tags": [],
"label": "Datafeed",
"description": [],
"signature": [
"MlDatafeed"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.DatafeedId",
"type": "Type",
"tags": [],
"label": "DatafeedId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.DatafeedStats",
"type": "Type",
"tags": [],
"label": "DatafeedStats",
"description": [],
"signature": [
"MlDatafeedStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.DatafeedWithStats",
"type": "Type",
"tags": [],
"label": "DatafeedWithStats",
"description": [],
"signature": [
"MlDatafeed",
" & ",
"MlDatafeedStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 15
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.Detector",
"type": "Type",
"tags": [],
"label": "Detector",
"description": [],
"signature": [
"MlDetector"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.EntityFieldType",
"type": "Type",
"tags": [],
"label": "EntityFieldType",
"description": [],
"signature": [
"\"partition_field\" | \"over_field\" | \"by_field\""
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 79
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.ForecastsStats",
"type": "Type",
"tags": [],
"label": "ForecastsStats",
"description": [],
"signature": [
"MlJobForecastStatistics"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
"lineNumber": 18
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.IndicesOptions",
"type": "Type",
"tags": [],
"label": "IndicesOptions",
"description": [],
"signature": [
"MlDatafeedIndicesOptions"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 18
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.Job",
"type": "Type",
"tags": [],
"label": "Job",
"description": [],
"signature": [
"MlJob"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 13
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.JobId",
"type": "Type",
"tags": [],
"label": "JobId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.JobStats",
"type": "Type",
"tags": [],
"label": "JobStats",
"description": [],
"signature": [
"MlJobStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.JobWithStats",
"type": "Type",
"tags": [],
"label": "JobWithStats",
"description": [],
"signature": [
"MlJob",
" & ",
"MlJobStats",
" & ",
"JobAlertingRuleStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts",
"lineNumber": 14
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.MlSummaryJobs",
"type": "Type",
"tags": [],
"label": "MlSummaryJobs",
"description": [],
"signature": [
"MlSummaryJob",
"[]"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts",
"lineNumber": 50
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.ModelPlotConfig",
"type": "Type",
"tags": [],
"label": "ModelPlotConfig",
"description": [],
"signature": [
"MlModelPlotConfig"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts",
"lineNumber": 23
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.ModelSizeStats",
"type": "Type",
"tags": [],
"label": "ModelSizeStats",
"description": [],
"signature": [
"MlModelSizeStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
"lineNumber": 14
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.ModelSnapshot",
"type": "Type",
"tags": [],
"label": "ModelSnapshot",
"description": [],
"signature": [
"MlModelSnapshot"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/model_snapshot.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.ModuleSetupPayload",
"type": "Type",
"tags": [],
"label": "ModuleSetupPayload",
"description": [],
"signature": [
"Readonly<{} & { moduleId: string; }> & Readonly<{ start?: number | undefined; query?: any; prefix?: string | undefined; end?: number | undefined; groups?: string[] | undefined; indexPatternName?: string | undefined; useDedicatedIndex?: boolean | undefined; startDatafeed?: boolean | undefined; jobOverrides?: any; datafeedOverrides?: any; estimateModelMemory?: boolean | undefined; applyToAllSpaces?: boolean | undefined; } & {}>"
],
"source": {
"path": "x-pack/plugins/ml/server/shared_services/providers/modules.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.Node",
"type": "Type",
"tags": [],
"label": "Node",
"description": [],
"signature": [
"MlDiscoveryNode"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
"lineNumber": 20
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.PartitionFieldsType",
"type": "Type",
"tags": [],
"label": "PartitionFieldsType",
"description": [],
"signature": [
"\"partition_field\" | \"over_field\" | \"by_field\""
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomalies.ts",
"lineNumber": 60
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-server.TimingStats",
"type": "Type",
"tags": [],
"label": "TimingStats",
"description": [],
"signature": [
"MlTimingStats"
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "ml",
"id": "def-server.MlPluginSetup",
"type": "Type",
"tags": [],
"label": "MlPluginSetup",
"description": [],
"signature": [
"JobServiceProvider",
" & ",
"AnomalyDetectorsProvider",
" & ",
"MlSystemProvider",
" & ",
"ModulesProvider",
" & ",
"ResultsServiceProvider",
" & { alertingServiceProvider(savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise<any>; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, startedAt: Date, previousStartedAt: Date | null) => Promise<",
"AnomalyDetectionAlertContext",
" | undefined>; }; }"
],
"source": {
"path": "x-pack/plugins/ml/server/plugin.ts",
"lineNumber": 64
},
"deprecated": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "ml",
"id": "def-server.MlPluginStart",
"type": "Type",
"tags": [],
"label": "MlPluginStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "x-pack/plugins/ml/server/plugin.ts",
"lineNumber": 65
},
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "ml",
"id": "def-common.composeValidators",
"type": "Function",
"tags": [],
"label": "composeValidators",
"description": [
"\nComposes multiple validators into a single function"
],
"signature": [
"(validators: ((value: any) => { [key: string]: any; } | null)[]) => (value: any) => { [key: string]: any; } | null"
],
"source": {
"path": "x-pack/plugins/ml/common/util/validators.ts",
"lineNumber": 51
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.composeValidators.$1",
"type": "Array",
"tags": [],
"label": "validators",
"description": [],
"signature": [
"((value: any) => { [key: string]: any; } | null)[]"
],
"source": {
"path": "x-pack/plugins/ml/common/util/validators.ts",
"lineNumber": 52
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.extractErrorMessage",
"type": "Function",
"tags": [],
"label": "extractErrorMessage",
"description": [],
"signature": [
"(error: ",
"ErrorType",
") => string"
],
"source": {
"path": "x-pack/plugins/ml/common/util/errors/process_errors.ts",
"lineNumber": 106
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.extractErrorMessage.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"ErrorType"
],
"source": {
"path": "x-pack/plugins/ml/common/util/errors/process_errors.ts",
"lineNumber": 106
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.getSeverityColor",
"type": "Function",
"tags": [],
"label": "getSeverityColor",
"description": [],
"signature": [
"(normalizedScore: number) => string"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 185
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.getSeverityColor.$1",
"type": "number",
"tags": [],
"label": "normalizedScore",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 185
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.getSeverityType",
"type": "Function",
"tags": [],
"label": "getSeverityType",
"description": [],
"signature": [
"(normalizedScore: number) => ",
{
"pluginId": "ml",
"scope": "common",
"docId": "kibMlPluginApi",
"section": "def-common.ANOMALY_SEVERITY",
"text": "ANOMALY_SEVERITY"
}
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 146
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.getSeverityType.$1",
"type": "number",
"tags": [],
"label": "normalizedScore",
"description": [],
"signature": [
"number"
],
"source": {
"path": "x-pack/plugins/ml/common/util/anomaly_utils.ts",
"lineNumber": 146
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.isPopulatedObject",
"type": "Function",
"tags": [],
"label": "isPopulatedObject",
"description": [],
"signature": [
"<U extends string = string>(arg: unknown, requiredAttributes?: U[]) => arg is Record<U, unknown>"
],
"source": {
"path": "x-pack/plugins/ml/common/util/object_utils.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.isPopulatedObject.$1",
"type": "Unknown",
"tags": [],
"label": "arg",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/ml/common/util/object_utils.ts",
"lineNumber": 26
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "ml",
"id": "def-common.isPopulatedObject.$2",
"type": "Array",
"tags": [],
"label": "requiredAttributes",
"description": [],
"signature": [
"U[]"
],
"source": {
"path": "x-pack/plugins/ml/common/util/object_utils.ts",
"lineNumber": 27
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.isRuntimeField",
"type": "Function",
"tags": [],
"label": "isRuntimeField",
"description": [],
"signature": [
"(arg: unknown) => boolean"
],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 14
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.isRuntimeField.$1",
"type": "Unknown",
"tags": [],
"label": "arg",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 14
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.isRuntimeMappings",
"type": "Function",
"tags": [],
"label": "isRuntimeMappings",
"description": [],
"signature": [
"(arg: unknown) => boolean"
],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.isRuntimeMappings.$1",
"type": "Unknown",
"tags": [],
"label": "arg",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts",
"lineNumber": 27
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.patternValidator",
"type": "Function",
"tags": [],
"label": "patternValidator",
"description": [
"\nProvides a validator function for checking against pattern."
],
"signature": [
"(pattern: RegExp) => (value: string) => { pattern: { matchPattern: string; }; } | null"
],
"source": {
"path": "x-pack/plugins/ml/common/util/validators.ts",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.patternValidator.$1",
"type": "Object",
"tags": [],
"label": "pattern",
"description": [],
"signature": [
"RegExp"
],
"source": {
"path": "x-pack/plugins/ml/common/util/validators.ts",
"lineNumber": 35
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"parentPluginId": "ml",
"id": "def-common.ANOMALY_SEVERITY",
"type": "Enum",
"tags": [],
"label": "ANOMALY_SEVERITY",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.ANOMALY_THRESHOLD",
"type": "Enum",
"tags": [],
"label": "ANOMALY_THRESHOLD",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "ml",
"id": "def-common.ChartData",
"type": "Type",
"tags": [],
"label": "ChartData",
"description": [],
"signature": [
"NumericChartData",
" | ",
"OrdinalChartData",
" | ",
"UnsupportedChartData"
],
"source": {
"path": "x-pack/plugins/ml/common/types/field_histograms.ts",
"lineNumber": 68
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.RuntimeMappings",
"type": "Type",
"tags": [],
"label": "RuntimeMappings",
"description": [],
"signature": [
"{ [x: string]: ",
"MappingRuntimeField",
"; }"
],
"source": {
"path": "x-pack/plugins/ml/common/types/fields.ts",
"lineNumber": 115
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "ml",
"id": "def-common.ES_CLIENT_TOTAL_HITS_RELATION",
"type": "Object",
"tags": [],
"label": "ES_CLIENT_TOTAL_HITS_RELATION",
"description": [],
"signature": [
"{ GTE: ",
"SearchTotalHitsRelation",
"; EQ: ",
"SearchTotalHitsRelation",
"; }"
],
"source": {
"path": "x-pack/plugins/ml/common/types/es_client.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "ml",
"id": "def-common.SEVERITY_COLORS",
"type": "Object",
"tags": [],
"label": "SEVERITY_COLORS",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "ml",
"id": "def-common.SEVERITY_COLORS.CRITICAL",
"type": "string",
"tags": [],
"label": "CRITICAL",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-common.SEVERITY_COLORS.MAJOR",
"type": "string",
"tags": [],
"label": "MAJOR",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-common.SEVERITY_COLORS.MINOR",
"type": "string",
"tags": [],
"label": "MINOR",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-common.SEVERITY_COLORS.WARNING",
"type": "string",
"tags": [],
"label": "WARNING",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 29
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-common.SEVERITY_COLORS.LOW",
"type": "string",
"tags": [],
"label": "LOW",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "ml",
"id": "def-common.SEVERITY_COLORS.BLANK",
"type": "string",
"tags": [],
"label": "BLANK",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/constants/anomalies.ts",
"lineNumber": 31
},
"deprecated": false
}
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink