elasticsearch-api 9.0.3 → 9.1.0

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 (533) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/lib/elasticsearch/api/actions/async_search/delete.rb +14 -3
  4. data/lib/elasticsearch/api/actions/async_search/get.rb +13 -2
  5. data/lib/elasticsearch/api/actions/async_search/status.rb +13 -2
  6. data/lib/elasticsearch/api/actions/async_search/submit.rb +17 -6
  7. data/lib/elasticsearch/api/actions/bulk.rb +86 -63
  8. data/lib/elasticsearch/api/actions/cat/aliases.rb +20 -9
  9. data/lib/elasticsearch/api/actions/cat/allocation.rb +19 -8
  10. data/lib/elasticsearch/api/actions/cat/component_templates.rb +19 -8
  11. data/lib/elasticsearch/api/actions/cat/count.rb +19 -8
  12. data/lib/elasticsearch/api/actions/cat/fielddata.rb +17 -6
  13. data/lib/elasticsearch/api/actions/cat/health.rb +20 -9
  14. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  15. data/lib/elasticsearch/api/actions/cat/indices.rb +18 -7
  16. data/lib/elasticsearch/api/actions/cat/master.rb +19 -8
  17. data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +16 -5
  18. data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +19 -8
  19. data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +20 -9
  20. data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +18 -7
  21. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +19 -8
  22. data/lib/elasticsearch/api/actions/cat/nodes.rb +23 -11
  23. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +19 -8
  24. data/lib/elasticsearch/api/actions/cat/plugins.rb +19 -8
  25. data/lib/elasticsearch/api/actions/cat/recovery.rb +24 -12
  26. data/lib/elasticsearch/api/actions/cat/repositories.rb +19 -8
  27. data/lib/elasticsearch/api/actions/cat/segments.rb +24 -12
  28. data/lib/elasticsearch/api/actions/cat/shards.rb +22 -11
  29. data/lib/elasticsearch/api/actions/cat/snapshots.rb +21 -9
  30. data/lib/elasticsearch/api/actions/cat/tasks.rb +19 -8
  31. data/lib/elasticsearch/api/actions/cat/templates.rb +19 -8
  32. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +21 -10
  33. data/lib/elasticsearch/api/actions/cat/transforms.rb +18 -7
  34. data/lib/elasticsearch/api/actions/clear_scroll.rb +13 -2
  35. data/lib/elasticsearch/api/actions/close_point_in_time.rb +15 -4
  36. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +13 -1
  37. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +12 -1
  38. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +12 -1
  39. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +12 -1
  40. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +17 -5
  41. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +14 -3
  42. data/lib/elasticsearch/api/actions/cluster/health.rb +13 -2
  43. data/lib/elasticsearch/api/actions/cluster/info.rb +13 -2
  44. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +14 -3
  45. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +16 -5
  46. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +20 -8
  47. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +17 -6
  48. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +13 -2
  49. data/lib/elasticsearch/api/actions/cluster/reroute.rb +16 -5
  50. data/lib/elasticsearch/api/actions/cluster/state.rb +15 -4
  51. data/lib/elasticsearch/api/actions/cluster/stats.rb +13 -2
  52. data/lib/elasticsearch/api/actions/connector/check_in.rb +14 -3
  53. data/lib/elasticsearch/api/actions/connector/delete.rb +12 -1
  54. data/lib/elasticsearch/api/actions/connector/get.rb +12 -1
  55. data/lib/elasticsearch/api/actions/connector/list.rb +12 -1
  56. data/lib/elasticsearch/api/actions/connector/post.rb +13 -2
  57. data/lib/elasticsearch/api/actions/connector/put.rb +13 -2
  58. data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +14 -3
  59. data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +14 -3
  60. data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +15 -4
  61. data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +13 -2
  62. data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +14 -3
  63. data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +13 -2
  64. data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +13 -2
  65. data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +13 -2
  66. data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +15 -4
  67. data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +13 -2
  68. data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +14 -3
  69. data/lib/elasticsearch/api/actions/connector/update_configuration.rb +13 -2
  70. data/lib/elasticsearch/api/actions/connector/update_error.rb +13 -2
  71. data/lib/elasticsearch/api/actions/connector/update_features.rb +13 -2
  72. data/lib/elasticsearch/api/actions/connector/update_filtering.rb +13 -2
  73. data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +13 -2
  74. data/lib/elasticsearch/api/actions/connector/update_index_name.rb +14 -3
  75. data/lib/elasticsearch/api/actions/connector/update_name.rb +13 -2
  76. data/lib/elasticsearch/api/actions/connector/update_native.rb +13 -2
  77. data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +13 -2
  78. data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +13 -2
  79. data/lib/elasticsearch/api/actions/connector/update_service_type.rb +13 -2
  80. data/lib/elasticsearch/api/actions/connector/update_status.rb +13 -2
  81. data/lib/elasticsearch/api/actions/count.rb +29 -18
  82. data/lib/elasticsearch/api/actions/create.rb +44 -41
  83. data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +13 -2
  84. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +12 -1
  85. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +13 -2
  86. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +12 -1
  87. data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +12 -1
  88. data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +13 -2
  89. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +13 -2
  90. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +13 -2
  91. data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +12 -1
  92. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +13 -2
  93. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +12 -1
  94. data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +13 -2
  95. data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +13 -2
  96. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +13 -2
  97. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +13 -2
  98. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -3
  99. data/lib/elasticsearch/api/actions/delete.rb +25 -12
  100. data/lib/elasticsearch/api/actions/delete_by_query.rb +63 -48
  101. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +14 -3
  102. data/lib/elasticsearch/api/actions/delete_script.rb +14 -3
  103. data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +12 -1
  104. data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +13 -2
  105. data/lib/elasticsearch/api/actions/enrich/get_policy.rb +12 -1
  106. data/lib/elasticsearch/api/actions/enrich/put_policy.rb +12 -1
  107. data/lib/elasticsearch/api/actions/enrich/stats.rb +12 -1
  108. data/lib/elasticsearch/api/actions/eql/delete.rb +14 -3
  109. data/lib/elasticsearch/api/actions/eql/get.rb +12 -1
  110. data/lib/elasticsearch/api/actions/eql/get_status.rb +13 -2
  111. data/lib/elasticsearch/api/actions/eql/search.rb +15 -3
  112. data/lib/elasticsearch/api/actions/esql/async_query.rb +17 -14
  113. data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +15 -4
  114. data/lib/elasticsearch/api/actions/esql/async_query_get.rb +17 -5
  115. data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +15 -4
  116. data/lib/elasticsearch/api/actions/esql/get_query.rb +76 -0
  117. data/lib/elasticsearch/api/actions/esql/list_queries.rb +66 -0
  118. data/lib/elasticsearch/api/actions/esql/query.rb +15 -2
  119. data/lib/elasticsearch/api/actions/exists.rb +31 -18
  120. data/lib/elasticsearch/api/actions/exists_source.rb +21 -8
  121. data/lib/elasticsearch/api/actions/explain.rb +25 -14
  122. data/lib/elasticsearch/api/actions/features/get_features.rb +13 -2
  123. data/lib/elasticsearch/api/actions/features/reset_features.rb +12 -1
  124. data/lib/elasticsearch/api/actions/field_caps.rb +18 -7
  125. data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +17 -6
  126. data/lib/elasticsearch/api/actions/fleet/msearch.rb +15 -4
  127. data/lib/elasticsearch/api/actions/fleet/search.rb +15 -4
  128. data/lib/elasticsearch/api/actions/get.rb +48 -29
  129. data/lib/elasticsearch/api/actions/get_script.rb +13 -2
  130. data/lib/elasticsearch/api/actions/get_script_context.rb +13 -2
  131. data/lib/elasticsearch/api/actions/get_script_languages.rb +13 -2
  132. data/lib/elasticsearch/api/actions/get_source.rb +24 -11
  133. data/lib/elasticsearch/api/actions/graph/explore.rb +13 -2
  134. data/lib/elasticsearch/api/actions/health_report.rb +13 -2
  135. data/lib/elasticsearch/api/actions/index.rb +55 -43
  136. data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +12 -1
  137. data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +14 -3
  138. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +12 -1
  139. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +13 -2
  140. data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +14 -3
  141. data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +14 -3
  142. data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +12 -1
  143. data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +13 -2
  144. data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +13 -2
  145. data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +12 -1
  146. data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +12 -1
  147. data/lib/elasticsearch/api/actions/indices/add_block.rb +20 -9
  148. data/lib/elasticsearch/api/actions/indices/analyze.rb +15 -4
  149. data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +13 -2
  150. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +24 -14
  151. data/lib/elasticsearch/api/actions/indices/clone.rb +17 -6
  152. data/lib/elasticsearch/api/actions/indices/close.rb +19 -9
  153. data/lib/elasticsearch/api/actions/indices/create.rb +24 -13
  154. data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +15 -4
  155. data/lib/elasticsearch/api/actions/indices/create_from.rb +13 -2
  156. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +15 -4
  157. data/lib/elasticsearch/api/actions/indices/delete.rb +17 -7
  158. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +14 -3
  159. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +13 -2
  160. data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +14 -3
  161. data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +75 -0
  162. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +12 -1
  163. data/lib/elasticsearch/api/actions/indices/delete_template.rb +14 -2
  164. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +21 -10
  165. data/lib/elasticsearch/api/actions/indices/downsample.rb +15 -4
  166. data/lib/elasticsearch/api/actions/indices/exists.rb +19 -9
  167. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +18 -8
  168. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +12 -1
  169. data/lib/elasticsearch/api/actions/indices/exists_template.rb +14 -3
  170. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +12 -1
  171. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +16 -5
  172. data/lib/elasticsearch/api/actions/indices/flush.rb +20 -10
  173. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +23 -11
  174. data/lib/elasticsearch/api/actions/indices/get.rb +12 -1
  175. data/lib/elasticsearch/api/actions/indices/get_alias.rb +19 -9
  176. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +16 -6
  177. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +13 -2
  178. data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +14 -3
  179. data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +77 -0
  180. data/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb +75 -0
  181. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -10
  182. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +12 -1
  183. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +18 -8
  184. data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +13 -2
  185. data/lib/elasticsearch/api/actions/indices/get_settings.rb +24 -13
  186. data/lib/elasticsearch/api/actions/indices/get_template.rb +17 -6
  187. data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +13 -2
  188. data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +13 -2
  189. data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +13 -2
  190. data/lib/elasticsearch/api/actions/indices/open.rb +23 -13
  191. data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +12 -1
  192. data/lib/elasticsearch/api/actions/indices/put_alias.rb +13 -2
  193. data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +15 -5
  194. data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +82 -0
  195. data/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb +85 -0
  196. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +17 -6
  197. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +26 -25
  198. data/lib/elasticsearch/api/actions/indices/put_settings.rb +66 -14
  199. data/lib/elasticsearch/api/actions/indices/put_template.rb +14 -3
  200. data/lib/elasticsearch/api/actions/indices/recovery.rb +22 -5
  201. data/lib/elasticsearch/api/actions/indices/refresh.rb +19 -9
  202. data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +15 -4
  203. data/lib/elasticsearch/api/actions/indices/remove_block.rb +93 -0
  204. data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +35 -25
  205. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +17 -7
  206. data/lib/elasticsearch/api/actions/indices/rollover.rb +22 -11
  207. data/lib/elasticsearch/api/actions/indices/segments.rb +17 -7
  208. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +13 -2
  209. data/lib/elasticsearch/api/actions/indices/shrink.rb +14 -3
  210. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +12 -1
  211. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +12 -1
  212. data/lib/elasticsearch/api/actions/indices/split.rb +19 -6
  213. data/lib/elasticsearch/api/actions/indices/stats.rb +19 -8
  214. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +12 -1
  215. data/lib/elasticsearch/api/actions/indices/validate_query.rb +25 -15
  216. data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +18 -1
  217. data/lib/elasticsearch/api/actions/inference/completion.rb +12 -1
  218. data/lib/elasticsearch/api/actions/inference/delete.rb +12 -1
  219. data/lib/elasticsearch/api/actions/inference/get.rb +13 -2
  220. data/lib/elasticsearch/api/actions/inference/inference.rb +12 -1
  221. data/lib/elasticsearch/api/actions/inference/put.rb +33 -8
  222. data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +15 -8
  223. data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +15 -3
  224. data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +16 -9
  225. data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +15 -8
  226. data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +16 -9
  227. data/lib/elasticsearch/api/actions/inference/put_cohere.rb +15 -8
  228. data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
  229. data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +82 -0
  230. data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +16 -4
  231. data/lib/elasticsearch/api/actions/inference/put_elser.rb +15 -3
  232. data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +15 -8
  233. data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +15 -8
  234. data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +43 -19
  235. data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +17 -10
  236. data/lib/elasticsearch/api/actions/inference/put_mistral.rb +16 -10
  237. data/lib/elasticsearch/api/actions/inference/put_openai.rb +16 -9
  238. data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +15 -3
  239. data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +17 -11
  240. data/lib/elasticsearch/api/actions/inference/rerank.rb +13 -2
  241. data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +12 -1
  242. data/lib/elasticsearch/api/actions/inference/stream_completion.rb +15 -3
  243. data/lib/elasticsearch/api/actions/inference/text_embedding.rb +12 -1
  244. data/lib/elasticsearch/api/actions/inference/update.rb +14 -3
  245. data/lib/elasticsearch/api/actions/info.rb +14 -2
  246. data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +12 -1
  247. data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +14 -3
  248. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +13 -2
  249. data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
  250. data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +15 -4
  251. data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +14 -6
  252. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +14 -3
  253. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
  254. data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +12 -1
  255. data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +14 -3
  256. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
  257. data/lib/elasticsearch/api/actions/ingest/simulate.rb +14 -3
  258. data/lib/elasticsearch/api/actions/license/delete.rb +12 -1
  259. data/lib/elasticsearch/api/actions/license/get.rb +14 -3
  260. data/lib/elasticsearch/api/actions/license/get_basic_status.rb +13 -2
  261. data/lib/elasticsearch/api/actions/license/get_trial_status.rb +13 -2
  262. data/lib/elasticsearch/api/actions/license/post.rb +12 -1
  263. data/lib/elasticsearch/api/actions/license/post_start_basic.rb +13 -2
  264. data/lib/elasticsearch/api/actions/license/post_start_trial.rb +13 -2
  265. data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +13 -2
  266. data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +13 -2
  267. data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +13 -2
  268. data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +13 -2
  269. data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +16 -5
  270. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +13 -2
  271. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +13 -2
  272. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +13 -2
  273. data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +13 -2
  274. data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +12 -1
  275. data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +14 -3
  276. data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +13 -2
  277. data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +15 -4
  278. data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +12 -1
  279. data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +14 -3
  280. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +12 -1
  281. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +14 -3
  282. data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +13 -2
  283. data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +13 -2
  284. data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +13 -2
  285. data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +14 -3
  286. data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +14 -3
  287. data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +16 -5
  288. data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +14 -3
  289. data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +13 -2
  290. data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +12 -1
  291. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +14 -3
  292. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +14 -3
  293. data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +19 -8
  294. data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +18 -7
  295. data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +12 -1
  296. data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +14 -3
  297. data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
  298. data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +15 -4
  299. data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +14 -3
  300. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +14 -3
  301. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +14 -3
  302. data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +31 -20
  303. data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +13 -2
  304. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +13 -2
  305. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +12 -1
  306. data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +12 -1
  307. data/lib/elasticsearch/api/actions/machine_learning/info.rb +13 -2
  308. data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +12 -1
  309. data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +13 -2
  310. data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +12 -1
  311. data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +13 -2
  312. data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +12 -1
  313. data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +13 -2
  314. data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +13 -2
  315. data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +14 -3
  316. data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +25 -6
  317. data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +14 -3
  318. data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +19 -13
  319. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +13 -2
  320. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +12 -1
  321. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +14 -3
  322. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +14 -3
  323. data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +12 -1
  324. data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +13 -2
  325. data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +13 -2
  326. data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +13 -2
  327. data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +19 -8
  328. data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +14 -3
  329. data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +12 -1
  330. data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +17 -6
  331. data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +14 -3
  332. data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
  333. data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +17 -11
  334. data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +13 -2
  335. data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +13 -2
  336. data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +13 -2
  337. data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +12 -1
  338. data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +12 -1
  339. data/lib/elasticsearch/api/actions/mget.rb +25 -14
  340. data/lib/elasticsearch/api/actions/migration/deprecations.rb +13 -2
  341. data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +13 -2
  342. data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +13 -2
  343. data/lib/elasticsearch/api/actions/msearch.rb +28 -11
  344. data/lib/elasticsearch/api/actions/msearch_template.rb +22 -10
  345. data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -10
  346. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +14 -3
  347. data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +13 -2
  348. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +12 -1
  349. data/lib/elasticsearch/api/actions/nodes/info.rb +12 -1
  350. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +12 -1
  351. data/lib/elasticsearch/api/actions/nodes/stats.rb +13 -2
  352. data/lib/elasticsearch/api/actions/nodes/usage.rb +14 -3
  353. data/lib/elasticsearch/api/actions/open_point_in_time.rb +23 -12
  354. data/lib/elasticsearch/api/actions/ping.rb +13 -2
  355. data/lib/elasticsearch/api/actions/put_script.rb +14 -3
  356. data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +13 -2
  357. data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +12 -1
  358. data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +13 -2
  359. data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +13 -2
  360. data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +12 -1
  361. data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +13 -2
  362. data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +15 -4
  363. data/lib/elasticsearch/api/actions/query_rules/test.rb +13 -2
  364. data/lib/elasticsearch/api/actions/rank_eval.rb +16 -5
  365. data/lib/elasticsearch/api/actions/reindex.rb +35 -123
  366. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +17 -4
  367. data/lib/elasticsearch/api/actions/render_search_template.rb +14 -3
  368. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
  369. data/lib/elasticsearch/api/actions/scroll.rb +16 -5
  370. data/lib/elasticsearch/api/actions/search.rb +71 -60
  371. data/lib/elasticsearch/api/actions/search_application/delete.rb +13 -2
  372. data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +13 -2
  373. data/lib/elasticsearch/api/actions/search_application/get.rb +13 -2
  374. data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +13 -2
  375. data/lib/elasticsearch/api/actions/search_application/list.rb +12 -1
  376. data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +12 -1
  377. data/lib/elasticsearch/api/actions/search_application/put.rb +13 -2
  378. data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +13 -2
  379. data/lib/elasticsearch/api/actions/search_application/render_query.rb +15 -4
  380. data/lib/elasticsearch/api/actions/search_application/search.rb +12 -1
  381. data/lib/elasticsearch/api/actions/search_mvt.rb +39 -70
  382. data/lib/elasticsearch/api/actions/search_shards.rb +22 -12
  383. data/lib/elasticsearch/api/actions/search_template.rb +24 -14
  384. data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +12 -1
  385. data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +14 -3
  386. data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +13 -2
  387. data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +12 -1
  388. data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +17 -6
  389. data/lib/elasticsearch/api/actions/security/authenticate.rb +13 -2
  390. data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +13 -2
  391. data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +13 -2
  392. data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +15 -4
  393. data/lib/elasticsearch/api/actions/security/change_password.rb +13 -2
  394. data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +14 -3
  395. data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +14 -3
  396. data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +13 -2
  397. data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +14 -3
  398. data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +17 -6
  399. data/lib/elasticsearch/api/actions/security/create_api_key.rb +13 -2
  400. data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +16 -5
  401. data/lib/elasticsearch/api/actions/security/create_service_token.rb +15 -4
  402. data/lib/elasticsearch/api/actions/security/delegate_pki.rb +15 -4
  403. data/lib/elasticsearch/api/actions/security/delete_privileges.rb +14 -3
  404. data/lib/elasticsearch/api/actions/security/delete_role.rb +13 -2
  405. data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +13 -2
  406. data/lib/elasticsearch/api/actions/security/delete_service_token.rb +13 -2
  407. data/lib/elasticsearch/api/actions/security/delete_user.rb +13 -2
  408. data/lib/elasticsearch/api/actions/security/disable_user.rb +13 -2
  409. data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +12 -1
  410. data/lib/elasticsearch/api/actions/security/enable_user.rb +13 -2
  411. data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +12 -1
  412. data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +13 -2
  413. data/lib/elasticsearch/api/actions/security/enroll_node.rb +13 -2
  414. data/lib/elasticsearch/api/actions/security/get_api_key.rb +20 -9
  415. data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +13 -2
  416. data/lib/elasticsearch/api/actions/security/get_privileges.rb +14 -3
  417. data/lib/elasticsearch/api/actions/security/get_role.rb +12 -1
  418. data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +13 -2
  419. data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +16 -5
  420. data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +15 -4
  421. data/lib/elasticsearch/api/actions/security/get_settings.rb +15 -4
  422. data/lib/elasticsearch/api/actions/security/get_token.rb +15 -4
  423. data/lib/elasticsearch/api/actions/security/get_user.rb +13 -2
  424. data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +12 -4
  425. data/lib/elasticsearch/api/actions/security/get_user_profile.rb +17 -6
  426. data/lib/elasticsearch/api/actions/security/grant_api_key.rb +17 -2
  427. data/lib/elasticsearch/api/actions/security/has_privileges.rb +13 -2
  428. data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +13 -2
  429. data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +21 -10
  430. data/lib/elasticsearch/api/actions/security/invalidate_token.rb +16 -5
  431. data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +13 -2
  432. data/lib/elasticsearch/api/actions/security/oidc_logout.rb +14 -3
  433. data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +13 -2
  434. data/lib/elasticsearch/api/actions/security/put_privileges.rb +18 -7
  435. data/lib/elasticsearch/api/actions/security/put_role.rb +13 -2
  436. data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +16 -5
  437. data/lib/elasticsearch/api/actions/security/put_user.rb +13 -2
  438. data/lib/elasticsearch/api/actions/security/query_api_keys.rb +18 -6
  439. data/lib/elasticsearch/api/actions/security/query_role.rb +13 -2
  440. data/lib/elasticsearch/api/actions/security/query_user.rb +12 -1
  441. data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +14 -3
  442. data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +13 -2
  443. data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +14 -3
  444. data/lib/elasticsearch/api/actions/security/saml_logout.rb +13 -2
  445. data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +16 -5
  446. data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +13 -2
  447. data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +17 -6
  448. data/lib/elasticsearch/api/actions/security/update_api_key.rb +17 -6
  449. data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +17 -5
  450. data/lib/elasticsearch/api/actions/security/update_settings.rb +14 -3
  451. data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +16 -5
  452. data/lib/elasticsearch/api/actions/simulate/ingest.rb +12 -1
  453. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +14 -3
  454. data/lib/elasticsearch/api/actions/snapshot/clone.rb +13 -2
  455. data/lib/elasticsearch/api/actions/snapshot/create.rb +14 -3
  456. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +17 -6
  457. data/lib/elasticsearch/api/actions/snapshot/delete.rb +16 -3
  458. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +15 -4
  459. data/lib/elasticsearch/api/actions/snapshot/get.rb +32 -19
  460. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +16 -5
  461. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +38 -16
  462. data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +113 -0
  463. data/lib/elasticsearch/api/actions/snapshot/restore.rb +19 -6
  464. data/lib/elasticsearch/api/actions/snapshot/status.rb +19 -8
  465. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +14 -3
  466. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +12 -1
  467. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +12 -1
  468. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +12 -1
  469. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +12 -1
  470. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +12 -1
  471. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +14 -3
  472. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +14 -3
  473. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +14 -3
  474. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +14 -3
  475. data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +13 -2
  476. data/lib/elasticsearch/api/actions/sql/delete_async.rb +14 -3
  477. data/lib/elasticsearch/api/actions/sql/get_async.rb +14 -3
  478. data/lib/elasticsearch/api/actions/sql/get_async_status.rb +13 -2
  479. data/lib/elasticsearch/api/actions/sql/query.rb +14 -3
  480. data/lib/elasticsearch/api/actions/sql/translate.rb +14 -3
  481. data/lib/elasticsearch/api/actions/ssl/certificates.rb +15 -4
  482. data/lib/elasticsearch/api/actions/streams/logs_disable.rb +50 -0
  483. data/lib/elasticsearch/api/actions/streams/logs_enable.rb +50 -0
  484. data/lib/elasticsearch/api/actions/streams/status.rb +50 -0
  485. data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +13 -2
  486. data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +15 -2
  487. data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +12 -1
  488. data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +13 -2
  489. data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +12 -1
  490. data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +16 -2
  491. data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +15 -2
  492. data/lib/elasticsearch/api/actions/tasks/cancel.rb +15 -4
  493. data/lib/elasticsearch/api/actions/tasks/get.rb +13 -2
  494. data/lib/elasticsearch/api/actions/tasks/list.rb +30 -15
  495. data/lib/elasticsearch/api/actions/terms_enum.rb +15 -4
  496. data/lib/elasticsearch/api/actions/termvectors.rb +28 -15
  497. data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +53 -42
  498. data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +53 -42
  499. data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +45 -45
  500. data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +13 -2
  501. data/lib/elasticsearch/api/actions/transform/delete_transform.rb +12 -1
  502. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
  503. data/lib/elasticsearch/api/actions/transform/get_transform.rb +14 -3
  504. data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +14 -3
  505. data/lib/elasticsearch/api/actions/transform/preview_transform.rb +12 -1
  506. data/lib/elasticsearch/api/actions/transform/put_transform.rb +19 -8
  507. data/lib/elasticsearch/api/actions/transform/reset_transform.rb +14 -3
  508. data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +13 -2
  509. data/lib/elasticsearch/api/actions/transform/start_transform.rb +15 -4
  510. data/lib/elasticsearch/api/actions/transform/stop_transform.rb +15 -4
  511. data/lib/elasticsearch/api/actions/transform/update_transform.rb +15 -4
  512. data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +12 -1
  513. data/lib/elasticsearch/api/actions/update.rb +20 -8
  514. data/lib/elasticsearch/api/actions/update_by_query.rb +76 -56
  515. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +13 -2
  516. data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +16 -4
  517. data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +13 -2
  518. data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +13 -2
  519. data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +15 -4
  520. data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +14 -2
  521. data/lib/elasticsearch/api/actions/watcher/get_settings.rb +14 -3
  522. data/lib/elasticsearch/api/actions/watcher/get_watch.rb +13 -2
  523. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +18 -7
  524. data/lib/elasticsearch/api/actions/watcher/query_watches.rb +14 -3
  525. data/lib/elasticsearch/api/actions/watcher/start.rb +12 -1
  526. data/lib/elasticsearch/api/actions/watcher/stats.rb +13 -2
  527. data/lib/elasticsearch/api/actions/watcher/stop.rb +13 -2
  528. data/lib/elasticsearch/api/actions/watcher/update_settings.rb +17 -6
  529. data/lib/elasticsearch/api/actions/xpack/info.rb +13 -2
  530. data/lib/elasticsearch/api/actions/xpack/usage.rb +13 -2
  531. data/lib/elasticsearch/api/version.rb +2 -2
  532. data/lib/elasticsearch/api.rb +1 -0
  533. metadata +18 -4
@@ -27,26 +27,37 @@ module Elasticsearch
27
27
  # They are not intended for use by applications. For application consumption, use the cluster health API.
28
28
  # This API is often used to check malfunctioning clusters.
29
29
  # To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:
30
- # +HH:MM:SS+, which is human-readable but includes no date information;
31
- # +Unix epoch time+, which is machine-sortable and includes date information.
30
+ # `HH:MM:SS`, which is human-readable but includes no date information;
31
+ # `Unix epoch time`, which is machine-sortable and includes date information.
32
32
  # The latter format is useful for cluster recoveries that take multiple days.
33
33
  # You can use the cat health API to verify cluster health across multiple nodes.
34
34
  # You also can use the API to track the recovery of a large cluster over a longer period of time.
35
35
  #
36
36
  # @option arguments [String] :time The unit used to display time values.
37
- # @option arguments [Boolean] :ts If true, returns +HH:MM:SS+ and Unix epoch timestamps. Server default: true.
37
+ # @option arguments [Boolean] :ts If true, returns `HH:MM:SS` and Unix epoch timestamps. Server default: true.
38
38
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
39
39
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
40
- # Sorting defaults to ascending and can be changed by setting +:asc+
41
- # or +:desc+ as a suffix to the column name.
40
+ # Sorting defaults to ascending and can be changed by setting `:asc`
41
+ # or `:desc` as a suffix to the column name.
42
42
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
43
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
44
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
43
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
44
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
45
45
  # can't be combined with any other query string option.
46
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
46
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
47
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
+ # when they occur.
49
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
50
+ # returned by Elasticsearch.
51
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
52
+ # For example `"exists_time": "1h"` for humans and
53
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
54
+ # readable values will be omitted. This makes sense for responses being consumed
55
+ # only by machines.
56
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
57
+ # this option for debugging only.
47
58
  # @option arguments [Hash] :headers Custom HTTP headers
48
59
  #
49
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-health
60
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health
50
61
  #
51
62
  def health(arguments = {})
52
63
  request_opts = { endpoint: arguments[:endpoint] || 'cat.health' }
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat
30
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat
31
31
  #
32
32
  def help(arguments = {})
33
33
  request_opts = { endpoint: arguments[:endpoint] || 'cat.help' }
@@ -36,7 +36,7 @@ module Elasticsearch
36
36
  # They are not intended for use by applications. For application consumption, use an index endpoint.
37
37
  #
38
38
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
39
- # Supports wildcards (+*+). To target all data streams and indices, omit this parameter or use +*+ or +_all+.
39
+ # Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
40
40
  # @option arguments [String] :bytes The unit used to display byte values.
41
41
  # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
42
42
  # @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status.
@@ -46,16 +46,27 @@ module Elasticsearch
46
46
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
47
47
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
48
48
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
49
- # Sorting defaults to ascending and can be changed by setting +:asc+
50
- # or +:desc+ as a suffix to the column name.
49
+ # Sorting defaults to ascending and can be changed by setting `:asc`
50
+ # or `:desc` as a suffix to the column name.
51
51
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
52
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
53
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
52
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
53
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
54
54
  # can't be combined with any other query string option.
55
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
55
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
56
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
57
+ # when they occur.
58
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
59
+ # returned by Elasticsearch.
60
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
61
+ # For example `"exists_time": "1h"` for humans and
62
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
63
+ # readable values will be omitted. This makes sense for responses being consumed
64
+ # only by machines.
65
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
66
+ # this option for debugging only.
56
67
  # @option arguments [Hash] :headers Custom HTTP headers
57
68
  #
58
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-indices
69
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices
59
70
  #
60
71
  def indices(arguments = {})
61
72
  request_opts = { endpoint: arguments[:endpoint] || 'cat.indices' }
@@ -28,21 +28,32 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
30
30
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
31
- # Sorting defaults to ascending and can be changed by setting +:asc+
32
- # or +:desc+ as a suffix to the column name.
33
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
34
- # local cluster state. If +false+ the list of selected nodes are computed
31
+ # Sorting defaults to ascending and can be changed by setting `:asc`
32
+ # or `:desc` as a suffix to the column name.
33
+ # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
34
+ # local cluster state. If `false` the list of selected nodes are computed
35
35
  # from the cluster state of the master node. In both cases the coordinating
36
36
  # node will send requests for further information to each selected node.
37
37
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
38
38
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
39
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
40
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
39
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
40
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
41
41
  # can't be combined with any other query string option.
42
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
42
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
43
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44
+ # when they occur.
45
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
46
+ # returned by Elasticsearch.
47
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
48
+ # For example `"exists_time": "1h"` for humans and
49
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
50
+ # readable values will be omitted. This makes sense for responses being consumed
51
+ # only by machines.
52
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
53
+ # this option for debugging only.
43
54
  # @option arguments [Hash] :headers Custom HTTP headers
44
55
  #
45
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-master
56
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master
46
57
  #
47
58
  def master(arguments = {})
48
59
  request_opts = { endpoint: arguments[:endpoint] || 'cat.master' }
@@ -29,20 +29,31 @@ module Elasticsearch
29
29
  # application consumption, use the get data frame analytics jobs statistics API.
30
30
  #
31
31
  # @option arguments [String] :id The ID of the data frame analytics to fetch
32
- # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes +_all+ string or when no configs have been specified)
32
+ # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
33
33
  # @option arguments [String] :bytes The unit in which to display byte values
34
34
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: create_time,id,state,type.
35
35
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the
36
36
  # response.
37
37
  # @option arguments [String] :time Unit used to display time values.
38
38
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
39
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
40
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
39
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
40
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
41
41
  # can't be combined with any other query string option.
42
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
42
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
43
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44
+ # when they occur.
45
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
46
+ # returned by Elasticsearch.
47
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
48
+ # For example `"exists_time": "1h"` for humans and
49
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
50
+ # readable values will be omitted. This makes sense for responses being consumed
51
+ # only by machines.
52
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
53
+ # this option for debugging only.
43
54
  # @option arguments [Hash] :headers Custom HTTP headers
44
55
  #
45
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-data-frame-analytics
56
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics
46
57
  #
47
58
  def ml_data_frame_analytics(arguments = {})
48
59
  request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_data_frame_analytics' }
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # Get datafeeds.
26
26
  # Get configuration and usage information about datafeeds.
27
27
  # This API returns a maximum of 10,000 datafeeds.
28
- # If the Elasticsearch security features are enabled, you must have +monitor_ml+, +monitor+, +manage_ml+, or +manage+
28
+ # If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
29
29
  # cluster privileges to use this API.
30
30
  # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
31
31
  # console or command line. They are not intended for use by applications. For
@@ -34,22 +34,33 @@ module Elasticsearch
34
34
  # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed.
35
35
  # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
36
36
  # - Contains wildcard expressions and there are no datafeeds that match.
37
- # - Contains the +_all+ string or no identifiers and there are no matches.
37
+ # - Contains the `_all` string or no identifiers and there are no matches.
38
38
  # - Contains wildcard expressions and there are only partial matches.
39
- # If +true+, the API returns an empty datafeeds array when there are no matches and the subset of results when
40
- # there are partial matches. If +false+, the API returns a 404 status code when there are no matches or only
39
+ # If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when
40
+ # there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only
41
41
  # partial matches. Server default: true.
42
42
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: ['bc', 'id', 'sc', 's'].
43
43
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
44
44
  # @option arguments [String] :time The unit used to display time values.
45
45
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
46
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
47
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
46
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
47
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
48
48
  # can't be combined with any other query string option.
49
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
49
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
50
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
51
+ # when they occur.
52
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
53
+ # returned by Elasticsearch.
54
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
55
+ # For example `"exists_time": "1h"` for humans and
56
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
57
+ # readable values will be omitted. This makes sense for responses being consumed
58
+ # only by machines.
59
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
60
+ # this option for debugging only.
50
61
  # @option arguments [Hash] :headers Custom HTTP headers
51
62
  #
52
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-datafeeds
63
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds
53
64
  #
54
65
  def ml_datafeeds(arguments = {})
55
66
  request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_datafeeds' }
@@ -25,8 +25,8 @@ module Elasticsearch
25
25
  # Get anomaly detection jobs.
26
26
  # Get configuration and usage information for anomaly detection jobs.
27
27
  # This API returns a maximum of 10,000 jobs.
28
- # If the Elasticsearch security features are enabled, you must have +monitor_ml+,
29
- # +monitor+, +manage_ml+, or +manage+ cluster privileges to use this API.
28
+ # If the Elasticsearch security features are enabled, you must have `monitor_ml`,
29
+ # `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.
30
30
  # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
31
31
  # console or command line. They are not intended for use by applications. For
32
32
  # application consumption, use the get anomaly detection job statistics API.
@@ -34,23 +34,34 @@ module Elasticsearch
34
34
  # @option arguments [String] :job_id Identifier for the anomaly detection job.
35
35
  # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
36
36
  # - Contains wildcard expressions and there are no jobs that match.
37
- # - Contains the +_all+ string or no identifiers and there are no matches.
37
+ # - Contains the `_all` string or no identifiers and there are no matches.
38
38
  # - Contains wildcard expressions and there are only partial matches.
39
- # If +true+, the API returns an empty jobs array when there are no matches and the subset of results when there
40
- # are partial matches. If +false+, the API returns a 404 status code when there are no matches or only partial
39
+ # If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there
40
+ # are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial
41
41
  # matches. Server default: true.
42
42
  # @option arguments [String] :bytes The unit used to display byte values.
43
43
  # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state.
44
44
  # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
45
45
  # @option arguments [String] :time The unit used to display time values.
46
46
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
47
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
48
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
47
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
48
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
49
49
  # can't be combined with any other query string option.
50
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
50
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
51
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
52
+ # when they occur.
53
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
54
+ # returned by Elasticsearch.
55
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
56
+ # For example `"exists_time": "1h"` for humans and
57
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
58
+ # readable values will be omitted. This makes sense for responses being consumed
59
+ # only by machines.
60
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
61
+ # this option for debugging only.
51
62
  # @option arguments [Hash] :headers Custom HTTP headers
52
63
  #
53
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-jobs
64
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs
54
65
  #
55
66
  def ml_jobs(arguments = {})
56
67
  request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_jobs' }
@@ -29,9 +29,9 @@ module Elasticsearch
29
29
  # application consumption, use the get trained models statistics API.
30
30
  #
31
31
  # @option arguments [String] :model_id A unique identifier for the trained model.
32
- # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
33
- # If +true+, the API returns an empty array when there are no matches and the subset of results when there are partial matches.
34
- # If +false+, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
32
+ # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
33
+ # If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.
34
+ # If `false`, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
35
35
  # @option arguments [String] :bytes The unit used to display byte values.
36
36
  # @option arguments [String, Array<String>] :h A comma-separated list of column names to display.
37
37
  # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases used to sort the response.
@@ -39,13 +39,24 @@ module Elasticsearch
39
39
  # @option arguments [Integer] :size The maximum number of transforms to display.
40
40
  # @option arguments [String] :time Unit used to display time values.
41
41
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
42
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
43
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
42
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
43
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
44
44
  # can't be combined with any other query string option.
45
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
45
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
46
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
47
+ # when they occur.
48
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
49
+ # returned by Elasticsearch.
50
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
51
+ # For example `"exists_time": "1h"` for humans and
52
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
53
+ # readable values will be omitted. This makes sense for responses being consumed
54
+ # only by machines.
55
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
56
+ # this option for debugging only.
46
57
  # @option arguments [Hash] :headers Custom HTTP headers
47
58
  #
48
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-trained-models
59
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models
49
60
  #
50
61
  def ml_trained_models(arguments = {})
51
62
  request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_trained_models' }
@@ -28,21 +28,32 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
30
30
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
31
- # Sorting defaults to ascending and can be changed by setting +:asc+
32
- # or +:desc+ as a suffix to the column name.
33
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
34
- # local cluster state. If +false+ the list of selected nodes are computed
31
+ # Sorting defaults to ascending and can be changed by setting `:asc`
32
+ # or `:desc` as a suffix to the column name.
33
+ # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
34
+ # local cluster state. If `false` the list of selected nodes are computed
35
35
  # from the cluster state of the master node. In both cases the coordinating
36
36
  # node will send requests for further information to each selected node.
37
37
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
38
38
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
39
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
40
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
39
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
40
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
41
41
  # can't be combined with any other query string option.
42
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
42
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
43
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44
+ # when they occur.
45
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
46
+ # returned by Elasticsearch.
47
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
48
+ # For example `"exists_time": "1h"` for humans and
49
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
50
+ # readable values will be omitted. This makes sense for responses being consumed
51
+ # only by machines.
52
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
53
+ # this option for debugging only.
43
54
  # @option arguments [Hash] :headers Custom HTTP headers
44
55
  #
45
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodeattrs
56
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs
46
57
  #
47
58
  def nodeattrs(arguments = {})
48
59
  request_opts = { endpoint: arguments[:endpoint] || 'cat.nodeattrs' }
@@ -27,22 +27,34 @@ module Elasticsearch
27
27
  # 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.
28
28
  #
29
29
  # @option arguments [String] :bytes The unit used to display byte values.
30
- # @option arguments [Boolean, String] :full_id If +true+, return the full node ID. If +false+, return the shortened node ID. Server default: false.
30
+ # @option arguments [Boolean, String] :full_id If `true`, return the full node ID. If `false`, return the shortened node ID. Server default: false.
31
31
  # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
32
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
33
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
34
- # Sorting defaults to ascending and can be changed by setting +:asc+
35
- # or +:desc+ as a suffix to the column name.
36
- # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
37
- # @option arguments [String] :time Unit used to display time values.
32
+ # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
33
+ # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
34
+ # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
35
+ # Sorting defaults to ascending and can be changed by setting `:asc`
36
+ # or `:desc` as a suffix to the column name.
37
+ # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
38
+ # @option arguments [String] :time The unit used to display time values.
38
39
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
39
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
40
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
40
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
41
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
41
42
  # can't be combined with any other query string option.
42
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
43
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
44
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
45
+ # when they occur.
46
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
47
+ # returned by Elasticsearch.
48
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
49
+ # For example `"exists_time": "1h"` for humans and
50
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
51
+ # readable values will be omitted. This makes sense for responses being consumed
52
+ # only by machines.
53
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
54
+ # this option for debugging only.
43
55
  # @option arguments [Hash] :headers Custom HTTP headers
44
56
  #
45
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodes
57
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes
46
58
  #
47
59
  def nodes(arguments = {})
48
60
  request_opts = { endpoint: arguments[:endpoint] || 'cat.nodes' }
@@ -28,22 +28,33 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
30
30
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
31
- # Sorting defaults to ascending and can be changed by setting +:asc+
32
- # or +:desc+ as a suffix to the column name.
33
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
34
- # local cluster state. If +false+ the list of selected nodes are computed
31
+ # Sorting defaults to ascending and can be changed by setting `:asc`
32
+ # or `:desc` as a suffix to the column name.
33
+ # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
34
+ # local cluster state. If `false` the list of selected nodes are computed
35
35
  # from the cluster state of the master node. In both cases the coordinating
36
36
  # node will send requests for further information to each selected node.
37
37
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
38
38
  # @option arguments [String] :time Unit used to display time values.
39
39
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
40
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
41
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
40
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
41
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
42
42
  # can't be combined with any other query string option.
43
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
43
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
44
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
45
+ # when they occur.
46
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
47
+ # returned by Elasticsearch.
48
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
49
+ # For example `"exists_time": "1h"` for humans and
50
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
51
+ # readable values will be omitted. This makes sense for responses being consumed
52
+ # only by machines.
53
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
54
+ # this option for debugging only.
44
55
  # @option arguments [Hash] :headers Custom HTTP headers
45
56
  #
46
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-pending-tasks
57
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks
47
58
  #
48
59
  def pending_tasks(arguments = {})
49
60
  request_opts = { endpoint: arguments[:endpoint] || 'cat.pending_tasks' }
@@ -28,22 +28,33 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
30
30
  # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
31
- # Sorting defaults to ascending and can be changed by setting +:asc+
32
- # or +:desc+ as a suffix to the column name.
31
+ # Sorting defaults to ascending and can be changed by setting `:asc`
32
+ # or `:desc` as a suffix to the column name.
33
33
  # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response
34
- # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
35
- # local cluster state. If +false+ the list of selected nodes are computed
34
+ # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
35
+ # local cluster state. If `false` the list of selected nodes are computed
36
36
  # from the cluster state of the master node. In both cases the coordinating
37
37
  # node will send requests for further information to each selected node.
38
38
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
39
39
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
40
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
41
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
40
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
41
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
42
42
  # can't be combined with any other query string option.
43
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
43
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
44
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
45
+ # when they occur.
46
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
47
+ # returned by Elasticsearch.
48
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
49
+ # For example `"exists_time": "1h"` for humans and
50
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
51
+ # readable values will be omitted. This makes sense for responses being consumed
52
+ # only by machines.
53
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
54
+ # this option for debugging only.
44
55
  # @option arguments [Hash] :headers Custom HTTP headers
45
56
  #
46
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-plugins
57
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins
47
58
  #
48
59
  def plugins(arguments = {})
49
60
  request_opts = { endpoint: arguments[:endpoint] || 'cat.plugins' }
@@ -29,23 +29,35 @@ module Elasticsearch
29
29
  # 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.
30
30
  #
31
31
  # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
32
- # Supports wildcards (+*+). To target all data streams and indices, omit this parameter or use +*+ or +_all+.
33
- # @option arguments [Boolean] :active_only If +true+, the response only includes ongoing shard recoveries.
32
+ # Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
33
+ # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
34
34
  # @option arguments [String] :bytes The unit used to display byte values.
35
- # @option arguments [Boolean] :detailed If +true+, the response includes detailed information about shard recoveries.
36
- # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
37
- # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
38
- # Sorting defaults to ascending and can be changed by setting +:asc+
39
- # or +:desc+ as a suffix to the column name.
40
- # @option arguments [String] :time Unit used to display time values.
35
+ # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
36
+ # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
37
+ # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
38
+ # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
39
+ # Sorting defaults to ascending and can be changed by setting `:asc`
40
+ # or `:desc` as a suffix to the column name.
41
+ # @option arguments [String] :time The unit used to display time values.
41
42
  # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
42
- # +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
43
- # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
43
+ # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
44
+ # @option arguments [Boolean] :help When set to `true` will output available columns. This option
44
45
  # can't be combined with any other query string option.
45
- # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
46
+ # @option arguments [Boolean] :v When set to `true` will enable verbose output.
47
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
+ # when they occur.
49
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
50
+ # returned by Elasticsearch.
51
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
52
+ # For example `"exists_time": "1h"` for humans and
53
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
54
+ # readable values will be omitted. This makes sense for responses being consumed
55
+ # only by machines.
56
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
57
+ # this option for debugging only.
46
58
  # @option arguments [Hash] :headers Custom HTTP headers
47
59
  #
48
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-recovery
60
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery
49
61
  #
50
62
  def recovery(arguments = {})
51
63
  request_opts = { endpoint: arguments[:endpoint] || 'cat.recovery' }