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

76 lines
4.2 KiB
Plaintext

[[reference-ml-get_datafeeds]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.getDatafeeds
Get datafeeds configuration info. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. This API returns a maximum of 10,000 datafeeds.
{ref}/ml-get-datafeed.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetDatafeedsRequest, options?): Promise<MlGetDatafeedsResponse>
----
[discrete]
==== MlGetDatafeedsRequest
[pass]
++++
<pre>
++++
interface MlGetDatafeedsRequest extends <<RequestBase>> {
datafeed_id?: <<Ids>>
allow_no_match?: boolean
exclude_generated?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== MlGetDatafeedsResponse
[pass]
++++
<pre>
++++
interface MlGetDatafeedsResponse {
count: <<_long, long>>
datafeeds: MlDatafeed[]
}
[pass]
++++
</pre>
++++