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
@@ -31,10 +31,21 @@ module Elasticsearch
31
31
  # @option arguments [String] :index The name of the follower index. (*Required*)
32
32
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
33
33
  # If the master node is not available before the timeout expires, the request fails and returns an error.
34
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
34
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
35
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
36
+ # when they occur.
37
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
38
+ # returned by Elasticsearch.
39
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
40
+ # For example `"exists_time": "1h"` for humans and
41
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
42
+ # readable values will be omitted. This makes sense for responses being consumed
43
+ # only by machines.
44
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
45
+ # this option for debugging only.
35
46
  # @option arguments [Hash] :headers Custom HTTP headers
36
47
  #
37
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-follow
48
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow
38
49
  #
39
50
  def pause_follow(arguments = {})
40
51
  request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_follow' }
@@ -31,10 +31,21 @@ module Elasticsearch
31
31
  #
32
32
  # @option arguments [String] :name The name of the collection of auto-follow patterns. (*Required*)
33
33
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  # @option arguments [Hash] :body request body
36
47
  #
37
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-put-auto-follow-pattern
48
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern
38
49
  #
39
50
  def put_auto_follow_pattern(arguments = {})
40
51
  request_opts = { endpoint: arguments[:endpoint] || 'ccr.put_auto_follow_pattern' }
@@ -30,10 +30,21 @@ module Elasticsearch
30
30
  # @option arguments [String] :name The name of the auto-follow pattern to resume. (*Required*)
31
31
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
32
32
  # If the master node is not available before the timeout expires, the request fails and returns an error.
33
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
33
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  #
36
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-auto-follow-pattern
47
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern
37
48
  #
38
49
  def resume_auto_follow_pattern(arguments = {})
39
50
  request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_auto_follow_pattern' }
@@ -30,10 +30,21 @@ module Elasticsearch
30
30
  #
31
31
  # @option arguments [String] :index The name of the follow index to resume following. (*Required*)
32
32
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
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
  # @option arguments [Hash] :body request body
35
46
  #
36
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-follow
47
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow
37
48
  #
38
49
  def resume_follow(arguments = {})
39
50
  request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_follow' }
@@ -27,11 +27,22 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
29
29
  # If the master node is not available before the timeout expires, the request fails and returns an error.
30
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
30
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
31
31
  # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
32
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
+ # when they occur.
34
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
35
+ # returned by Elasticsearch.
36
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
37
+ # For example `"exists_time": "1h"` for humans and
38
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
39
+ # readable values will be omitted. This makes sense for responses being consumed
40
+ # only by machines.
41
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
42
+ # this option for debugging only.
32
43
  # @option arguments [Hash] :headers Custom HTTP headers
33
44
  #
34
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-stats
45
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats
35
46
  #
36
47
  def stats(arguments = {})
37
48
  request_opts = { endpoint: arguments[:endpoint] || 'ccr.stats' }
@@ -30,10 +30,21 @@ module Elasticsearch
30
30
  # @option arguments [String] :index The name of the follower index. (*Required*)
31
31
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
32
32
  # If the master node is not available before the timeout expires, the request fails and returns an error.
33
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
33
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  #
36
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-unfollow
47
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow
37
48
  #
38
49
  def unfollow(arguments = {})
39
50
  request_opts = { endpoint: arguments[:endpoint] || 'ccr.unfollow' }
@@ -24,15 +24,26 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Delete a dangling index.
26
26
  # If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
27
- # For example, this can happen if you delete more than +cluster.indices.tombstones.size+ indices while an Elasticsearch node is offline.
27
+ # For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
28
28
  #
29
29
  # @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
30
30
  # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
31
31
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
32
32
  # @option arguments [Time] :timeout Explicit operation timeout
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-dangling-indices-delete-dangling-index
46
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index
36
47
  #
37
48
  def delete_dangling_index(arguments = {})
38
49
  request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.delete_dangling_index' }
@@ -24,16 +24,27 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Import a dangling index.
26
26
  # If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
27
- # For example, this can happen if you delete more than +cluster.indices.tombstones.size+ indices while an Elasticsearch node is offline.
27
+ # For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
28
28
  #
29
29
  # @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
30
30
  # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
31
31
  # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*)
32
32
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
33
33
  # @option arguments [Time] :timeout Explicit operation timeout
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  #
36
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-import-dangling-index
47
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index
37
48
  #
38
49
  def import_dangling_index(arguments = {})
39
50
  request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.import_dangling_index' }
@@ -24,12 +24,23 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get the dangling indices.
26
26
  # If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
27
- # For example, this can happen if you delete more than +cluster.indices.tombstones.size+ indices while an Elasticsearch node is offline.
27
+ # For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
28
28
  # Use this API to list dangling indices, which you can then import or delete.
29
29
  #
30
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
31
+ # when they occur.
32
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
33
+ # returned by Elasticsearch.
34
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
35
+ # For example `"exists_time": "1h"` for humans and
36
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
37
+ # readable values will be omitted. This makes sense for responses being consumed
38
+ # only by machines.
39
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
40
+ # this option for debugging only.
30
41
  # @option arguments [Hash] :headers Custom HTTP headers
31
42
  #
32
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-list-dangling-indices
43
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices
33
44
  #
34
45
  def list_dangling_indices(arguments = {})
35
46
  request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.list_dangling_indices' }
@@ -41,7 +52,7 @@ module Elasticsearch
41
52
 
42
53
  method = Elasticsearch::API::HTTP_GET
43
54
  path = '_dangling'
44
- params = {}
55
+ params = Utils.process_params(arguments)
45
56
 
46
57
  Elasticsearch::API::Response.new(
47
58
  perform_request(method, path, params, body, headers, request_opts)
@@ -26,21 +26,23 @@ module Elasticsearch
26
26
  # NOTE: You cannot send deletion requests directly to a data stream.
27
27
  # To delete a document in a data stream, you must target the backing index containing the document.
28
28
  # **Optimistic concurrency control**
29
- # Delete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the +if_seq_no+ and +if_primary_term+ parameters.
30
- # If a mismatch is detected, the operation will result in a +VersionConflictException+ and a status code of +409+.
29
+ # Delete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.
30
+ # If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.
31
31
  # **Versioning**
32
32
  # Each document indexed is versioned.
33
33
  # When deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.
34
34
  # Every write operation run on a document, deletes included, causes its version to be incremented.
35
35
  # The version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.
36
- # The length of time for which a deleted document's version remains available is determined by the +index.gc_deletes+ index setting.
36
+ # The length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.
37
37
  # **Routing**
38
38
  # If routing is used during indexing, the routing value also needs to be specified to delete a document.
39
- # If the +_routing+ mapping is set to +required+ and no routing value is specified, the delete API throws a +RoutingMissingException+ and rejects the request.
39
+ # If the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.
40
40
  # For example:
41
- # +
41
+ #
42
+ # ```
42
43
  # DELETE /my-index-000001/_doc/1?routing=shard-1
43
- # +
44
+ # ```
45
+ #
44
46
  # This request deletes the document with ID 1, but it is routed based on the user.
45
47
  # The document is not deleted if the correct routing is not specified.
46
48
  # **Distributed**
@@ -51,9 +53,9 @@ module Elasticsearch
51
53
  # @option arguments [String] :index The name of the target index. (*Required*)
52
54
  # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
53
55
  # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
54
- # @option arguments [String] :refresh If +true+, Elasticsearch refreshes the affected shards to make this operation visible to search.
55
- # If +wait_for+, it waits for a refresh to make this operation visible to search.
56
- # If +false+, it does nothing with refreshes. Server default: false.
56
+ # @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.
57
+ # If `wait_for`, it waits for a refresh to make this operation visible to search.
58
+ # If `false`, it does nothing with refreshes. Server default: false.
57
59
  # @option arguments [String] :routing A custom value used to route operations to a specific shard.
58
60
  # @option arguments [Time] :timeout The period to wait for active shards.This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.
59
61
  # Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.
@@ -62,11 +64,22 @@ module Elasticsearch
62
64
  # It must match the current version of the document for the request to succeed.
63
65
  # @option arguments [String] :version_type The version type.
64
66
  # @option arguments [Integer, String] :wait_for_active_shards The minimum number of shard copies that must be active before proceeding with the operation.
65
- # You can set it to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+).
66
- # The default value of +1+ means it waits for each primary shard to be active. Server default: 1.
67
+ # You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
68
+ # The default value of `1` means it waits for each primary shard to be active. Server default: 1.
69
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
70
+ # when they occur.
71
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
72
+ # returned by Elasticsearch.
73
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
74
+ # For example `"exists_time": "1h"` for humans and
75
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
76
+ # readable values will be omitted. This makes sense for responses being consumed
77
+ # only by machines.
78
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
79
+ # this option for debugging only.
67
80
  # @option arguments [Hash] :headers Custom HTTP headers
68
81
  #
69
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete
82
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete
70
83
  #
71
84
  def delete(arguments = {})
72
85
  request_opts = { endpoint: arguments[:endpoint] || 'delete' }
@@ -24,8 +24,8 @@ module Elasticsearch
24
24
  # Delete documents.
25
25
  # Deletes documents that match the specified query.
26
26
  # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:
27
- # * +read+
28
- # * +delete+ or +write+
27
+ # * `read`
28
+ # * `delete` or `write`
29
29
  # You can specify the query criteria in the request URI or the request body using the same syntax as the search API.
30
30
  # When you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.
31
31
  # If a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.
@@ -35,80 +35,84 @@ module Elasticsearch
35
35
  # If a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.
36
36
  # If the maximum retry limit is reached, processing halts and all failed requests are returned in the response.
37
37
  # Any delete requests that completed successfully still stick, they are not rolled back.
38
- # You can opt to count version conflicts instead of halting and returning by setting +conflicts+ to +proceed+.
39
- # Note that if you opt to count version conflicts the operation could attempt to delete more documents from the source than +max_docs+ until it has successfully deleted +max_docs documents+, or it has gone through every document in the source query.
38
+ # You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.
39
+ # Note that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.
40
40
  # **Throttling delete requests**
41
- # To control the rate at which delete by query issues batches of delete operations, you can set +requests_per_second+ to any positive decimal number.
41
+ # To control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number.
42
42
  # This pads each batch with a wait time to throttle the rate.
43
- # Set +requests_per_second+ to +-1+ to disable throttling.
43
+ # Set `requests_per_second` to `-1` to disable throttling.
44
44
  # Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.
45
- # The padding time is the difference between the batch size divided by the +requests_per_second+ and the time spent writing.
46
- # By default the batch size is +1000+, so if +requests_per_second+ is set to +500+:
47
- # +
45
+ # The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.
46
+ # By default the batch size is `1000`, so if `requests_per_second` is set to `500`:
47
+ #
48
+ # ```
48
49
  # target_time = 1000 / 500 per second = 2 seconds
49
50
  # wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds
50
- # +
51
- # Since the batch is issued as a single +_bulk+ request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.
51
+ # ```
52
+ #
53
+ # Since the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.
52
54
  # This is "bursty" instead of "smooth".
53
55
  # **Slicing**
54
56
  # Delete by query supports sliced scroll to parallelize the delete process.
55
57
  # This can improve efficiency and provide a convenient way to break the request down into smaller parts.
56
- # Setting +slices+ to +auto+ lets Elasticsearch choose the number of slices to use.
58
+ # Setting `slices` to `auto` lets Elasticsearch choose the number of slices to use.
57
59
  # This setting will use one slice per shard, up to a certain limit.
58
60
  # If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.
59
61
  # Adding slices to the delete by query operation creates sub-requests which means it has some quirks:
60
62
  # * You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices.
61
63
  # * Fetching the status of the task for the request with slices only contains the status of completed slices.
62
64
  # * These sub-requests are individually addressable for things like cancellation and rethrottling.
63
- # * Rethrottling the request with +slices+ will rethrottle the unfinished sub-request proportionally.
64
- # * Canceling the request with +slices+ will cancel each sub-request.
65
- # * Due to the nature of +slices+ each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.
66
- # * Parameters like +requests_per_second+ and +max_docs+ on a request with +slices+ are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using +max_docs+ with +slices+ might not result in exactly +max_docs+ documents being deleted.
65
+ # * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.
66
+ # * Canceling the request with `slices` will cancel each sub-request.
67
+ # * Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.
68
+ # * Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted.
67
69
  # * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.
68
70
  # If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:
69
- # * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many +slices+ hurts performance. Setting +slices+ higher than the number of shards generally does not improve efficiency and adds overhead.
71
+ # * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead.
70
72
  # * Delete performance scales linearly across available resources with the number of slices.
71
73
  # Whether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.
72
74
  # **Cancel a delete by query operation**
73
75
  # Any delete by query can be canceled using the task cancel API. For example:
74
- # +
76
+ #
77
+ # ```
75
78
  # POST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel
76
- # +
79
+ # ```
80
+ #
77
81
  # The task ID can be found by using the get tasks API.
78
82
  # Cancellation should happen quickly but might take a few seconds.
79
83
  # The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.
80
84
  #
81
85
  # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search.
82
- # It supports wildcards (+*+).
83
- # To search all data streams or indices, omit this parameter or use +*+ or +_all+. (*Required*)
84
- # @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.
86
+ # It supports wildcards (`*`).
87
+ # To search all data streams or indices, omit this parameter or use `*` or `_all`. (*Required*)
88
+ # @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.
85
89
  # This behavior applies even if the request targets other open indices.
86
- # 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.
90
+ # 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.
87
91
  # @option arguments [String] :analyzer Analyzer to use for the query string.
88
- # This parameter can be used only when the +q+ query string parameter is specified.
89
- # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
90
- # This parameter can be used only when the +q+ query string parameter is specified.
91
- # @option arguments [String] :conflicts What to do if delete by query hits version conflicts: +abort+ or +proceed+. Server default: abort.
92
- # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+.
93
- # This parameter can be used only when the +q+ query string parameter is specified. Server default: OR.
92
+ # This parameter can be used only when the `q` query string parameter is specified.
93
+ # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
94
+ # This parameter can be used only when the `q` query string parameter is specified.
95
+ # @option arguments [String] :conflicts What to do if delete by query hits version conflicts: `abort` or `proceed`. Server default: abort.
96
+ # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`.
97
+ # This parameter can be used only when the `q` query string parameter is specified. Server default: OR.
94
98
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
95
- # This parameter can be used only when the +q+ query string parameter is specified.
99
+ # This parameter can be used only when the `q` query string parameter is specified.
96
100
  # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
97
101
  # If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
98
- # It supports comma-separated values, such as +open,hidden+. Server default: open.
102
+ # It supports comma-separated values, such as `open,hidden`. Server default: open.
99
103
  # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0.
100
- # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
101
- # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
102
- # This parameter can be used only when the +q+ query string parameter is specified.
104
+ # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
105
+ # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
106
+ # This parameter can be used only when the `q` query string parameter is specified.
103
107
  # @option arguments [Integer] :max_docs The maximum number of documents to process.
104
108
  # Defaults to all documents.
105
- # When set to a value less then or equal to +scroll_size+, a scroll will not be used to retrieve the results for the operation.
109
+ # When set to a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.
106
110
  # @option arguments [String] :preference The node or shard the operation should be performed on.
107
111
  # It is random by default.
108
- # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes all shards involved in the delete by query after the request completes.
109
- # This is different than the delete API's +refresh+ parameter, which causes just the shard that received the delete request to be refreshed.
110
- # Unlike the delete API, it does not support +wait_for+.
111
- # @option arguments [Boolean] :request_cache If +true+, the request cache is used for this request.
112
+ # @option arguments [Boolean] :refresh If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.
113
+ # This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed.
114
+ # Unlike the delete API, it does not support `wait_for`.
115
+ # @option arguments [Boolean] :request_cache If `true`, the request cache is used for this request.
112
116
  # Defaults to the index-level setting.
113
117
  # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
114
118
  # @option arguments [String] :routing A custom value used to route operations to a specific shard.
@@ -118,10 +122,10 @@ module Elasticsearch
118
122
  # @option arguments [Time] :search_timeout The explicit timeout for each search request.
119
123
  # It defaults to no timeout.
120
124
  # @option arguments [String] :search_type The type of the search operation.
121
- # Available options include +query_then_fetch+ and +dfs_query_then_fetch+.
125
+ # Available options include `query_then_fetch` and `dfs_query_then_fetch`.
122
126
  # @option arguments [Integer, String] :slices The number of slices this task should be divided into. Server default: 1.
123
- # @option arguments [Array<String>] :sort A comma-separated list of +<field>:<direction>+ pairs.
124
- # @option arguments [Array<String>] :stats The specific +tag+ of the request for logging and statistical purposes.
127
+ # @option arguments [Array<String>] :sort A comma-separated list of `<field>:<direction>` pairs.
128
+ # @option arguments [Array<String>] :stats The specific `tag` of the request for logging and statistical purposes.
125
129
  # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard.
126
130
  # If a query reaches this limit, Elasticsearch terminates the query early.
127
131
  # Elasticsearch collects documents before sorting.Use with caution.
@@ -129,16 +133,27 @@ module Elasticsearch
129
133
  # When possible, let Elasticsearch perform early termination automatically.
130
134
  # Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
131
135
  # @option arguments [Time] :timeout The period each deletion request waits for active shards. Server default: 1m.
132
- # @option arguments [Boolean] :version If +true+, returns the document version as part of a hit.
136
+ # @option arguments [Boolean] :version If `true`, returns the document version as part of a hit.
133
137
  # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
134
- # Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+).
135
- # The +timeout+ value controls how long each write request waits for unavailable shards to become available. Server default: 1.
136
- # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the operation is complete.
137
- # If +false+, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at +.tasks/task/${taskId}+. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. Server default: true.
138
+ # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
139
+ # The `timeout` value controls how long each write request waits for unavailable shards to become available. Server default: 1.
140
+ # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete.
141
+ # If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. Server default: true.
142
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
143
+ # when they occur.
144
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
145
+ # returned by Elasticsearch.
146
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
147
+ # For example `"exists_time": "1h"` for humans and
148
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
149
+ # readable values will be omitted. This makes sense for responses being consumed
150
+ # only by machines.
151
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
152
+ # this option for debugging only.
138
153
  # @option arguments [Hash] :headers Custom HTTP headers
139
154
  # @option arguments [Hash] :body request body
140
155
  #
141
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-by-query
156
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query
142
157
  #
143
158
  def delete_by_query(arguments = {})
144
159
  request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query' }
@@ -25,12 +25,23 @@ module Elasticsearch
25
25
  # Change the number of requests per second for a particular delete by query operation.
26
26
  # Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
27
27
  #
28
- # @option arguments [String, Integer] :task_id The ID for the task. (*Required*)
28
+ # @option arguments [String] :task_id The ID for the task. (*Required*)
29
29
  # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second.
30
- # To disable throttling, set it to +-1+.
30
+ # To disable throttling, set it to `-1`.
31
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+ # when they occur.
33
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+ # returned by Elasticsearch.
35
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+ # For example `"exists_time": "1h"` for humans and
37
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
38
+ # readable values will be omitted. This makes sense for responses being consumed
39
+ # only by machines.
40
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41
+ # this option for debugging only.
31
42
  # @option arguments [Hash] :headers Custom HTTP headers
32
43
  #
33
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-by-query-rethrottle
44
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle
34
45
  #
35
46
  def delete_by_query_rethrottle(arguments = {})
36
47
  request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query_rethrottle' }
@@ -27,13 +27,24 @@ module Elasticsearch
27
27
  # @option arguments [String] :id The identifier for the stored script or search template. (*Required*)
28
28
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
29
29
  # If no response is received before the timeout expires, the request fails and returns an error.
30
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
30
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
31
31
  # @option arguments [Time] :timeout The period to wait for a response.
32
32
  # If no response is received before the timeout expires, the request fails and returns an error.
33
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
33
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  #
36
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-script
47
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script
37
48
  #
38
49
  def delete_script(arguments = {})
39
50
  request_opts = { endpoint: arguments[:endpoint] || 'delete_script' }
@@ -27,9 +27,20 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String] :name Enrich policy to delete. (*Required*)
29
29
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
30
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
31
+ # when they occur.
32
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
33
+ # returned by Elasticsearch.
34
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
35
+ # For example `"exists_time": "1h"` for humans and
36
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
37
+ # readable values will be omitted. This makes sense for responses being consumed
38
+ # only by machines.
39
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
40
+ # this option for debugging only.
30
41
  # @option arguments [Hash] :headers Custom HTTP headers
31
42
  #
32
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-delete-policy
43
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy
33
44
  #
34
45
  def delete_policy(arguments = {})
35
46
  request_opts = { endpoint: arguments[:endpoint] || 'enrich.delete_policy' }