@elastic/elasticsearch 8.16.2 → 9.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (273) hide show
  1. package/catalog-info.yaml +4 -1
  2. package/lib/api/api/async_search.d.ts +16 -17
  3. package/lib/api/api/async_search.js +5 -16
  4. package/lib/api/api/async_search.js.map +1 -1
  5. package/lib/api/api/autoscaling.d.ts +16 -17
  6. package/lib/api/api/autoscaling.js +5 -7
  7. package/lib/api/api/autoscaling.js.map +1 -1
  8. package/lib/api/api/bulk.d.ts +4 -5
  9. package/lib/api/api/bulk.js +3 -5
  10. package/lib/api/api/bulk.js.map +1 -1
  11. package/lib/api/api/capabilities.d.ts +3 -4
  12. package/lib/api/api/capabilities.js +2 -2
  13. package/lib/api/api/capabilities.js.map +1 -1
  14. package/lib/api/api/cat.d.ts +121 -122
  15. package/lib/api/api/cat.js +26 -26
  16. package/lib/api/api/cat.js.map +1 -1
  17. package/lib/api/api/ccr.d.ts +52 -53
  18. package/lib/api/api/ccr.js +18 -54
  19. package/lib/api/api/ccr.js.map +1 -1
  20. package/lib/api/api/clear_scroll.d.ts +4 -5
  21. package/lib/api/api/clear_scroll.js +3 -12
  22. package/lib/api/api/clear_scroll.js.map +1 -1
  23. package/lib/api/api/close_point_in_time.d.ts +4 -5
  24. package/lib/api/api/close_point_in_time.js +3 -12
  25. package/lib/api/api/close_point_in_time.js.map +1 -1
  26. package/lib/api/api/cluster.d.ts +64 -65
  27. package/lib/api/api/cluster.js +20 -56
  28. package/lib/api/api/cluster.js.map +1 -1
  29. package/lib/api/api/connector.d.ts +132 -133
  30. package/lib/api/api/connector.js +50 -194
  31. package/lib/api/api/connector.js.map +1 -1
  32. package/lib/api/api/count.d.ts +5 -6
  33. package/lib/api/api/count.js +3 -12
  34. package/lib/api/api/count.js.map +1 -1
  35. package/lib/api/api/create.d.ts +4 -5
  36. package/lib/api/api/create.js +3 -5
  37. package/lib/api/api/create.js.map +1 -1
  38. package/lib/api/api/dangling_indices.d.ts +12 -13
  39. package/lib/api/api/dangling_indices.js +3 -3
  40. package/lib/api/api/dangling_indices.js.map +1 -1
  41. package/lib/api/api/delete.d.ts +4 -5
  42. package/lib/api/api/delete.js +2 -2
  43. package/lib/api/api/delete.js.map +1 -1
  44. package/lib/api/api/delete_by_query.d.ts +4 -5
  45. package/lib/api/api/delete_by_query.js +3 -12
  46. package/lib/api/api/delete_by_query.js.map +1 -1
  47. package/lib/api/api/delete_by_query_rethrottle.d.ts +4 -5
  48. package/lib/api/api/delete_by_query_rethrottle.js +2 -2
  49. package/lib/api/api/delete_by_query_rethrottle.js.map +1 -1
  50. package/lib/api/api/delete_script.d.ts +4 -5
  51. package/lib/api/api/delete_script.js +2 -2
  52. package/lib/api/api/delete_script.js.map +1 -1
  53. package/lib/api/api/enrich.d.ts +21 -22
  54. package/lib/api/api/enrich.js +6 -15
  55. package/lib/api/api/enrich.js.map +1 -1
  56. package/lib/api/api/eql.d.ts +20 -21
  57. package/lib/api/api/eql.js +6 -15
  58. package/lib/api/api/eql.js.map +1 -1
  59. package/lib/api/api/esql.d.ts +13 -14
  60. package/lib/api/api/esql.js +4 -13
  61. package/lib/api/api/esql.js.map +1 -1
  62. package/lib/api/api/exists.d.ts +4 -5
  63. package/lib/api/api/exists.js +2 -2
  64. package/lib/api/api/exists.js.map +1 -1
  65. package/lib/api/api/exists_source.d.ts +4 -5
  66. package/lib/api/api/exists_source.js +2 -2
  67. package/lib/api/api/exists_source.js.map +1 -1
  68. package/lib/api/api/explain.d.ts +4 -5
  69. package/lib/api/api/explain.js +3 -12
  70. package/lib/api/api/explain.js.map +1 -1
  71. package/lib/api/api/features.d.ts +8 -9
  72. package/lib/api/api/features.js +2 -2
  73. package/lib/api/api/features.js.map +1 -1
  74. package/lib/api/api/field_caps.d.ts +4 -5
  75. package/lib/api/api/field_caps.js +3 -12
  76. package/lib/api/api/field_caps.js.map +1 -1
  77. package/lib/api/api/fleet.d.ts +22 -23
  78. package/lib/api/api/fleet.js +8 -19
  79. package/lib/api/api/fleet.js.map +1 -1
  80. package/lib/api/api/get.d.ts +4 -5
  81. package/lib/api/api/get.js +2 -2
  82. package/lib/api/api/get.js.map +1 -1
  83. package/lib/api/api/get_script.d.ts +4 -5
  84. package/lib/api/api/get_script.js +2 -2
  85. package/lib/api/api/get_script.js.map +1 -1
  86. package/lib/api/api/get_script_context.d.ts +4 -5
  87. package/lib/api/api/get_script_context.js +2 -2
  88. package/lib/api/api/get_script_context.js.map +1 -1
  89. package/lib/api/api/get_script_languages.d.ts +4 -5
  90. package/lib/api/api/get_script_languages.js +2 -2
  91. package/lib/api/api/get_script_languages.js.map +1 -1
  92. package/lib/api/api/get_source.d.ts +4 -5
  93. package/lib/api/api/get_source.js +2 -2
  94. package/lib/api/api/get_source.js.map +1 -1
  95. package/lib/api/api/graph.d.ts +5 -6
  96. package/lib/api/api/graph.js +2 -11
  97. package/lib/api/api/graph.js.map +1 -1
  98. package/lib/api/api/health_report.d.ts +4 -5
  99. package/lib/api/api/health_report.js +2 -2
  100. package/lib/api/api/health_report.js.map +1 -1
  101. package/lib/api/api/ilm.d.ts +44 -45
  102. package/lib/api/api/ilm.js +14 -41
  103. package/lib/api/api/ilm.js.map +1 -1
  104. package/lib/api/api/index.d.ts +4 -5
  105. package/lib/api/api/index.js +3 -5
  106. package/lib/api/api/index.js.map +1 -1
  107. package/lib/api/api/indices.d.ts +238 -239
  108. package/lib/api/api/indices.js +77 -216
  109. package/lib/api/api/indices.js.map +1 -1
  110. package/lib/api/api/inference.d.ts +20 -21
  111. package/lib/api/api/inference.js +7 -18
  112. package/lib/api/api/inference.js.map +1 -1
  113. package/lib/api/api/info.d.ts +4 -5
  114. package/lib/api/api/info.js +2 -2
  115. package/lib/api/api/info.js.map +1 -1
  116. package/lib/api/api/ingest.d.ts +57 -58
  117. package/lib/api/api/ingest.js +15 -42
  118. package/lib/api/api/ingest.js.map +1 -1
  119. package/lib/api/api/knn_search.d.ts +4 -5
  120. package/lib/api/api/knn_search.js +3 -12
  121. package/lib/api/api/knn_search.js.map +1 -1
  122. package/lib/api/api/license.d.ts +28 -29
  123. package/lib/api/api/license.js +8 -17
  124. package/lib/api/api/license.js.map +1 -1
  125. package/lib/api/api/logstash.d.ts +12 -13
  126. package/lib/api/api/logstash.js +4 -6
  127. package/lib/api/api/logstash.js.map +1 -1
  128. package/lib/api/api/mget.d.ts +4 -5
  129. package/lib/api/api/mget.js +3 -12
  130. package/lib/api/api/mget.js.map +1 -1
  131. package/lib/api/api/migration.d.ts +12 -13
  132. package/lib/api/api/migration.js +3 -3
  133. package/lib/api/api/migration.js.map +1 -1
  134. package/lib/api/api/ml.d.ts +293 -294
  135. package/lib/api/api/ml.js +112 -449
  136. package/lib/api/api/ml.js.map +1 -1
  137. package/lib/api/api/monitoring.d.ts +4 -5
  138. package/lib/api/api/monitoring.js +2 -4
  139. package/lib/api/api/monitoring.js.map +1 -1
  140. package/lib/api/api/msearch.d.ts +4 -5
  141. package/lib/api/api/msearch.js +3 -5
  142. package/lib/api/api/msearch.js.map +1 -1
  143. package/lib/api/api/msearch_template.d.ts +4 -5
  144. package/lib/api/api/msearch_template.js +3 -5
  145. package/lib/api/api/msearch_template.js.map +1 -1
  146. package/lib/api/api/mtermvectors.d.ts +4 -5
  147. package/lib/api/api/mtermvectors.js +3 -12
  148. package/lib/api/api/mtermvectors.js.map +1 -1
  149. package/lib/api/api/nodes.d.ts +28 -29
  150. package/lib/api/api/nodes.js +8 -17
  151. package/lib/api/api/nodes.js.map +1 -1
  152. package/lib/api/api/open_point_in_time.d.ts +4 -5
  153. package/lib/api/api/open_point_in_time.js +3 -12
  154. package/lib/api/api/open_point_in_time.js.map +1 -1
  155. package/lib/api/api/ping.d.ts +4 -5
  156. package/lib/api/api/ping.js +2 -2
  157. package/lib/api/api/ping.js.map +1 -1
  158. package/lib/api/api/profiling.d.ts +16 -17
  159. package/lib/api/api/profiling.js +4 -4
  160. package/lib/api/api/profiling.js.map +1 -1
  161. package/lib/api/api/put_script.d.ts +4 -5
  162. package/lib/api/api/put_script.js +3 -12
  163. package/lib/api/api/put_script.js.map +1 -1
  164. package/lib/api/api/query_rules.d.ts +40 -41
  165. package/lib/api/api/query_rules.js +11 -38
  166. package/lib/api/api/query_rules.js.map +1 -1
  167. package/lib/api/api/rank_eval.d.ts +4 -5
  168. package/lib/api/api/rank_eval.js +3 -12
  169. package/lib/api/api/rank_eval.js.map +1 -1
  170. package/lib/api/api/reindex.d.ts +4 -5
  171. package/lib/api/api/reindex.js +3 -12
  172. package/lib/api/api/reindex.js.map +1 -1
  173. package/lib/api/api/reindex_rethrottle.d.ts +4 -5
  174. package/lib/api/api/reindex_rethrottle.js +2 -2
  175. package/lib/api/api/reindex_rethrottle.js.map +1 -1
  176. package/lib/api/api/render_search_template.d.ts +4 -5
  177. package/lib/api/api/render_search_template.js +3 -12
  178. package/lib/api/api/render_search_template.js.map +1 -1
  179. package/lib/api/api/rollup.d.ts +32 -33
  180. package/lib/api/api/rollup.js +10 -28
  181. package/lib/api/api/rollup.js.map +1 -1
  182. package/lib/api/api/scripts_painless_execute.d.ts +4 -5
  183. package/lib/api/api/scripts_painless_execute.js +3 -12
  184. package/lib/api/api/scripts_painless_execute.js.map +1 -1
  185. package/lib/api/api/scroll.d.ts +4 -5
  186. package/lib/api/api/scroll.js +3 -12
  187. package/lib/api/api/scroll.js.map +1 -1
  188. package/lib/api/api/search.d.ts +4 -5
  189. package/lib/api/api/search.js +3 -14
  190. package/lib/api/api/search.js.map +1 -1
  191. package/lib/api/api/search_application.d.ts +39 -40
  192. package/lib/api/api/search_application.js +12 -23
  193. package/lib/api/api/search_application.js.map +1 -1
  194. package/lib/api/api/search_mvt.d.ts +4 -5
  195. package/lib/api/api/search_mvt.js +3 -12
  196. package/lib/api/api/search_mvt.js.map +1 -1
  197. package/lib/api/api/search_shards.d.ts +4 -5
  198. package/lib/api/api/search_shards.js +2 -2
  199. package/lib/api/api/search_shards.js.map +1 -1
  200. package/lib/api/api/search_template.d.ts +4 -5
  201. package/lib/api/api/search_template.js +3 -12
  202. package/lib/api/api/search_template.js.map +1 -1
  203. package/lib/api/api/searchable_snapshots.d.ts +16 -17
  204. package/lib/api/api/searchable_snapshots.js +5 -14
  205. package/lib/api/api/searchable_snapshots.js.map +1 -1
  206. package/lib/api/api/security.d.ts +253 -254
  207. package/lib/api/api/security.js +92 -337
  208. package/lib/api/api/security.js.map +1 -1
  209. package/lib/api/api/shutdown.d.ts +9 -10
  210. package/lib/api/api/shutdown.js +4 -13
  211. package/lib/api/api/shutdown.js.map +1 -1
  212. package/lib/api/api/simulate.d.ts +4 -5
  213. package/lib/api/api/simulate.js +1 -1
  214. package/lib/api/api/simulate.js.map +1 -1
  215. package/lib/api/api/slm.d.ts +36 -37
  216. package/lib/api/api/slm.js +10 -19
  217. package/lib/api/api/slm.js.map +1 -1
  218. package/lib/api/api/snapshot.d.ts +52 -53
  219. package/lib/api/api/snapshot.js +17 -46
  220. package/lib/api/api/snapshot.js.map +1 -1
  221. package/lib/api/api/sql.d.ts +30 -31
  222. package/lib/api/api/sql.js +9 -36
  223. package/lib/api/api/sql.js.map +1 -1
  224. package/lib/api/api/ssl.d.ts +4 -5
  225. package/lib/api/api/ssl.js +1 -1
  226. package/lib/api/api/ssl.js.map +1 -1
  227. package/lib/api/api/synonyms.d.ts +35 -36
  228. package/lib/api/api/synonyms.js +9 -27
  229. package/lib/api/api/synonyms.js.map +1 -1
  230. package/lib/api/api/tasks.d.ts +12 -13
  231. package/lib/api/api/tasks.js +3 -3
  232. package/lib/api/api/tasks.js.map +1 -1
  233. package/lib/api/api/terms_enum.d.ts +4 -5
  234. package/lib/api/api/terms_enum.js +3 -12
  235. package/lib/api/api/terms_enum.js.map +1 -1
  236. package/lib/api/api/termvectors.d.ts +4 -5
  237. package/lib/api/api/termvectors.js +3 -12
  238. package/lib/api/api/termvectors.js.map +1 -1
  239. package/lib/api/api/text_structure.d.ts +16 -17
  240. package/lib/api/api/text_structure.js +6 -17
  241. package/lib/api/api/text_structure.js.map +1 -1
  242. package/lib/api/api/transform.d.ts +48 -49
  243. package/lib/api/api/transform.js +15 -42
  244. package/lib/api/api/transform.js.map +1 -1
  245. package/lib/api/api/update.d.ts +4 -5
  246. package/lib/api/api/update.js +3 -12
  247. package/lib/api/api/update.js.map +1 -1
  248. package/lib/api/api/update_by_query.d.ts +4 -5
  249. package/lib/api/api/update_by_query.js +3 -12
  250. package/lib/api/api/update_by_query.js.map +1 -1
  251. package/lib/api/api/update_by_query_rethrottle.d.ts +4 -5
  252. package/lib/api/api/update_by_query_rethrottle.js +2 -2
  253. package/lib/api/api/update_by_query_rethrottle.js.map +1 -1
  254. package/lib/api/api/watcher.d.ts +52 -53
  255. package/lib/api/api/watcher.js +16 -43
  256. package/lib/api/api/watcher.js.map +1 -1
  257. package/lib/api/api/xpack.d.ts +8 -9
  258. package/lib/api/api/xpack.js +2 -2
  259. package/lib/api/api/xpack.js.map +1 -1
  260. package/lib/api/index.js +1 -1
  261. package/lib/api/index.js.map +1 -1
  262. package/lib/api/types.d.ts +131 -72
  263. package/lib/client.d.ts +82 -2
  264. package/lib/client.js +11 -4
  265. package/lib/client.js.map +1 -1
  266. package/lib/helpers.d.ts +0 -3
  267. package/lib/helpers.js +8 -7
  268. package/lib/helpers.js.map +1 -1
  269. package/package.json +33 -33
  270. package/renovate.json +29 -0
  271. package/lib/api/typesWithBodyKey.d.ts +0 -18163
  272. package/lib/api/typesWithBodyKey.js +0 -21
  273. package/lib/api/typesWithBodyKey.js.map +0 -1
@@ -1,6 +1,5 @@
1
1
  import { Transport, TransportRequestOptions, TransportRequestOptionsWithMeta, TransportRequestOptionsWithOutMeta, TransportResult } from '@elastic/transport';
2
2
  import * as T from '../types';
3
- import * as TB from '../typesWithBodyKey';
4
3
  interface That {
5
4
  transport: Transport;
6
5
  }
@@ -9,185 +8,185 @@ export default class Cat {
9
8
  constructor(transport: Transport);
10
9
  /**
11
10
  * Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
12
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html | Elasticsearch API documentation}
11
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html | Elasticsearch API documentation}
13
12
  */
14
- aliases(this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAliasesResponse>;
15
- aliases(this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAliasesResponse, unknown>>;
16
- aliases(this: That, params?: T.CatAliasesRequest | TB.CatAliasesRequest, options?: TransportRequestOptions): Promise<T.CatAliasesResponse>;
13
+ aliases(this: That, params?: T.CatAliasesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAliasesResponse>;
14
+ aliases(this: That, params?: T.CatAliasesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAliasesResponse, unknown>>;
15
+ aliases(this: That, params?: T.CatAliasesRequest, options?: TransportRequestOptions): Promise<T.CatAliasesResponse>;
17
16
  /**
18
- * Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
19
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html | Elasticsearch API documentation}
17
+ * Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
18
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html | Elasticsearch API documentation}
20
19
  */
21
- allocation(this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAllocationResponse>;
22
- allocation(this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAllocationResponse, unknown>>;
23
- allocation(this: That, params?: T.CatAllocationRequest | TB.CatAllocationRequest, options?: TransportRequestOptions): Promise<T.CatAllocationResponse>;
20
+ allocation(this: That, params?: T.CatAllocationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatAllocationResponse>;
21
+ allocation(this: That, params?: T.CatAllocationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatAllocationResponse, unknown>>;
22
+ allocation(this: That, params?: T.CatAllocationRequest, options?: TransportRequestOptions): Promise<T.CatAllocationResponse>;
24
23
  /**
25
24
  * Get component templates. Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
26
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-component-templates.html | Elasticsearch API documentation}
25
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html | Elasticsearch API documentation}
27
26
  */
28
- componentTemplates(this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatComponentTemplatesResponse>;
29
- componentTemplates(this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatComponentTemplatesResponse, unknown>>;
30
- componentTemplates(this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptions): Promise<T.CatComponentTemplatesResponse>;
27
+ componentTemplates(this: That, params?: T.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatComponentTemplatesResponse>;
28
+ componentTemplates(this: That, params?: T.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatComponentTemplatesResponse, unknown>>;
29
+ componentTemplates(this: That, params?: T.CatComponentTemplatesRequest, options?: TransportRequestOptions): Promise<T.CatComponentTemplatesResponse>;
31
30
  /**
32
31
  * Get a document count. Provides quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
33
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html | Elasticsearch API documentation}
32
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html | Elasticsearch API documentation}
34
33
  */
35
- count(this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatCountResponse>;
36
- count(this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatCountResponse, unknown>>;
37
- count(this: That, params?: T.CatCountRequest | TB.CatCountRequest, options?: TransportRequestOptions): Promise<T.CatCountResponse>;
34
+ count(this: That, params?: T.CatCountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatCountResponse>;
35
+ count(this: That, params?: T.CatCountRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatCountResponse, unknown>>;
36
+ count(this: That, params?: T.CatCountRequest, options?: TransportRequestOptions): Promise<T.CatCountResponse>;
38
37
  /**
39
- * Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
40
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html | Elasticsearch API documentation}
38
+ * Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
39
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html | Elasticsearch API documentation}
41
40
  */
42
- fielddata(this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatFielddataResponse>;
43
- fielddata(this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatFielddataResponse, unknown>>;
44
- fielddata(this: That, params?: T.CatFielddataRequest | TB.CatFielddataRequest, options?: TransportRequestOptions): Promise<T.CatFielddataResponse>;
41
+ fielddata(this: That, params?: T.CatFielddataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatFielddataResponse>;
42
+ fielddata(this: That, params?: T.CatFielddataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatFielddataResponse, unknown>>;
43
+ fielddata(this: That, params?: T.CatFielddataRequest, options?: TransportRequestOptions): Promise<T.CatFielddataResponse>;
45
44
  /**
46
- * Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
47
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html | Elasticsearch API documentation}
45
+ * Get the cluster health status. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
46
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html | Elasticsearch API documentation}
48
47
  */
49
- health(this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHealthResponse>;
50
- health(this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHealthResponse, unknown>>;
51
- health(this: That, params?: T.CatHealthRequest | TB.CatHealthRequest, options?: TransportRequestOptions): Promise<T.CatHealthResponse>;
48
+ health(this: That, params?: T.CatHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHealthResponse>;
49
+ health(this: That, params?: T.CatHealthRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHealthResponse, unknown>>;
50
+ health(this: That, params?: T.CatHealthRequest, options?: TransportRequestOptions): Promise<T.CatHealthResponse>;
52
51
  /**
53
52
  * Get CAT help. Returns help for the CAT APIs.
54
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat.html | Elasticsearch API documentation}
53
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html | Elasticsearch API documentation}
55
54
  */
56
- help(this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHelpResponse>;
57
- help(this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHelpResponse, unknown>>;
58
- help(this: That, params?: T.CatHelpRequest | TB.CatHelpRequest, options?: TransportRequestOptions): Promise<T.CatHelpResponse>;
55
+ help(this: That, params?: T.CatHelpRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatHelpResponse>;
56
+ help(this: That, params?: T.CatHelpRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatHelpResponse, unknown>>;
57
+ help(this: That, params?: T.CatHelpRequest, options?: TransportRequestOptions): Promise<T.CatHelpResponse>;
59
58
  /**
60
59
  * Get index information. Returns high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.
61
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html | Elasticsearch API documentation}
60
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html | Elasticsearch API documentation}
62
61
  */
63
- indices(this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatIndicesResponse>;
64
- indices(this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatIndicesResponse, unknown>>;
65
- indices(this: That, params?: T.CatIndicesRequest | TB.CatIndicesRequest, options?: TransportRequestOptions): Promise<T.CatIndicesResponse>;
62
+ indices(this: That, params?: T.CatIndicesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatIndicesResponse>;
63
+ indices(this: That, params?: T.CatIndicesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatIndicesResponse, unknown>>;
64
+ indices(this: That, params?: T.CatIndicesRequest, options?: TransportRequestOptions): Promise<T.CatIndicesResponse>;
66
65
  /**
67
- * Returns information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
68
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-master.html | Elasticsearch API documentation}
66
+ * Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
67
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html | Elasticsearch API documentation}
69
68
  */
70
- master(this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMasterResponse>;
71
- master(this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMasterResponse, unknown>>;
72
- master(this: That, params?: T.CatMasterRequest | TB.CatMasterRequest, options?: TransportRequestOptions): Promise<T.CatMasterResponse>;
69
+ master(this: That, params?: T.CatMasterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMasterResponse>;
70
+ master(this: That, params?: T.CatMasterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMasterResponse, unknown>>;
71
+ master(this: That, params?: T.CatMasterRequest, options?: TransportRequestOptions): Promise<T.CatMasterResponse>;
73
72
  /**
74
73
  * Get data frame analytics jobs. Returns configuration and usage information about data frame analytics jobs. 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 data frame analytics jobs statistics API.
75
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html | Elasticsearch API documentation}
74
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html | Elasticsearch API documentation}
76
75
  */
77
- mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDataFrameAnalyticsResponse>;
78
- mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDataFrameAnalyticsResponse, unknown>>;
79
- mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest | TB.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.CatMlDataFrameAnalyticsResponse>;
76
+ mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDataFrameAnalyticsResponse>;
77
+ mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDataFrameAnalyticsResponse, unknown>>;
78
+ mlDataFrameAnalytics(this: That, params?: T.CatMlDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.CatMlDataFrameAnalyticsResponse>;
80
79
  /**
81
80
  * 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.
82
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html | Elasticsearch API documentation}
81
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html | Elasticsearch API documentation}
83
82
  */
84
- mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDatafeedsResponse>;
85
- mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDatafeedsResponse, unknown>>;
86
- mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest | TB.CatMlDatafeedsRequest, options?: TransportRequestOptions): Promise<T.CatMlDatafeedsResponse>;
83
+ mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlDatafeedsResponse>;
84
+ mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlDatafeedsResponse, unknown>>;
85
+ mlDatafeeds(this: That, params?: T.CatMlDatafeedsRequest, options?: TransportRequestOptions): Promise<T.CatMlDatafeedsResponse>;
87
86
  /**
88
87
  * Get anomaly detection jobs. Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. 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 anomaly detection job statistics API.
89
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html | Elasticsearch API documentation}
88
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html | Elasticsearch API documentation}
90
89
  */
91
- mlJobs(this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlJobsResponse>;
92
- mlJobs(this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlJobsResponse, unknown>>;
93
- mlJobs(this: That, params?: T.CatMlJobsRequest | TB.CatMlJobsRequest, options?: TransportRequestOptions): Promise<T.CatMlJobsResponse>;
90
+ mlJobs(this: That, params?: T.CatMlJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlJobsResponse>;
91
+ mlJobs(this: That, params?: T.CatMlJobsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlJobsResponse, unknown>>;
92
+ mlJobs(this: That, params?: T.CatMlJobsRequest, options?: TransportRequestOptions): Promise<T.CatMlJobsResponse>;
94
93
  /**
95
94
  * Get trained models. Returns configuration and usage information about inference trained models. 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 trained models statistics API.
96
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html | Elasticsearch API documentation}
95
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html | Elasticsearch API documentation}
97
96
  */
98
- mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlTrainedModelsResponse>;
99
- mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlTrainedModelsResponse, unknown>>;
100
- mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest | TB.CatMlTrainedModelsRequest, options?: TransportRequestOptions): Promise<T.CatMlTrainedModelsResponse>;
97
+ mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatMlTrainedModelsResponse>;
98
+ mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatMlTrainedModelsResponse, unknown>>;
99
+ mlTrainedModels(this: That, params?: T.CatMlTrainedModelsRequest, options?: TransportRequestOptions): Promise<T.CatMlTrainedModelsResponse>;
101
100
  /**
102
- * Returns information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
103
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodeattrs.html | Elasticsearch API documentation}
101
+ * Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
102
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html | Elasticsearch API documentation}
104
103
  */
105
- nodeattrs(this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodeattrsResponse>;
106
- nodeattrs(this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodeattrsResponse, unknown>>;
107
- nodeattrs(this: That, params?: T.CatNodeattrsRequest | TB.CatNodeattrsRequest, options?: TransportRequestOptions): Promise<T.CatNodeattrsResponse>;
104
+ nodeattrs(this: That, params?: T.CatNodeattrsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodeattrsResponse>;
105
+ nodeattrs(this: That, params?: T.CatNodeattrsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodeattrsResponse, unknown>>;
106
+ nodeattrs(this: That, params?: T.CatNodeattrsRequest, options?: TransportRequestOptions): Promise<T.CatNodeattrsResponse>;
108
107
  /**
109
- * Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
110
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html | Elasticsearch API documentation}
108
+ * Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
109
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html | Elasticsearch API documentation}
111
110
  */
112
- nodes(this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodesResponse>;
113
- nodes(this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodesResponse, unknown>>;
114
- nodes(this: That, params?: T.CatNodesRequest | TB.CatNodesRequest, options?: TransportRequestOptions): Promise<T.CatNodesResponse>;
111
+ nodes(this: That, params?: T.CatNodesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatNodesResponse>;
112
+ nodes(this: That, params?: T.CatNodesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatNodesResponse, unknown>>;
113
+ nodes(this: That, params?: T.CatNodesRequest, options?: TransportRequestOptions): Promise<T.CatNodesResponse>;
115
114
  /**
116
- * Returns cluster-level changes that have not yet been executed. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
117
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-pending-tasks.html | Elasticsearch API documentation}
115
+ * Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
116
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html | Elasticsearch API documentation}
118
117
  */
119
- pendingTasks(this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPendingTasksResponse>;
120
- pendingTasks(this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPendingTasksResponse, unknown>>;
121
- pendingTasks(this: That, params?: T.CatPendingTasksRequest | TB.CatPendingTasksRequest, options?: TransportRequestOptions): Promise<T.CatPendingTasksResponse>;
118
+ pendingTasks(this: That, params?: T.CatPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPendingTasksResponse>;
119
+ pendingTasks(this: That, params?: T.CatPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPendingTasksResponse, unknown>>;
120
+ pendingTasks(this: That, params?: T.CatPendingTasksRequest, options?: TransportRequestOptions): Promise<T.CatPendingTasksResponse>;
122
121
  /**
123
- * Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
124
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-plugins.html | Elasticsearch API documentation}
122
+ * Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
123
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html | Elasticsearch API documentation}
125
124
  */
126
- plugins(this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPluginsResponse>;
127
- plugins(this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPluginsResponse, unknown>>;
128
- plugins(this: That, params?: T.CatPluginsRequest | TB.CatPluginsRequest, options?: TransportRequestOptions): Promise<T.CatPluginsResponse>;
125
+ plugins(this: That, params?: T.CatPluginsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatPluginsResponse>;
126
+ plugins(this: That, params?: T.CatPluginsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatPluginsResponse, unknown>>;
127
+ plugins(this: That, params?: T.CatPluginsRequest, options?: TransportRequestOptions): Promise<T.CatPluginsResponse>;
129
128
  /**
130
- * Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
131
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html | Elasticsearch API documentation}
129
+ * Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
130
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html | Elasticsearch API documentation}
132
131
  */
133
- recovery(this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRecoveryResponse>;
134
- recovery(this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRecoveryResponse, unknown>>;
135
- recovery(this: That, params?: T.CatRecoveryRequest | TB.CatRecoveryRequest, options?: TransportRequestOptions): Promise<T.CatRecoveryResponse>;
132
+ recovery(this: That, params?: T.CatRecoveryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRecoveryResponse>;
133
+ recovery(this: That, params?: T.CatRecoveryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRecoveryResponse, unknown>>;
134
+ recovery(this: That, params?: T.CatRecoveryRequest, options?: TransportRequestOptions): Promise<T.CatRecoveryResponse>;
136
135
  /**
137
- * Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
138
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-repositories.html | Elasticsearch API documentation}
136
+ * Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
137
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html | Elasticsearch API documentation}
139
138
  */
140
- repositories(this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRepositoriesResponse>;
141
- repositories(this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRepositoriesResponse, unknown>>;
142
- repositories(this: That, params?: T.CatRepositoriesRequest | TB.CatRepositoriesRequest, options?: TransportRequestOptions): Promise<T.CatRepositoriesResponse>;
139
+ repositories(this: That, params?: T.CatRepositoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatRepositoriesResponse>;
140
+ repositories(this: That, params?: T.CatRepositoriesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatRepositoriesResponse, unknown>>;
141
+ repositories(this: That, params?: T.CatRepositoriesRequest, options?: TransportRequestOptions): Promise<T.CatRepositoriesResponse>;
143
142
  /**
144
- * Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
145
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html | Elasticsearch API documentation}
143
+ * Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
144
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html | Elasticsearch API documentation}
146
145
  */
147
- segments(this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSegmentsResponse>;
148
- segments(this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSegmentsResponse, unknown>>;
149
- segments(this: That, params?: T.CatSegmentsRequest | TB.CatSegmentsRequest, options?: TransportRequestOptions): Promise<T.CatSegmentsResponse>;
146
+ segments(this: That, params?: T.CatSegmentsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSegmentsResponse>;
147
+ segments(this: That, params?: T.CatSegmentsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSegmentsResponse, unknown>>;
148
+ segments(this: That, params?: T.CatSegmentsRequest, options?: TransportRequestOptions): Promise<T.CatSegmentsResponse>;
150
149
  /**
151
- * Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
152
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html | Elasticsearch API documentation}
150
+ * Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
151
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html | Elasticsearch API documentation}
153
152
  */
154
- shards(this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatShardsResponse>;
155
- shards(this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatShardsResponse, unknown>>;
156
- shards(this: That, params?: T.CatShardsRequest | TB.CatShardsRequest, options?: TransportRequestOptions): Promise<T.CatShardsResponse>;
153
+ shards(this: That, params?: T.CatShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatShardsResponse>;
154
+ shards(this: That, params?: T.CatShardsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatShardsResponse, unknown>>;
155
+ shards(this: That, params?: T.CatShardsRequest, options?: TransportRequestOptions): Promise<T.CatShardsResponse>;
157
156
  /**
158
- * Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
159
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html | Elasticsearch API documentation}
157
+ * Get snapshot information Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
158
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html | Elasticsearch API documentation}
160
159
  */
161
- snapshots(this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSnapshotsResponse>;
162
- snapshots(this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSnapshotsResponse, unknown>>;
163
- snapshots(this: That, params?: T.CatSnapshotsRequest | TB.CatSnapshotsRequest, options?: TransportRequestOptions): Promise<T.CatSnapshotsResponse>;
160
+ snapshots(this: That, params?: T.CatSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatSnapshotsResponse>;
161
+ snapshots(this: That, params?: T.CatSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatSnapshotsResponse, unknown>>;
162
+ snapshots(this: That, params?: T.CatSnapshotsRequest, options?: TransportRequestOptions): Promise<T.CatSnapshotsResponse>;
164
163
  /**
165
- * Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
166
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html | Elasticsearch API documentation}
164
+ * Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
165
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html | Elasticsearch API documentation}
167
166
  */
168
- tasks(this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTasksResponse>;
169
- tasks(this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTasksResponse, unknown>>;
170
- tasks(this: That, params?: T.CatTasksRequest | TB.CatTasksRequest, options?: TransportRequestOptions): Promise<T.CatTasksResponse>;
167
+ tasks(this: That, params?: T.CatTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTasksResponse>;
168
+ tasks(this: That, params?: T.CatTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTasksResponse, unknown>>;
169
+ tasks(this: That, params?: T.CatTasksRequest, options?: TransportRequestOptions): Promise<T.CatTasksResponse>;
171
170
  /**
172
- * Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
173
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html | Elasticsearch API documentation}
171
+ * Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
172
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html | Elasticsearch API documentation}
174
173
  */
175
- templates(this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTemplatesResponse>;
176
- templates(this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTemplatesResponse, unknown>>;
177
- templates(this: That, params?: T.CatTemplatesRequest | TB.CatTemplatesRequest, options?: TransportRequestOptions): Promise<T.CatTemplatesResponse>;
174
+ templates(this: That, params?: T.CatTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTemplatesResponse>;
175
+ templates(this: That, params?: T.CatTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTemplatesResponse, unknown>>;
176
+ templates(this: That, params?: T.CatTemplatesRequest, options?: TransportRequestOptions): Promise<T.CatTemplatesResponse>;
178
177
  /**
179
- * Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
180
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html | Elasticsearch API documentation}
178
+ * Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
179
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html | Elasticsearch API documentation}
181
180
  */
182
- threadPool(this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatThreadPoolResponse>;
183
- threadPool(this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatThreadPoolResponse, unknown>>;
184
- threadPool(this: That, params?: T.CatThreadPoolRequest | TB.CatThreadPoolRequest, options?: TransportRequestOptions): Promise<T.CatThreadPoolResponse>;
181
+ threadPool(this: That, params?: T.CatThreadPoolRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatThreadPoolResponse>;
182
+ threadPool(this: That, params?: T.CatThreadPoolRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatThreadPoolResponse, unknown>>;
183
+ threadPool(this: That, params?: T.CatThreadPoolRequest, options?: TransportRequestOptions): Promise<T.CatThreadPoolResponse>;
185
184
  /**
186
- * Get transforms. Returns configuration and usage information about transforms. 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 transform statistics API.
187
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html | Elasticsearch API documentation}
185
+ * Get transform information. Get configuration and usage information about transforms. 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 transform statistics API.
186
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html | Elasticsearch API documentation}
188
187
  */
189
- transforms(this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTransformsResponse>;
190
- transforms(this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTransformsResponse, unknown>>;
191
- transforms(this: That, params?: T.CatTransformsRequest | TB.CatTransformsRequest, options?: TransportRequestOptions): Promise<T.CatTransformsResponse>;
188
+ transforms(this: That, params?: T.CatTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatTransformsResponse>;
189
+ transforms(this: That, params?: T.CatTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatTransformsResponse, unknown>>;
190
+ transforms(this: That, params?: T.CatTransformsRequest, options?: TransportRequestOptions): Promise<T.CatTransformsResponse>;
192
191
  }
193
192
  export {};
@@ -37,7 +37,7 @@ class Cat {
37
37
  if (acceptedPath.includes(key)) {
38
38
  continue;
39
39
  }
40
- else if (key !== 'body') {
40
+ else {
41
41
  // @ts-expect-error
42
42
  querystring[key] = params[key];
43
43
  }
@@ -69,7 +69,7 @@ class Cat {
69
69
  if (acceptedPath.includes(key)) {
70
70
  continue;
71
71
  }
72
- else if (key !== 'body') {
72
+ else {
73
73
  // @ts-expect-error
74
74
  querystring[key] = params[key];
75
75
  }
@@ -101,7 +101,7 @@ class Cat {
101
101
  if (acceptedPath.includes(key)) {
102
102
  continue;
103
103
  }
104
- else if (key !== 'body') {
104
+ else {
105
105
  // @ts-expect-error
106
106
  querystring[key] = params[key];
107
107
  }
@@ -133,7 +133,7 @@ class Cat {
133
133
  if (acceptedPath.includes(key)) {
134
134
  continue;
135
135
  }
136
- else if (key !== 'body') {
136
+ else {
137
137
  // @ts-expect-error
138
138
  querystring[key] = params[key];
139
139
  }
@@ -165,7 +165,7 @@ class Cat {
165
165
  if (acceptedPath.includes(key)) {
166
166
  continue;
167
167
  }
168
- else if (key !== 'body') {
168
+ else {
169
169
  // @ts-expect-error
170
170
  querystring[key] = params[key];
171
171
  }
@@ -197,7 +197,7 @@ class Cat {
197
197
  if (acceptedPath.includes(key)) {
198
198
  continue;
199
199
  }
200
- else if (key !== 'body') {
200
+ else {
201
201
  // @ts-expect-error
202
202
  querystring[key] = params[key];
203
203
  }
@@ -218,7 +218,7 @@ class Cat {
218
218
  if (acceptedPath.includes(key)) {
219
219
  continue;
220
220
  }
221
- else if (key !== 'body') {
221
+ else {
222
222
  // @ts-expect-error
223
223
  querystring[key] = params[key];
224
224
  }
@@ -239,7 +239,7 @@ class Cat {
239
239
  if (acceptedPath.includes(key)) {
240
240
  continue;
241
241
  }
242
- else if (key !== 'body') {
242
+ else {
243
243
  // @ts-expect-error
244
244
  querystring[key] = params[key];
245
245
  }
@@ -271,7 +271,7 @@ class Cat {
271
271
  if (acceptedPath.includes(key)) {
272
272
  continue;
273
273
  }
274
- else if (key !== 'body') {
274
+ else {
275
275
  // @ts-expect-error
276
276
  querystring[key] = params[key];
277
277
  }
@@ -292,7 +292,7 @@ class Cat {
292
292
  if (acceptedPath.includes(key)) {
293
293
  continue;
294
294
  }
295
- else if (key !== 'body') {
295
+ else {
296
296
  // @ts-expect-error
297
297
  querystring[key] = params[key];
298
298
  }
@@ -324,7 +324,7 @@ class Cat {
324
324
  if (acceptedPath.includes(key)) {
325
325
  continue;
326
326
  }
327
- else if (key !== 'body') {
327
+ else {
328
328
  // @ts-expect-error
329
329
  querystring[key] = params[key];
330
330
  }
@@ -356,7 +356,7 @@ class Cat {
356
356
  if (acceptedPath.includes(key)) {
357
357
  continue;
358
358
  }
359
- else if (key !== 'body') {
359
+ else {
360
360
  // @ts-expect-error
361
361
  querystring[key] = params[key];
362
362
  }
@@ -388,7 +388,7 @@ class Cat {
388
388
  if (acceptedPath.includes(key)) {
389
389
  continue;
390
390
  }
391
- else if (key !== 'body') {
391
+ else {
392
392
  // @ts-expect-error
393
393
  querystring[key] = params[key];
394
394
  }
@@ -420,7 +420,7 @@ class Cat {
420
420
  if (acceptedPath.includes(key)) {
421
421
  continue;
422
422
  }
423
- else if (key !== 'body') {
423
+ else {
424
424
  // @ts-expect-error
425
425
  querystring[key] = params[key];
426
426
  }
@@ -441,7 +441,7 @@ class Cat {
441
441
  if (acceptedPath.includes(key)) {
442
442
  continue;
443
443
  }
444
- else if (key !== 'body') {
444
+ else {
445
445
  // @ts-expect-error
446
446
  querystring[key] = params[key];
447
447
  }
@@ -462,7 +462,7 @@ class Cat {
462
462
  if (acceptedPath.includes(key)) {
463
463
  continue;
464
464
  }
465
- else if (key !== 'body') {
465
+ else {
466
466
  // @ts-expect-error
467
467
  querystring[key] = params[key];
468
468
  }
@@ -483,7 +483,7 @@ class Cat {
483
483
  if (acceptedPath.includes(key)) {
484
484
  continue;
485
485
  }
486
- else if (key !== 'body') {
486
+ else {
487
487
  // @ts-expect-error
488
488
  querystring[key] = params[key];
489
489
  }
@@ -504,7 +504,7 @@ class Cat {
504
504
  if (acceptedPath.includes(key)) {
505
505
  continue;
506
506
  }
507
- else if (key !== 'body') {
507
+ else {
508
508
  // @ts-expect-error
509
509
  querystring[key] = params[key];
510
510
  }
@@ -536,7 +536,7 @@ class Cat {
536
536
  if (acceptedPath.includes(key)) {
537
537
  continue;
538
538
  }
539
- else if (key !== 'body') {
539
+ else {
540
540
  // @ts-expect-error
541
541
  querystring[key] = params[key];
542
542
  }
@@ -557,7 +557,7 @@ class Cat {
557
557
  if (acceptedPath.includes(key)) {
558
558
  continue;
559
559
  }
560
- else if (key !== 'body') {
560
+ else {
561
561
  // @ts-expect-error
562
562
  querystring[key] = params[key];
563
563
  }
@@ -589,7 +589,7 @@ class Cat {
589
589
  if (acceptedPath.includes(key)) {
590
590
  continue;
591
591
  }
592
- else if (key !== 'body') {
592
+ else {
593
593
  // @ts-expect-error
594
594
  querystring[key] = params[key];
595
595
  }
@@ -621,7 +621,7 @@ class Cat {
621
621
  if (acceptedPath.includes(key)) {
622
622
  continue;
623
623
  }
624
- else if (key !== 'body') {
624
+ else {
625
625
  // @ts-expect-error
626
626
  querystring[key] = params[key];
627
627
  }
@@ -653,7 +653,7 @@ class Cat {
653
653
  if (acceptedPath.includes(key)) {
654
654
  continue;
655
655
  }
656
- else if (key !== 'body') {
656
+ else {
657
657
  // @ts-expect-error
658
658
  querystring[key] = params[key];
659
659
  }
@@ -674,7 +674,7 @@ class Cat {
674
674
  if (acceptedPath.includes(key)) {
675
675
  continue;
676
676
  }
677
- else if (key !== 'body') {
677
+ else {
678
678
  // @ts-expect-error
679
679
  querystring[key] = params[key];
680
680
  }
@@ -706,7 +706,7 @@ class Cat {
706
706
  if (acceptedPath.includes(key)) {
707
707
  continue;
708
708
  }
709
- else if (key !== 'body') {
709
+ else {
710
710
  // @ts-expect-error
711
711
  querystring[key] = params[key];
712
712
  }
@@ -738,7 +738,7 @@ class Cat {
738
738
  if (acceptedPath.includes(key)) {
739
739
  continue;
740
740
  }
741
- else if (key !== 'body') {
741
+ else {
742
742
  // @ts-expect-error
743
743
  querystring[key] = params[key];
744
744
  }