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
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  module API
23
23
  module Indices
24
24
  module Actions
25
- # Create or update an index template.
25
+ # Create or update a legacy index template.
26
26
  # Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
27
27
  # Elasticsearch applies templates to new indices based on an index pattern that matches the index name.
28
28
  # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
@@ -31,7 +31,7 @@ module Elasticsearch
31
31
  # Index templates are only applied during index creation.
32
32
  # Changes to index templates do not affect existing indices.
33
33
  # Settings and mappings specified in create index API requests override any settings or mappings specified in an index template.
34
- # You can use C-style +/* *\/+ block comments in index templates.
34
+ # You can use C-style `/* *\/` block comments in index templates.
35
35
  # You can include comments anywhere in the request body, except before the opening curly bracket.
36
36
  # **Indices matching multiple templates**
37
37
  # Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.
@@ -46,10 +46,21 @@ module Elasticsearch
46
46
  # matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
47
47
  # 'order' values are merged later, overriding templates with lower values.
48
48
  # @option arguments [String] :cause User defined reason for creating/updating the index template
49
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
50
+ # when they occur.
51
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
52
+ # returned by Elasticsearch.
53
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
54
+ # For example `"exists_time": "1h"` for humans and
55
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
56
+ # readable values will be omitted. This makes sense for responses being consumed
57
+ # only by machines.
58
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
59
+ # this option for debugging only.
49
60
  # @option arguments [Hash] :headers Custom HTTP headers
50
61
  # @option arguments [Hash] :body request body
51
62
  #
52
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-template
63
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template
53
64
  #
54
65
  def put_template(arguments = {})
55
66
  request_opts = { endpoint: arguments[:endpoint] || 'indices.put_template' }
@@ -41,13 +41,30 @@ module Elasticsearch
41
41
  # This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.
42
42
  #
43
43
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
44
- # Supports wildcards (+*+).
45
- # To target all data streams and indices, omit this parameter or use +*+ or +_all+.
46
- # @option arguments [Boolean] :active_only If +true+, the response only includes ongoing shard recoveries.
47
- # @option arguments [Boolean] :detailed If +true+, the response includes detailed information about shard recoveries.
44
+ # Supports wildcards (`*`).
45
+ # To target all data streams and indices, omit this parameter or use `*` or `_all`.
46
+ # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
47
+ # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
48
+ # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
49
+ # This behavior applies even if the request targets other open indices. Server default: true.
50
+ # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
51
+ # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
52
+ # Supports comma-separated values, such as `open,hidden`. Server default: open.
53
+ # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
54
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
55
+ # when they occur.
56
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
57
+ # returned by Elasticsearch.
58
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
59
+ # For example `"exists_time": "1h"` for humans and
60
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
61
+ # readable values will be omitted. This makes sense for responses being consumed
62
+ # only by machines.
63
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
64
+ # this option for debugging only.
48
65
  # @option arguments [Hash] :headers Custom HTTP headers
49
66
  #
50
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-recovery
67
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery
51
68
  #
52
69
  def recovery(arguments = {})
53
70
  request_opts = { endpoint: arguments[:endpoint] || 'indices.recovery' }
@@ -26,26 +26,36 @@ module Elasticsearch
26
26
  # A refresh makes recent operations performed on one or more indices available for search.
27
27
  # For data streams, the API runs the refresh operation on the stream’s backing indices.
28
28
  # By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.
29
- # You can change this default interval with the +index.refresh_interval+ setting.
29
+ # You can change this default interval with the `index.refresh_interval` setting.
30
30
  # Refresh requests are synchronous and do not return a response until the refresh operation completes.
31
31
  # Refreshes are resource-intensive.
32
32
  # To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.
33
- # If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's +refresh=wait_for+ query parameter option.
33
+ # If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option.
34
34
  # This option ensures the indexing operation waits for a periodic refresh before running the search.
35
35
  #
36
36
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
37
- # Supports wildcards (+*+).
38
- # To target all data streams and indices, omit this parameter or use +*+ or +_all+.
39
- # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
37
+ # Supports wildcards (`*`).
38
+ # To target all data streams and indices, omit this parameter or use `*` or `_all`.
39
+ # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
40
40
  # This behavior applies even if the request targets other open indices. Server default: true.
41
41
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
42
42
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
43
- # Supports comma-separated values, such as +open,hidden+.
44
- # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
45
- # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
43
+ # Supports comma-separated values, such as `open,hidden`. Server default: open.
44
+ # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
45
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
46
+ # when they occur.
47
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
48
+ # returned by Elasticsearch.
49
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
50
+ # For example `"exists_time": "1h"` for humans and
51
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
52
+ # readable values will be omitted. This makes sense for responses being consumed
53
+ # only by machines.
54
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
55
+ # this option for debugging only.
46
56
  # @option arguments [Hash] :headers Custom HTTP headers
47
57
  #
48
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-refresh
58
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh
49
59
  #
50
60
  def refresh(arguments = {})
51
61
  request_opts = { endpoint: arguments[:endpoint] || 'indices.refresh' }
@@ -26,8 +26,8 @@ module Elasticsearch
26
26
  # Reload an index's search analyzers and their resources.
27
27
  # For data streams, the API reloads search analyzers and resources for the stream's backing indices.
28
28
  # IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.
29
- # You can use the reload search analyzers API to pick up changes to synonym files used in the +synonym_graph+ or +synonym+ token filter of a search analyzer.
30
- # To be eligible, the token filter must have an +updateable+ flag of +true+ and only be used in search analyzers.
29
+ # You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer.
30
+ # To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.
31
31
  # NOTE: This API does not perform a reload for each shard of an index.
32
32
  # Instead, it performs a reload for each node containing index shards.
33
33
  # As a result, the total shard count returned by the API can differ from the number of index shards.
@@ -35,13 +35,24 @@ module Elasticsearch
35
35
  # This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.
36
36
  #
37
37
  # @option arguments [String, Array] :index A comma-separated list of index names to reload analyzers for (*Required*)
38
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes +_all+ string or when no indices have been specified)
38
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
39
39
  # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
40
40
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
41
41
  # @option arguments [String] :resource Changed resource to reload analyzers from if applicable
42
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
43
+ # when they occur.
44
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
45
+ # returned by Elasticsearch.
46
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
47
+ # For example `"exists_time": "1h"` for humans and
48
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
49
+ # readable values will be omitted. This makes sense for responses being consumed
50
+ # only by machines.
51
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
52
+ # this option for debugging only.
42
53
  # @option arguments [Hash] :headers Custom HTTP headers
43
54
  #
44
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-reload-search-analyzers
55
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers
45
56
  #
46
57
  def reload_search_analyzers(arguments = {})
47
58
  request_opts = { endpoint: arguments[:endpoint] || 'indices.reload_search_analyzers' }
@@ -0,0 +1,93 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+ #
18
+ # This code was automatically generated from the Elasticsearch Specification
19
+ # See https://github.com/elastic/elasticsearch-specification
20
+ # See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
21
+ module Elasticsearch
22
+ module API
23
+ module Indices
24
+ module Actions
25
+ # Remove an index block.
26
+ # Remove an index block from an index.
27
+ # Index blocks limit the operations allowed on an index by blocking specific operation types.
28
+ #
29
+ # @option arguments [String] :index A comma-separated list or wildcard expression of index names used to limit the request.
30
+ # By default, you must explicitly name the indices you are removing blocks from.
31
+ # To allow the removal of blocks from indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.
32
+ # You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. (*Required*)
33
+ # @option arguments [String] :block The block type to remove from the index. (*Required*)
34
+ # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
35
+ # This behavior applies even if the request targets other open indices.
36
+ # For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
37
+ # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
38
+ # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
39
+ # It supports comma-separated values, such as `open,hidden`. Server default: open.
40
+ # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
41
+ # @option arguments [Time] :master_timeout The period to wait for the master node.
42
+ # If the master node is not available before the timeout expires, the request fails and returns an error.
43
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
44
+ # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
45
+ # If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
46
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
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.
58
+ # @option arguments [Hash] :headers Custom HTTP headers
59
+ #
60
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block
61
+ #
62
+ def remove_block(arguments = {})
63
+ request_opts = { endpoint: arguments[:endpoint] || 'indices.remove_block' }
64
+
65
+ defined_params = [:index, :block].each_with_object({}) do |variable, set_variables|
66
+ set_variables[variable] = arguments[variable] if arguments.key?(variable)
67
+ end
68
+ request_opts[:defined_params] = defined_params unless defined_params.empty?
69
+
70
+ raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
71
+ raise ArgumentError, "Required argument 'block' missing" unless arguments[:block]
72
+
73
+ arguments = arguments.clone
74
+ headers = arguments.delete(:headers) || {}
75
+
76
+ body = nil
77
+
78
+ _index = arguments.delete(:index)
79
+
80
+ _block = arguments.delete(:block)
81
+
82
+ method = Elasticsearch::API::HTTP_DELETE
83
+ path = "#{Utils.listify(_index)}/_block/#{Utils.listify(_block)}"
84
+ params = Utils.process_params(arguments)
85
+
86
+ Elasticsearch::API::Response.new(
87
+ perform_request(method, path, params, body, headers, request_opts)
88
+ )
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
@@ -29,58 +29,68 @@ module Elasticsearch
29
29
  # You use the same index expression with this endpoint as you would for cross-cluster search.
30
30
  # Index and cluster exclusions are also supported with this endpoint.
31
31
  # For each cluster in the index expression, information is returned about:
32
- # * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the +remote/info+ endpoint.
33
- # * Whether each remote cluster is configured with +skip_unavailable+ as +true+ or +false+.
32
+ # * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint.
33
+ # * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.
34
34
  # * Whether there are any indices, aliases, or data streams on that cluster that match the index expression.
35
35
  # * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).
36
36
  # * Cluster version information, including the Elasticsearch server version.
37
- # For example, +GET /_resolve/cluster/my-index-*,cluster*:my-index-*+ returns information about the local cluster and all remotely configured clusters that start with the alias +cluster*+.
38
- # Each cluster returns information about whether it has any indices, aliases or data streams that match +my-index-*+.The ability to query without an index expression was added in version 8.18, so when
37
+ # For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`.
38
+ # Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.The ability to query without an index expression was added in version 8.18, so when
39
39
  # querying remote clusters older than that, the local cluster will send the index
40
- # expression +dummy*+ to those remote clusters. Thus, if an errors occur, you may see a reference
40
+ # expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference
41
41
  # to that index expression even though you didn't request it. If it causes a problem, you can
42
- # instead include an index expression like +*:*+ to bypass the issue.You may want to exclude a cluster or index from a search when:
43
- # * A remote cluster is not currently connected and is configured with +skip_unavailable=false+. Running a cross-cluster search under those conditions will cause the entire search to fail.
44
- # * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is +logs*,remote1:logs*+ and the remote1 cluster has no indices, aliases or data streams that match +logs*+. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
45
- # * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the +_resolve/cluster+ response will be present. (This is also where security/permission errors will be shown.)
46
- # * A remote cluster is an older version that does not support the feature you want to use in your search.The +remote/info+ endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.
42
+ # instead include an index expression like `*:*` to bypass the issue.You may want to exclude a cluster or index from a search when:
43
+ # * A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.
44
+ # * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
45
+ # * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)
46
+ # * A remote cluster is an older version that does not support the feature you want to use in your search.The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.
47
47
  # The remote cluster may be available, while the local cluster is not currently connected to it.
48
- # You can use the +_resolve/cluster+ API to attempt to reconnect to remote clusters.
49
- # For example with +GET _resolve/cluster+ or +GET _resolve/cluster/*:*+.
50
- # The +connected+ field in the response will indicate whether it was successful.
51
- # If a connection was (re-)established, this will also cause the +remote/info+ endpoint to now indicate a connected status.
48
+ # You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters.
49
+ # For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`.
50
+ # The `connected` field in the response will indicate whether it was successful.
51
+ # If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.
52
52
  #
53
53
  # @option arguments [String, Array<String>] :name A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve.
54
- # Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax.
55
- # Index and cluster exclusions (e.g., +-cluster1:*+) are also supported.
54
+ # Resources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.
55
+ # Index and cluster exclusions (e.g., `-cluster1:*`) are also supported.
56
56
  # If no index expression is specified, information about all remote clusters configured on the local cluster
57
57
  # is returned without doing any index matching
58
- # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing
58
+ # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing
59
59
  # or closed indices. This behavior applies even if the request targets other open indices. For example, a request
60
- # targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+.
60
+ # targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
61
61
  # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
62
- # options to the +_resolve/cluster+ API endpoint that takes no index expression. Server default: true.
62
+ # options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: true.
63
63
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
64
64
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
65
- # Supports comma-separated values, such as +open,hidden+.
66
- # Valid values are: +all+, +open+, +closed+, +hidden+, +none+.
65
+ # Supports comma-separated values, such as `open,hidden`.
67
66
  # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
68
- # options to the +_resolve/cluster+ API endpoint that takes no index expression. Server default: open.
67
+ # options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: open.
69
68
  # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen.
70
69
  # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
71
- # options to the +_resolve/cluster+ API endpoint that takes no index expression.
70
+ # options to the `_resolve/cluster` API endpoint that takes no index expression.
72
71
  # @option arguments [Boolean] :ignore_unavailable If false, the request returns an error if it targets a missing or closed index.
73
72
  # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
74
- # options to the +_resolve/cluster+ API endpoint that takes no index expression.
73
+ # options to the `_resolve/cluster` API endpoint that takes no index expression.
75
74
  # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond.
76
75
  # If a remote cluster does not respond within this timeout period, the API response
77
76
  # will show the cluster as not connected and include an error message that the
78
77
  # request timed out.The default timeout is unset and the query can take
79
78
  # as long as the networking layer is configured to wait for remote clusters that are
80
79
  # not responding (typically 30 seconds).
80
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
81
+ # when they occur.
82
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
83
+ # returned by Elasticsearch.
84
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
85
+ # For example `"exists_time": "1h"` for humans and
86
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
87
+ # readable values will be omitted. This makes sense for responses being consumed
88
+ # only by machines.
89
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
90
+ # this option for debugging only.
81
91
  # @option arguments [Hash] :headers Custom HTTP headers
82
92
  #
83
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-cluster
93
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster
84
94
  #
85
95
  def resolve_cluster(arguments = {})
86
96
  request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_cluster' }
@@ -27,18 +27,28 @@ module Elasticsearch
27
27
  # Multiple patterns and remote clusters are supported.
28
28
  #
29
29
  # @option arguments [String, Array<String>] :name Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.
30
- # Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax. (*Required*)
30
+ # Resources on remote clusters can be specified using the `<cluster>`:`<name>` syntax. (*Required*)
31
31
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
32
32
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
33
- # Supports comma-separated values, such as +open,hidden+.
34
- # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
35
- # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
36
- # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
33
+ # Supports comma-separated values, such as `open,hidden`. Server default: open.
34
+ # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
35
+ # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
37
36
  # This behavior applies even if the request targets other open indices.
38
- # For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
37
+ # For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
38
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
39
+ # when they occur.
40
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
41
+ # returned by Elasticsearch.
42
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
43
+ # For example `"exists_time": "1h"` for humans and
44
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
45
+ # readable values will be omitted. This makes sense for responses being consumed
46
+ # only by machines.
47
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
48
+ # this option for debugging only.
39
49
  # @option arguments [Hash] :headers Custom HTTP headers
40
50
  #
41
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index
51
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index
42
52
  #
43
53
  def resolve_index(arguments = {})
44
54
  request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_index' }
@@ -34,38 +34,49 @@ module Elasticsearch
34
34
  # TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.
35
35
  # Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.
36
36
  # If an index alias points to multiple indices, one of the indices must be a write index.
37
- # The rollover API creates a new write index for the alias with +is_write_index+ set to +true+.
38
- # The API also +sets is_write_index+ to +false+ for the previous write index.
37
+ # The rollover API creates a new write index for the alias with `is_write_index` set to `true`.
38
+ # The API also `sets is_write_index` to `false` for the previous write index.
39
39
  # **Roll over an index alias with one index**
40
40
  # If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.
41
- # NOTE: A rollover creates a new index and is subject to the +wait_for_active_shards+ setting.
41
+ # NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.
42
42
  # **Increment index names for an alias**
43
43
  # When you roll over an index alias, you can specify a name for the new index.
44
- # If you don't specify a name and the current index ends with +-+ and a number, such as +my-index-000001+ or +my-index-3+, the new index name increments that number.
45
- # For example, if you roll over an alias with a current index of +my-index-000001+, the rollover creates a new index named +my-index-000002+.
44
+ # If you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.
45
+ # For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.
46
46
  # This number is always six characters and zero-padded, regardless of the previous index's name.
47
47
  # If you use an index alias for time series data, you can use date math in the index name to track the rollover date.
48
- # For example, you can create an alias that points to an index named +<my-index-{now/d}-000001>+.
49
- # If you create the index on May 6, 2099, the index's name is +my-index-2099.05.06-000001+.
50
- # If you roll over the alias on May 7, 2099, the new index's name is +my-index-2099.05.07-000002+.
48
+ # For example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.
49
+ # If you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.
50
+ # If you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.
51
51
  #
52
52
  # @option arguments [String] :alias Name of the data stream or index alias to roll over. (*Required*)
53
53
  # @option arguments [String] :new_index Name of the index to create.
54
54
  # Supports date math.
55
55
  # Data streams do not support this parameter.
56
- # @option arguments [Boolean] :dry_run If +true+, checks whether the current index satisfies the specified conditions but does not perform a rollover.
56
+ # @option arguments [Boolean] :dry_run If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.
57
57
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
58
58
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
59
59
  # @option arguments [Time] :timeout Period to wait for a response.
60
60
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
61
61
  # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
62
- # Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
62
+ # Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
63
63
  # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.
64
64
  # Only allowed on data streams.
65
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
66
+ # when they occur.
67
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
68
+ # returned by Elasticsearch.
69
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
70
+ # For example `"exists_time": "1h"` for humans and
71
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
72
+ # readable values will be omitted. This makes sense for responses being consumed
73
+ # only by machines.
74
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
75
+ # this option for debugging only.
65
76
  # @option arguments [Hash] :headers Custom HTTP headers
66
77
  # @option arguments [Hash] :body request body
67
78
  #
68
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-rollover
79
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover
69
80
  #
70
81
  def rollover(arguments = {})
71
82
  request_opts = { endpoint: arguments[:endpoint] || 'indices.rollover' }
@@ -27,18 +27,28 @@ module Elasticsearch
27
27
  # For data streams, the API returns information about the stream's backing indices.
28
28
  #
29
29
  # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
30
- # Supports wildcards (+*+).
31
- # To target all data streams and indices, omit this parameter or use +*+ or +_all+.
32
- # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
30
+ # Supports wildcards (`*`).
31
+ # To target all data streams and indices, omit this parameter or use `*` or `_all`.
32
+ # @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
33
33
  # This behavior applies even if the request targets other open indices. Server default: true.
34
34
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
35
35
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
36
- # Supports comma-separated values, such as +open,hidden+.
37
- # Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
38
- # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
36
+ # Supports comma-separated values, such as `open,hidden`. Server default: open.
37
+ # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
38
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
39
+ # when they occur.
40
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
41
+ # returned by Elasticsearch.
42
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
43
+ # For example `"exists_time": "1h"` for humans and
44
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
45
+ # readable values will be omitted. This makes sense for responses being consumed
46
+ # only by machines.
47
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
48
+ # this option for debugging only.
39
49
  # @option arguments [Hash] :headers Custom HTTP headers
40
50
  #
41
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-segments
51
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments
42
52
  #
43
53
  def segments(arguments = {})
44
54
  request_opts = { endpoint: arguments[:endpoint] || 'indices.segments' }
@@ -39,10 +39,21 @@ module Elasticsearch
39
39
  # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams,
40
40
  # this argument determines whether wildcard expressions match hidden data streams. Server default: open.
41
41
  # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
42
- # @option arguments [Shardstorestatus] :status List of shard health statuses used to limit the request.
42
+ # @option arguments [String, Array<String>] :status List of shard health statuses used to limit the request.
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-indices-shard-stores
56
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores
46
57
  #
47
58
  def shard_stores(arguments = {})
48
59
  request_opts = { endpoint: arguments[:endpoint] || 'indices.shard_stores' }
@@ -38,7 +38,7 @@ module Elasticsearch
38
38
  # A shrink operation:
39
39
  # * Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.
40
40
  # * Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.
41
- # * Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the +.routing.allocation.initial_recovery._id+ index setting.
41
+ # * Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.
42
42
  # IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:
43
43
  # * The target index must not exist.
44
44
  # * The source index must have more primary shards than the target index.
@@ -53,11 +53,22 @@ module Elasticsearch
53
53
  # @option arguments [Time] :timeout Period to wait for a response.
54
54
  # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
55
55
  # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
56
- # Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
56
+ # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1.
57
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
58
+ # when they occur.
59
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
60
+ # returned by Elasticsearch.
61
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
62
+ # For example `"exists_time": "1h"` for humans and
63
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
64
+ # readable values will be omitted. This makes sense for responses being consumed
65
+ # only by machines.
66
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
67
+ # this option for debugging only.
57
68
  # @option arguments [Hash] :headers Custom HTTP headers
58
69
  # @option arguments [Hash] :body request body
59
70
  #
60
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shrink
71
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink
61
72
  #
62
73
  def shrink(arguments = {})
63
74
  request_opts = { endpoint: arguments[:endpoint] || 'indices.shrink' }
@@ -30,9 +30,20 @@ module Elasticsearch
30
30
  # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes Server default: false.
31
31
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
32
32
  # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
33
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
34
+ # when they occur.
35
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
36
+ # returned by Elasticsearch.
37
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
38
+ # For example `"exists_time": "1h"` for humans and
39
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
40
+ # readable values will be omitted. This makes sense for responses being consumed
41
+ # only by machines.
42
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
43
+ # this option for debugging only.
33
44
  # @option arguments [Hash] :headers Custom HTTP headers
34
45
  #
35
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template
46
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template
36
47
  #
37
48
  def simulate_index_template(arguments = {})
38
49
  request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_index_template' }