habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/reference-cat-ml_datafeeds.asciidoc Normal file
View File

@ -0,0 +1,64 @@
[[reference-cat-ml_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.cat.mlDatafeeds
Get datafeeds. Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.
{ref}/cat-datafeeds.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(CatMlDatafeedsRequest, options?): Promise<CatMlDatafeedsResponse>
----
[discrete]
===== `CatMlDatafeedsRequest`
[source,ts]
----
interface CatMlDatafeedsRequest extends CatCatRequestBase {
datafeed_id?: <<shared-type-id, Id>>
allow_no_match?: boolean
h?: CatCatDatafeedColumns
s?: CatCatDatafeedColumns
time?: <<shared-type-time-unit, TimeUnit>>
}
----
[discrete]
===== `CatMlDatafeedsResponse`
[source,ts]
----
type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[]
----