Files
elasticsearch-js/docs/reference-rollup-get_rollup_index_caps.asciidoc
2024-12-05 14:46:52 -06:00

72 lines
4.0 KiB
Plaintext

[[reference-rollup-get_rollup_index_caps]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.rollup.getRollupIndexCaps]]
=== client.rollup.getRollupIndexCaps
Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).
{ref}/rollup-get-rollup-index-caps.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(RollupGetRollupIndexCapsRequest, options?): Promise<RollupGetRollupIndexCapsResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface RollupGetRollupIndexCapsRequest extends <<RequestBase>> {
index: <<Ids>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
type RollupGetRollupIndexCapsResponse = Record<<<IndexName>>, RollupGetRollupIndexCapsIndexCapabilities>
[pass]
++++
</pre>
++++