108 lines
5.0 KiB
Plaintext
108 lines
5.0 KiB
Plaintext
[[reference-ml-put_job]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
[[client.ml.putJob]]
|
|
=== client.ml.putJob
|
|
|
|
Create an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index.
|
|
|
|
{ref}/ml-put-job.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(MlPutJobRequest, options?): Promise<MlPutJobResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== MlPutJobRequest
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface MlPutJobRequest extends <<RequestBase>> {
|
|
job_id: <<Id>>
|
|
allow_lazy_open?: boolean
|
|
analysis_config: MlAnalysisConfig
|
|
analysis_limits?: MlAnalysisLimits
|
|
background_persist_interval?: <<Duration>>
|
|
custom_settings?: MlCustomSettings
|
|
daily_model_snapshot_retention_after_days?: <<long>>
|
|
data_description: MlDataDescription
|
|
datafeed_config?: MlDatafeedConfig
|
|
description?: string
|
|
groups?: string[]
|
|
model_plot_config?: MlModelPlotConfig
|
|
model_snapshot_retention_days?: <<long>>
|
|
renormalization_window_days?: <<long>>
|
|
results_index_name?: <<IndexName>>
|
|
results_retention_days?: <<long>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== MlPutJobResponse
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface MlPutJobResponse {
|
|
allow_lazy_open: boolean
|
|
analysis_config: MlAnalysisConfigRead
|
|
analysis_limits: MlAnalysisLimits
|
|
background_persist_interval?: <<Duration>>
|
|
create_time: <<DateTime>>
|
|
custom_settings?: MlCustomSettings
|
|
daily_model_snapshot_retention_after_days: <<long>>
|
|
data_description: MlDataDescription
|
|
datafeed_config?: MlDatafeed
|
|
description?: string
|
|
groups?: string[]
|
|
job_id: <<Id>>
|
|
job_type: string
|
|
job_version: string
|
|
model_plot_config?: MlModelPlotConfig
|
|
model_snapshot_id?: <<Id>>
|
|
model_snapshot_retention_days: <<long>>
|
|
renormalization_window_days?: <<long>>
|
|
results_index_name: string
|
|
results_retention_days?: <<long>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|