{ "id": "ml", "client": { "classes": [ { "parentPluginId": "ml", "id": "def-public.MlLocatorDefinition", "type": "Class", "tags": [], "label": "MlLocatorDefinition", "description": [], "signature": [ { "pluginId": "ml", "scope": "public", "docId": "kibMlPluginApi", "section": "def-public.MlLocatorDefinition", "text": "MlLocatorDefinition" }, " implements ", { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorDefinition", "text": "LocatorDefinition" }, "<", "MlLocatorParams", ">" ], "path": "x-pack/plugins/ml/public/locator/ml_locator.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.MlLocatorDefinition.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "\"ML_APP_LOCATOR\"" ], "path": "x-pack/plugins/ml/public/locator/ml_locator.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlLocatorDefinition.getLocation", "type": "Function", "tags": [], "label": "getLocation", "description": [], "signature": [ "(params: ", "MlLocatorParams", ") => Promise<", "KibanaLocation", ">" ], "path": "x-pack/plugins/ml/public/locator/ml_locator.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.MlLocatorDefinition.getLocation.$1", "type": "CompoundType", "tags": [], "label": "params", "description": [], "signature": [ "MlLocatorParams" ], "path": "x-pack/plugins/ml/public/locator/ml_locator.ts", "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" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.getFormattedSeverityScore.$1", "type": "number", "tags": [], "label": "score", "description": [], "signature": [ "number" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.getMlSharedImports", "type": "Function", "tags": [], "label": "getMlSharedImports", "description": [], "signature": [ "() => Promise" ], "path": "x-pack/plugins/ml/public/index.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.getSeverity", "type": "Function", "tags": [], "label": "getSeverity", "description": [], "signature": [ "(normalizedScore: number) => ", "SeverityType" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.getSeverity.$1", "type": "number", "tags": [], "label": "normalizedScore", "description": [], "signature": [ "number" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.getSeverityColor", "type": "Function", "tags": [], "label": "getSeverityColor", "description": [], "signature": [ "(normalizedScore: number) => string" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.getSeverityColor.$1", "type": "number", "tags": [], "label": "normalizedScore", "description": [], "signature": [ "number" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "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" } ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.getSeverityType.$1", "type": "number", "tags": [], "label": "normalizedScore", "description": [], "signature": [ "number" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.MLJobsAwaitingNodeWarning", "type": "Function", "tags": [], "label": "MLJobsAwaitingNodeWarning", "description": [], "signature": [ "({ jobIds }: React.PropsWithChildren) => JSX.Element" ], "path": "x-pack/plugins/ml/public/application/components/jobs_awaiting_node_warning/new_job_awaiting_node_shared/lazy_loader.tsx", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.MLJobsAwaitingNodeWarning.$1", "type": "CompoundType", "tags": [], "label": "{ jobIds }", "description": [], "signature": [ "React.PropsWithChildren" ], "path": "x-pack/plugins/ml/public/application/components/jobs_awaiting_node_warning/new_job_awaiting_node_shared/lazy_loader.tsx", "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: { locator: ", "MlLocator", " | undefined; } | undefined, basePath: string | undefined, params: ", "MlLocatorParams", ") => string" ], "path": "x-pack/plugins/ml/public/locator/use_ml_href.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.useMlHref.$1", "type": "Object", "tags": [], "label": "ml", "description": [], "signature": [ "{ locator: ", "MlLocator", " | undefined; } | undefined" ], "path": "x-pack/plugins/ml/public/locator/use_ml_href.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "ml", "id": "def-public.useMlHref.$2", "type": "string", "tags": [], "label": "basePath", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/public/locator/use_ml_href.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "ml", "id": "def-public.useMlHref.$3", "type": "CompoundType", "tags": [], "label": "params", "description": [], "signature": [ "MlLocatorParams" ], "path": "x-pack/plugins/ml/public/locator/use_ml_href.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord", "type": "Interface", "tags": [], "label": "AnomaliesTableRecord", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.time", "type": "number", "tags": [], "label": "time", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.source", "type": "Object", "tags": [], "label": "source", "description": [], "signature": [ "AnomalyRecordDoc" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.rowId", "type": "string", "tags": [], "label": "rowId", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.jobId", "type": "string", "tags": [], "label": "jobId", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.detectorIndex", "type": "number", "tags": [], "label": "detectorIndex", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.severity", "type": "number", "tags": [], "label": "severity", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.entityName", "type": "string", "tags": [], "label": "entityName", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.entityValue", "type": "Any", "tags": [], "label": "entityValue", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.influencers", "type": "Array", "tags": [], "label": "influencers", "description": [], "signature": [ "{ [key: string]: any; }[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.actual", "type": "Array", "tags": [], "label": "actual", "description": [], "signature": [ "number[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.actualSort", "type": "Any", "tags": [], "label": "actualSort", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.typical", "type": "Array", "tags": [], "label": "typical", "description": [], "signature": [ "number[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.typicalSort", "type": "Any", "tags": [], "label": "typicalSort", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.AnomaliesTableRecord.metricDescriptionSort", "type": "number", "tags": [], "label": "metricDescriptionSort", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.DataRecognizerConfigResponse", "type": "Interface", "tags": [], "label": "DataRecognizerConfigResponse", "description": [], "path": "x-pack/plugins/ml/common/types/modules.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.DataRecognizerConfigResponse.datafeeds", "type": "Array", "tags": [], "label": "datafeeds", "description": [], "signature": [ "DatafeedResponse", "[]" ], "path": "x-pack/plugins/ml/common/types/modules.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.DataRecognizerConfigResponse.jobs", "type": "Array", "tags": [], "label": "jobs", "description": [], "signature": [ "JobResponse", "[]" ], "path": "x-pack/plugins/ml/common/types/modules.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.DataRecognizerConfigResponse.kibana", "type": "Object", "tags": [], "label": "kibana", "description": [], "signature": [ "{ search: ", "KibanaObjectResponse", "[]; visualization: ", "KibanaObjectResponse", "[]; dashboard: ", "KibanaObjectResponse", "[]; }" ], "path": "x-pack/plugins/ml/common/types/modules.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.Influencer", "type": "Interface", "tags": [], "label": "Influencer", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.Influencer.influencer_field_name", "type": "string", "tags": [], "label": "influencer_field_name", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.Influencer.influencer_field_values", "type": "Array", "tags": [], "label": "influencer_field_values", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.JobExistResult", "type": "Interface", "tags": [], "label": "JobExistResult", "description": [], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.JobExistResult.jobsExist", "type": "boolean", "tags": [], "label": "jobsExist", "description": [], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.JobExistResult.jobs", "type": "Array", "tags": [], "label": "jobs", "description": [], "signature": [ "JobStat", "[]" ], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.JobStat", "type": "Interface", "tags": [], "label": "JobStat", "description": [], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.JobStat.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.JobStat.earliestTimestampMs", "type": "number", "tags": [], "label": "earliestTimestampMs", "description": [], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.JobStat.latestTimestampMs", "type": "number", "tags": [], "label": "latestTimestampMs", "description": [], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.JobStat.latestResultsTimestampMs", "type": "number", "tags": [], "label": "latestResultsTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/data_recognizer.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.MlCapabilitiesResponse", "type": "Interface", "tags": [], "label": "MlCapabilitiesResponse", "description": [], "path": "x-pack/plugins/ml/common/types/capabilities.ts", "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; canResetJob: 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; }" ], "path": "x-pack/plugins/ml/common/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlCapabilitiesResponse.upgradeInProgress", "type": "boolean", "tags": [], "label": "upgradeInProgress", "description": [], "path": "x-pack/plugins/ml/common/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlCapabilitiesResponse.isPlatinumOrTrialLicense", "type": "boolean", "tags": [], "label": "isPlatinumOrTrialLicense", "description": [], "path": "x-pack/plugins/ml/common/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlCapabilitiesResponse.mlFeatureEnabledInSpace", "type": "boolean", "tags": [], "label": "mlFeatureEnabledInSpace", "description": [], "path": "x-pack/plugins/ml/common/types/capabilities.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob", "type": "Interface", "tags": [], "label": "MlSummaryJob", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.groups", "type": "Array", "tags": [], "label": "groups", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.processed_record_count", "type": "number", "tags": [], "label": "processed_record_count", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.memory_status", "type": "string", "tags": [], "label": "memory_status", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.jobState", "type": "string", "tags": [], "label": "jobState", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.datafeedIndices", "type": "Array", "tags": [], "label": "datafeedIndices", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.hasDatafeed", "type": "boolean", "tags": [], "label": "hasDatafeed", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.datafeedId", "type": "string", "tags": [], "label": "datafeedId", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.datafeedState", "type": "string", "tags": [], "label": "datafeedState", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.latestTimestampMs", "type": "number", "tags": [], "label": "latestTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.earliestTimestampMs", "type": "number", "tags": [], "label": "earliestTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.latestResultsTimestampMs", "type": "number", "tags": [], "label": "latestResultsTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.fullJob", "type": "Object", "tags": [], "label": "fullJob", "description": [], "signature": [ "CombinedJob", " | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.nodeName", "type": "string", "tags": [], "label": "nodeName", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.auditMessage", "type": "Object", "tags": [], "label": "auditMessage", "description": [], "signature": [ "Partial<", "AuditMessage", "> | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.isSingleMetricViewerJob", "type": "boolean", "tags": [], "label": "isSingleMetricViewerJob", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.isNotSingleMetricViewerJobMessage", "type": "string", "tags": [], "label": "isNotSingleMetricViewerJobMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.blocked", "type": "Object", "tags": [], "label": "blocked", "description": [], "signature": [ "MlJobBlocked", " | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.latestTimestampSortValue", "type": "number", "tags": [], "label": "latestTimestampSortValue", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.earliestStartTimestampMs", "type": "number", "tags": [], "label": "earliestStartTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.awaitingNodeAssignment", "type": "boolean", "tags": [], "label": "awaitingNodeAssignment", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "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", ">, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.jobTags", "type": "Object", "tags": [], "label": "jobTags", "description": [], "signature": [ "{ [x: string]: string; }" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "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\" | \"rowCount\" | \"errorMessage\" | \"baseline\" | \"chartsVisible\" | \"chartsButtonVisible\" | \"ccsWarning\" | \"columnsWithCharts\" | \"invalidSortingColumnns\" | \"noDataMessage\" | \"onChangeItemsPerPage\" | \"onChangePage\" | \"onSort\" | \"pagination\" | \"setPagination\" | \"setVisibleColumns\" | \"rowCountRelation\" | \"sortingColumns\" | \"tableItems\" | \"toggleChartVisibility\" | \"visibleColumns\" | \"predictionFieldName\" | \"resultsField\">" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "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) => void; }) => any" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "ml", "id": "def-public.UseIndexDataReturnType.renderCellValue.$1", "type": "Object", "tags": [], "label": "__0", "description": [], "signature": [ "{ rowIndex: number; columnId: string; setCellProps: (props: ", "CommonProps", " & React.HTMLAttributes) => void; }" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false } ] }, { "parentPluginId": "ml", "id": "def-public.UseIndexDataReturnType.indexPatternFields", "type": "Array", "tags": [], "label": "indexPatternFields", "description": [], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "ml", "id": "def-public.ANOMALY_SEVERITY", "type": "Enum", "tags": [], "label": "ANOMALY_SEVERITY", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "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\"" ], "path": "x-pack/plugins/ml/public/embeddables/constants.ts", "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" ], "path": "x-pack/plugins/ml/public/embeddables/types.ts", "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\"" ], "path": "x-pack/plugins/ml/public/ui_actions/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.EsSorting", "type": "Type", "tags": [], "label": "EsSorting", "description": [], "signature": [ "Dictionary", "<{ order: \"asc\" | \"desc\"; }>" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.GetMlSharedImportsReturnType", "type": "Type", "tags": [], "label": "GetMlSharedImportsReturnType", "description": [], "signature": [ "typeof ", "x-pack/plugins/ml/public/shared" ], "path": "x-pack/plugins/ml/public/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-public.MlLocator", "type": "Type", "tags": [], "label": "MlLocator", "description": [], "signature": [ { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorPublic", "text": "LocatorPublic" }, "<", "MlLocatorParams", ">" ], "path": "x-pack/plugins/ml/common/types/locator.ts", "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) => void; }) => any" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "ml", "id": "def-public.RenderCellValue.$1", "type": "Object", "tags": [], "label": "__0", "description": [], "signature": [ "{ rowIndex: number; columnId: string; setCellProps: (props: ", "CommonProps", " & React.HTMLAttributes) => void; }" ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "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", "; }" ], "path": "x-pack/plugins/ml/common/types/es_client.ts", "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\"; }" ], "path": "x-pack/plugins/ml/common/constants/locator.ts", "deprecated": false, "initialIsOpen": false } ], "start": { "parentPluginId": "ml", "id": "def-public.MlPluginStart", "type": "Type", "tags": [], "label": "MlPluginStart", "description": [], "signature": [ "{ locator: ", "MlLocator", " | undefined; }" ], "path": "x-pack/plugins/ml/public/plugin.ts", "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" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.InsufficientMLCapabilities.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.InsufficientMLCapabilities.Unnamed.$1", "type": "string", "tags": [], "label": "message", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "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" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.MLPrivilegesUninitialized.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.MLPrivilegesUninitialized.Unnamed.$1", "type": "string", "tags": [], "label": "message", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "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" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.UnknownMLCapabilitiesError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.UnknownMLCapabilitiesError.Unnamed.$1", "type": "string", "tags": [], "label": "message", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/server/lib/capabilities/errors.ts", "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 | undefined) => Promise" ], "path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts", "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" } ], "path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "ml", "id": "def-server.getHistogramsForFields.$2", "type": "string", "tags": [], "label": "indexPatternTitle", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "ml", "id": "def-server.getHistogramsForFields.$3", "type": "Any", "tags": [], "label": "query", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "ml", "id": "def-server.getHistogramsForFields.$4", "type": "Array", "tags": [], "label": "fields", "description": [], "signature": [ "HistogramField", "[]" ], "path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "ml", "id": "def-server.getHistogramsForFields.$5", "type": "number", "tags": [], "label": "samplerShardSize", "description": [], "signature": [ "number" ], "path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "ml", "id": "def-server.getHistogramsForFields.$6", "type": "Object", "tags": [], "label": "runtimeMappings", "description": [], "signature": [ "Record | undefined" ], "path": "x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.isCombinedJobWithStats", "type": "Function", "tags": [], "label": "isCombinedJobWithStats", "description": [], "signature": [ "(arg: any) => boolean" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.isCombinedJobWithStats.$1", "type": "Any", "tags": [], "label": "arg", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord", "type": "Interface", "tags": [], "label": "AnomaliesTableRecord", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.time", "type": "number", "tags": [], "label": "time", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.source", "type": "Object", "tags": [], "label": "source", "description": [], "signature": [ "AnomalyRecordDoc" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.rowId", "type": "string", "tags": [], "label": "rowId", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.jobId", "type": "string", "tags": [], "label": "jobId", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.detectorIndex", "type": "number", "tags": [], "label": "detectorIndex", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.severity", "type": "number", "tags": [], "label": "severity", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.entityName", "type": "string", "tags": [], "label": "entityName", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.entityValue", "type": "Any", "tags": [], "label": "entityValue", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.influencers", "type": "Array", "tags": [], "label": "influencers", "description": [], "signature": [ "{ [key: string]: any; }[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.actual", "type": "Array", "tags": [], "label": "actual", "description": [], "signature": [ "number[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.actualSort", "type": "Any", "tags": [], "label": "actualSort", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.typical", "type": "Array", "tags": [], "label": "typical", "description": [], "signature": [ "number[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.typicalSort", "type": "Any", "tags": [], "label": "typicalSort", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomaliesTableRecord.metricDescriptionSort", "type": "number", "tags": [], "label": "metricDescriptionSort", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc", "type": "Interface", "tags": [], "label": "AnomalyCategorizerStatsDoc", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.job_id", "type": "string", "tags": [], "label": "job_id", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.result_type", "type": "string", "tags": [], "label": "result_type", "description": [], "signature": [ "\"categorizer_stats\"" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.partition_field_name", "type": "string", "tags": [], "label": "partition_field_name", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.partition_field_value", "type": "string", "tags": [], "label": "partition_field_value", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.categorized_doc_count", "type": "number", "tags": [], "label": "categorized_doc_count", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.total_category_count", "type": "number", "tags": [], "label": "total_category_count", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.frequent_category_count", "type": "number", "tags": [], "label": "frequent_category_count", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.rare_category_count", "type": "number", "tags": [], "label": "rare_category_count", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.dead_category_count", "type": "number", "tags": [], "label": "dead_category_count", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.failed_category_count", "type": "number", "tags": [], "label": "failed_category_count", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.categorization_status", "type": "CompoundType", "tags": [], "label": "categorization_status", "description": [], "signature": [ "\"ok\" | \"warn\"" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.log_time", "type": "number", "tags": [], "label": "log_time", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyCategorizerStatsDoc.timestamp", "type": "number", "tags": [], "label": "timestamp", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc", "type": "Interface", "tags": [], "label": "AnomalyRecordDoc", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.job_id", "type": "string", "tags": [], "label": "job_id", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.result_type", "type": "string", "tags": [], "label": "result_type", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.probability", "type": "number", "tags": [], "label": "probability", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.record_score", "type": "number", "tags": [], "label": "record_score", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.initial_record_score", "type": "number", "tags": [], "label": "initial_record_score", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.bucket_span", "type": "number", "tags": [], "label": "bucket_span", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.detector_index", "type": "number", "tags": [], "label": "detector_index", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.is_interim", "type": "boolean", "tags": [], "label": "is_interim", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.timestamp", "type": "number", "tags": [], "label": "timestamp", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.partition_field_name", "type": "string", "tags": [], "label": "partition_field_name", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.partition_field_value", "type": "CompoundType", "tags": [], "label": "partition_field_value", "description": [], "signature": [ "string | number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.function", "type": "string", "tags": [], "label": "function", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.function_description", "type": "string", "tags": [], "label": "function_description", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.typical", "type": "Array", "tags": [], "label": "typical", "description": [], "signature": [ "number[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.actual", "type": "Array", "tags": [], "label": "actual", "description": [], "signature": [ "number[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.influencers", "type": "Array", "tags": [], "label": "influencers", "description": [], "signature": [ "Influencer", "[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.by_field_name", "type": "string", "tags": [], "label": "by_field_name", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.field_name", "type": "string", "tags": [], "label": "field_name", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.by_field_value", "type": "string", "tags": [], "label": "by_field_value", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.multi_bucket_impact", "type": "number", "tags": [], "label": "multi_bucket_impact", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.over_field_name", "type": "string", "tags": [], "label": "over_field_name", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.over_field_value", "type": "string", "tags": [], "label": "over_field_value", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyRecordDoc.causes", "type": "Array", "tags": [], "label": "causes", "description": [], "signature": [ "any[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.AuditMessage", "type": "Interface", "tags": [], "label": "AuditMessage", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.AuditMessage.job_id", "type": "string", "tags": [], "label": "job_id", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AuditMessage.msgTime", "type": "number", "tags": [], "label": "msgTime", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AuditMessage.level", "type": "string", "tags": [], "label": "level", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AuditMessage.highestLevel", "type": "string", "tags": [], "label": "highestLevel", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AuditMessage.highestLevelText", "type": "string", "tags": [], "label": "highestLevelText", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AuditMessage.text", "type": "string", "tags": [], "label": "text", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.AuditMessage.cleared", "type": "CompoundType", "tags": [], "label": "cleared", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.CombinedJob", "type": "Interface", "tags": [], "label": "CombinedJob", "description": [], "signature": [ "CombinedJob", " extends ", "MlJob" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.CombinedJob.calendars", "type": "Array", "tags": [], "label": "calendars", "description": [], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.CombinedJob.datafeed_config", "type": "Object", "tags": [], "label": "datafeed_config", "description": [], "signature": [ "MlDatafeed" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.CombinedJobWithStats", "type": "Interface", "tags": [], "label": "CombinedJobWithStats", "description": [], "signature": [ "CombinedJobWithStats", " extends ", "JobWithStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.CombinedJobWithStats.calendars", "type": "Array", "tags": [], "label": "calendars", "description": [], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.CombinedJobWithStats.datafeed_config", "type": "CompoundType", "tags": [], "label": "datafeed_config", "description": [], "signature": [ "MlDatafeed", " & ", "MlDatafeedStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.Influencer", "type": "Interface", "tags": [], "label": "Influencer", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.Influencer.influencer_field_name", "type": "string", "tags": [], "label": "influencer_field_name", "description": [], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.Influencer.influencer_field_values", "type": "Array", "tags": [], "label": "influencer_field_values", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.MlJobWithTimeRange", "type": "Interface", "tags": [], "label": "MlJobWithTimeRange", "description": [], "signature": [ "MlJobWithTimeRange", " extends ", "CombinedJobWithStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.MlJobWithTimeRange.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlJobWithTimeRange.isRunning", "type": "CompoundType", "tags": [], "label": "isRunning", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlJobWithTimeRange.isNotSingleMetricViewerJobMessage", "type": "string", "tags": [], "label": "isNotSingleMetricViewerJobMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "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; }" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob", "type": "Interface", "tags": [], "label": "MlSummaryJob", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.groups", "type": "Array", "tags": [], "label": "groups", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.processed_record_count", "type": "number", "tags": [], "label": "processed_record_count", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.memory_status", "type": "string", "tags": [], "label": "memory_status", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.jobState", "type": "string", "tags": [], "label": "jobState", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.datafeedIndices", "type": "Array", "tags": [], "label": "datafeedIndices", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.hasDatafeed", "type": "boolean", "tags": [], "label": "hasDatafeed", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.datafeedId", "type": "string", "tags": [], "label": "datafeedId", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.datafeedState", "type": "string", "tags": [], "label": "datafeedState", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.latestTimestampMs", "type": "number", "tags": [], "label": "latestTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.earliestTimestampMs", "type": "number", "tags": [], "label": "earliestTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.latestResultsTimestampMs", "type": "number", "tags": [], "label": "latestResultsTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.fullJob", "type": "Object", "tags": [], "label": "fullJob", "description": [], "signature": [ "CombinedJob", " | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.nodeName", "type": "string", "tags": [], "label": "nodeName", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.auditMessage", "type": "Object", "tags": [], "label": "auditMessage", "description": [], "signature": [ "Partial<", "AuditMessage", "> | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.isSingleMetricViewerJob", "type": "boolean", "tags": [], "label": "isSingleMetricViewerJob", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.isNotSingleMetricViewerJobMessage", "type": "string", "tags": [], "label": "isNotSingleMetricViewerJobMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.blocked", "type": "Object", "tags": [], "label": "blocked", "description": [], "signature": [ "MlJobBlocked", " | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.latestTimestampSortValue", "type": "number", "tags": [], "label": "latestTimestampSortValue", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.earliestStartTimestampMs", "type": "number", "tags": [], "label": "earliestStartTimestampMs", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.awaitingNodeAssignment", "type": "boolean", "tags": [], "label": "awaitingNodeAssignment", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "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", ">, \"id\" | \"name\" | \"tags\" | \"enabled\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[] | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJob.jobTags", "type": "Object", "tags": [], "label": "jobTags", "description": [], "signature": [ "{ [x: string]: string; }" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.PerPartitionCategorization", "type": "Interface", "tags": [], "label": "PerPartitionCategorization", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-server.PerPartitionCategorization.enabled", "type": "CompoundType", "tags": [], "label": "enabled", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-server.PerPartitionCategorization.stop_on_warn", "type": "CompoundType", "tags": [], "label": "stop_on_warn", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "ml", "id": "def-server.Aggregation", "type": "Type", "tags": [], "label": "Aggregation", "description": [], "signature": [ "{ [x: string]: ", "AggregationsAggregationContainer", "; }" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.AnalysisConfig", "type": "Type", "tags": [], "label": "AnalysisConfig", "description": [], "signature": [ "MlAnalysisConfig" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.AnalysisLimits", "type": "Type", "tags": [], "label": "AnalysisLimits", "description": [], "signature": [ "MlAnalysisLimits" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.AnomalyResultType", "type": "Type", "tags": [], "label": "AnomalyResultType", "description": [], "signature": [ "\"record\" | \"bucket\" | \"influencer\"" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.BucketSpan", "type": "Type", "tags": [], "label": "BucketSpan", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.ChunkingConfig", "type": "Type", "tags": [], "label": "ChunkingConfig", "description": [], "signature": [ "MlChunkingConfig" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.CustomRule", "type": "Type", "tags": [], "label": "CustomRule", "description": [], "signature": [ "MlDetectionRule" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.CustomSettings", "type": "Type", "tags": [], "label": "CustomSettings", "description": [], "signature": [ "MlCustomSettings" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.DataCounts", "type": "Type", "tags": [], "label": "DataCounts", "description": [], "signature": [ "MlDataCounts" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.DataDescription", "type": "Type", "tags": [], "label": "DataDescription", "description": [], "signature": [ "MlDataDescription" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.Datafeed", "type": "Type", "tags": [], "label": "Datafeed", "description": [], "signature": [ "MlDatafeed" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.DatafeedId", "type": "Type", "tags": [], "label": "DatafeedId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.DatafeedStats", "type": "Type", "tags": [], "label": "DatafeedStats", "description": [], "signature": [ "MlDatafeedStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.DatafeedWithStats", "type": "Type", "tags": [], "label": "DatafeedWithStats", "description": [], "signature": [ "MlDatafeed", " & ", "MlDatafeedStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.Detector", "type": "Type", "tags": [], "label": "Detector", "description": [], "signature": [ "MlDetector" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.EntityFieldType", "type": "Type", "tags": [], "label": "EntityFieldType", "description": [], "signature": [ "\"partition_field\" | \"over_field\" | \"by_field\"" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.ForecastsStats", "type": "Type", "tags": [], "label": "ForecastsStats", "description": [], "signature": [ "MlJobForecastStatistics" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.IndicesOptions", "type": "Type", "tags": [], "label": "IndicesOptions", "description": [], "signature": [ "MlDatafeedIndicesOptions" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.Job", "type": "Type", "tags": [], "label": "Job", "description": [], "signature": [ "MlJob" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.JobId", "type": "Type", "tags": [], "label": "JobId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.JobStats", "type": "Type", "tags": [], "label": "JobStats", "description": [], "signature": [ "MlJobStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.JobWithStats", "type": "Type", "tags": [], "label": "JobWithStats", "description": [], "signature": [ "MlJob", " & ", "MlJobStats", " & ", "JobAlertingRuleStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/combined_job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.MLAnomalyDoc", "type": "Type", "tags": [], "label": "MLAnomalyDoc", "description": [], "signature": [ "AnomalyRecordDoc" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.MlJobBlocked", "type": "Type", "tags": [], "label": "MlJobBlocked", "description": [], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.MlSummaryJobs", "type": "Type", "tags": [], "label": "MlSummaryJobs", "description": [], "signature": [ "MlSummaryJob", "[]" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.ModelPlotConfig", "type": "Type", "tags": [], "label": "ModelPlotConfig", "description": [], "signature": [ "MlModelPlotConfig" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.ModelSizeStats", "type": "Type", "tags": [], "label": "ModelSizeStats", "description": [], "signature": [ "MlModelSizeStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.ModelSnapshot", "type": "Type", "tags": [], "label": "ModelSnapshot", "description": [], "signature": [ "MlModelSnapshot" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/model_snapshot.ts", "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; } & {}>" ], "path": "x-pack/plugins/ml/server/shared_services/providers/modules.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.Node", "type": "Type", "tags": [], "label": "Node", "description": [], "signature": [ "MlDiscoveryNode" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.PartitionFieldsType", "type": "Type", "tags": [], "label": "PartitionFieldsType", "description": [], "signature": [ "\"partition_field\" | \"over_field\" | \"by_field\"" ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-server.TimingStats", "type": "Type", "tags": [], "label": "TimingStats", "description": [], "signature": [ "MlTimingStats" ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job_stats.ts", "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" }, ", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "): { 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; 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>; }; }" ], "path": "x-pack/plugins/ml/server/plugin.ts", "deprecated": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "ml", "id": "def-server.MlPluginStart", "type": "Type", "tags": [], "label": "MlPluginStart", "description": [], "signature": [ "void" ], "path": "x-pack/plugins/ml/server/plugin.ts", "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" ], "path": "x-pack/plugins/ml/common/util/validators.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.composeValidators.$1", "type": "Array", "tags": [], "label": "validators", "description": [], "signature": [ "((value: any) => { [key: string]: any; } | null)[]" ], "path": "x-pack/plugins/ml/common/util/validators.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.extractErrorMessage", "type": "Function", "tags": [], "label": "extractErrorMessage", "description": [], "signature": [ "(error: ", "ErrorType", ") => string" ], "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.extractErrorMessage.$1", "type": "CompoundType", "tags": [], "label": "error", "description": [], "signature": [ "ErrorType" ], "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.getSeverityColor", "type": "Function", "tags": [], "label": "getSeverityColor", "description": [], "signature": [ "(normalizedScore: number) => string" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.getSeverityColor.$1", "type": "number", "tags": [], "label": "normalizedScore", "description": [], "signature": [ "number" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "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" } ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.getSeverityType.$1", "type": "number", "tags": [], "label": "normalizedScore", "description": [], "signature": [ "number" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.isPopulatedObject", "type": "Function", "tags": [], "label": "isPopulatedObject", "description": [], "signature": [ "(arg: unknown, requiredAttributes?: U[]) => arg is Record" ], "path": "x-pack/plugins/ml/common/util/object_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.isPopulatedObject.$1", "type": "Unknown", "tags": [], "label": "arg", "description": [], "signature": [ "unknown" ], "path": "x-pack/plugins/ml/common/util/object_utils.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "ml", "id": "def-common.isPopulatedObject.$2", "type": "Array", "tags": [], "label": "requiredAttributes", "description": [], "signature": [ "U[]" ], "path": "x-pack/plugins/ml/common/util/object_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.isRuntimeField", "type": "Function", "tags": [], "label": "isRuntimeField", "description": [], "signature": [ "(arg: unknown) => boolean" ], "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.isRuntimeField.$1", "type": "Unknown", "tags": [], "label": "arg", "description": [], "signature": [ "unknown" ], "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.isRuntimeMappings", "type": "Function", "tags": [], "label": "isRuntimeMappings", "description": [], "signature": [ "(arg: unknown) => boolean" ], "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.isRuntimeMappings.$1", "type": "Unknown", "tags": [], "label": "arg", "description": [], "signature": [ "unknown" ], "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", "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" ], "path": "x-pack/plugins/ml/common/util/validators.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.patternValidator.$1", "type": "Object", "tags": [], "label": "pattern", "description": [], "signature": [ "RegExp" ], "path": "x-pack/plugins/ml/common/util/validators.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [ { "parentPluginId": "ml", "id": "def-common.ANOMALY_SEVERITY", "type": "Enum", "tags": [], "label": "ANOMALY_SEVERITY", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.ANOMALY_THRESHOLD", "type": "Enum", "tags": [], "label": "ANOMALY_THRESHOLD", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "ml", "id": "def-common.ChartData", "type": "Type", "tags": [], "label": "ChartData", "description": [], "signature": [ "NumericChartData", " | ", "OrdinalChartData", " | ", "UnsupportedChartData" ], "path": "x-pack/plugins/ml/common/types/field_histograms.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.RuntimeMappings", "type": "Type", "tags": [], "label": "RuntimeMappings", "description": [], "signature": [ "{ [x: string]: ", "MappingRuntimeField", "; }" ], "path": "x-pack/plugins/ml/common/types/fields.ts", "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", "; }" ], "path": "x-pack/plugins/ml/common/types/es_client.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "ml", "id": "def-common.SEVERITY_COLORS", "type": "Object", "tags": [], "label": "SEVERITY_COLORS", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", "id": "def-common.SEVERITY_COLORS.CRITICAL", "type": "string", "tags": [], "label": "CRITICAL", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-common.SEVERITY_COLORS.MAJOR", "type": "string", "tags": [], "label": "MAJOR", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-common.SEVERITY_COLORS.MINOR", "type": "string", "tags": [], "label": "MINOR", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-common.SEVERITY_COLORS.WARNING", "type": "string", "tags": [], "label": "WARNING", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-common.SEVERITY_COLORS.LOW", "type": "string", "tags": [], "label": "LOW", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false }, { "parentPluginId": "ml", "id": "def-common.SEVERITY_COLORS.BLANK", "type": "string", "tags": [], "label": "BLANK", "description": [], "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false } ], "initialIsOpen": false } ] } }