Files
elasticsearch-js/docs/reference-ml-stop_data_frame_analytics.asciidoc
2024-12-05 14:46:51 -06:00

76 lines
4.0 KiB
Plaintext

[[reference-ml-stop_data_frame_analytics]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.stopDataFrameAnalytics
Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle.
{ref}/stop-dfanalytics.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlStopDataFrameAnalyticsRequest, options?): Promise<MlStopDataFrameAnalyticsResponse>
----
[discrete]
==== MlStopDataFrameAnalyticsRequest
[pass]
++++
<pre>
++++
interface MlStopDataFrameAnalyticsRequest extends <<RequestBase>> {
id: <<Id>>
allow_no_match?: boolean
force?: boolean
timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== MlStopDataFrameAnalyticsResponse
[pass]
++++
<pre>
++++
interface MlStopDataFrameAnalyticsResponse {
stopped: boolean
}
[pass]
++++
</pre>
++++