elasticsearch-api 9.0.2 → 9.0.4

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 (518) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/async_search/delete.rb +13 -2
  3. data/lib/elasticsearch/api/actions/async_search/get.rb +12 -1
  4. data/lib/elasticsearch/api/actions/async_search/status.rb +12 -1
  5. data/lib/elasticsearch/api/actions/async_search/submit.rb +16 -5
  6. data/lib/elasticsearch/api/actions/bulk.rb +85 -62
  7. data/lib/elasticsearch/api/actions/cat/aliases.rb +19 -8
  8. data/lib/elasticsearch/api/actions/cat/allocation.rb +18 -7
  9. data/lib/elasticsearch/api/actions/cat/component_templates.rb +18 -7
  10. data/lib/elasticsearch/api/actions/cat/count.rb +18 -7
  11. data/lib/elasticsearch/api/actions/cat/fielddata.rb +16 -5
  12. data/lib/elasticsearch/api/actions/cat/health.rb +19 -8
  13. data/lib/elasticsearch/api/actions/cat/indices.rb +17 -6
  14. data/lib/elasticsearch/api/actions/cat/master.rb +18 -7
  15. data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +15 -4
  16. data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +18 -7
  17. data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +19 -8
  18. data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +17 -6
  19. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +18 -7
  20. data/lib/elasticsearch/api/actions/cat/nodes.rb +22 -10
  21. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +18 -7
  22. data/lib/elasticsearch/api/actions/cat/plugins.rb +18 -7
  23. data/lib/elasticsearch/api/actions/cat/recovery.rb +23 -11
  24. data/lib/elasticsearch/api/actions/cat/repositories.rb +18 -7
  25. data/lib/elasticsearch/api/actions/cat/segments.rb +23 -11
  26. data/lib/elasticsearch/api/actions/cat/shards.rb +21 -10
  27. data/lib/elasticsearch/api/actions/cat/snapshots.rb +20 -8
  28. data/lib/elasticsearch/api/actions/cat/tasks.rb +18 -7
  29. data/lib/elasticsearch/api/actions/cat/templates.rb +18 -7
  30. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +20 -9
  31. data/lib/elasticsearch/api/actions/cat/transforms.rb +17 -6
  32. data/lib/elasticsearch/api/actions/clear_scroll.rb +12 -1
  33. data/lib/elasticsearch/api/actions/close_point_in_time.rb +14 -3
  34. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +12 -0
  35. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +11 -0
  36. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +11 -0
  37. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +11 -0
  38. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +16 -4
  39. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +13 -2
  40. data/lib/elasticsearch/api/actions/cluster/health.rb +12 -1
  41. data/lib/elasticsearch/api/actions/cluster/info.rb +12 -1
  42. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +13 -2
  43. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +15 -4
  44. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +19 -7
  45. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +16 -5
  46. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +12 -1
  47. data/lib/elasticsearch/api/actions/cluster/reroute.rb +15 -4
  48. data/lib/elasticsearch/api/actions/cluster/state.rb +14 -3
  49. data/lib/elasticsearch/api/actions/cluster/stats.rb +12 -1
  50. data/lib/elasticsearch/api/actions/connector/check_in.rb +13 -2
  51. data/lib/elasticsearch/api/actions/connector/delete.rb +11 -0
  52. data/lib/elasticsearch/api/actions/connector/get.rb +11 -0
  53. data/lib/elasticsearch/api/actions/connector/list.rb +11 -0
  54. data/lib/elasticsearch/api/actions/connector/post.rb +12 -1
  55. data/lib/elasticsearch/api/actions/connector/put.rb +12 -1
  56. data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +13 -2
  57. data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +13 -2
  58. data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +14 -3
  59. data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +12 -1
  60. data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +13 -2
  61. data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +12 -1
  62. data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +12 -1
  63. data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +12 -1
  64. data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +14 -3
  65. data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +12 -1
  66. data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +13 -2
  67. data/lib/elasticsearch/api/actions/connector/update_configuration.rb +12 -1
  68. data/lib/elasticsearch/api/actions/connector/update_error.rb +12 -1
  69. data/lib/elasticsearch/api/actions/connector/update_features.rb +12 -1
  70. data/lib/elasticsearch/api/actions/connector/update_filtering.rb +12 -1
  71. data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +12 -1
  72. data/lib/elasticsearch/api/actions/connector/update_index_name.rb +13 -2
  73. data/lib/elasticsearch/api/actions/connector/update_name.rb +12 -1
  74. data/lib/elasticsearch/api/actions/connector/update_native.rb +12 -1
  75. data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +12 -1
  76. data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +12 -1
  77. data/lib/elasticsearch/api/actions/connector/update_service_type.rb +12 -1
  78. data/lib/elasticsearch/api/actions/connector/update_status.rb +12 -1
  79. data/lib/elasticsearch/api/actions/count.rb +28 -17
  80. data/lib/elasticsearch/api/actions/create.rb +43 -40
  81. data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +12 -1
  82. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +11 -0
  83. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +12 -1
  84. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +11 -0
  85. data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +11 -0
  86. data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +12 -1
  87. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +12 -1
  88. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +12 -1
  89. data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +11 -0
  90. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +12 -1
  91. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +11 -0
  92. data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +12 -1
  93. data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +12 -1
  94. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +12 -1
  95. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +12 -1
  96. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +13 -2
  97. data/lib/elasticsearch/api/actions/delete.rb +24 -11
  98. data/lib/elasticsearch/api/actions/delete_by_query.rb +62 -47
  99. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +12 -1
  100. data/lib/elasticsearch/api/actions/delete_script.rb +13 -2
  101. data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +11 -0
  102. data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +12 -1
  103. data/lib/elasticsearch/api/actions/enrich/get_policy.rb +11 -0
  104. data/lib/elasticsearch/api/actions/enrich/put_policy.rb +11 -0
  105. data/lib/elasticsearch/api/actions/enrich/stats.rb +11 -0
  106. data/lib/elasticsearch/api/actions/eql/delete.rb +13 -2
  107. data/lib/elasticsearch/api/actions/eql/get.rb +11 -0
  108. data/lib/elasticsearch/api/actions/eql/get_status.rb +12 -1
  109. data/lib/elasticsearch/api/actions/eql/search.rb +14 -2
  110. data/lib/elasticsearch/api/actions/esql/async_query.rb +14 -13
  111. data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +14 -3
  112. data/lib/elasticsearch/api/actions/esql/async_query_get.rb +16 -4
  113. data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +14 -3
  114. data/lib/elasticsearch/api/actions/esql/query.rb +13 -2
  115. data/lib/elasticsearch/api/actions/exists.rb +30 -17
  116. data/lib/elasticsearch/api/actions/exists_source.rb +20 -7
  117. data/lib/elasticsearch/api/actions/explain.rb +24 -13
  118. data/lib/elasticsearch/api/actions/features/get_features.rb +12 -1
  119. data/lib/elasticsearch/api/actions/features/reset_features.rb +11 -0
  120. data/lib/elasticsearch/api/actions/field_caps.rb +17 -6
  121. data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +16 -5
  122. data/lib/elasticsearch/api/actions/fleet/msearch.rb +14 -3
  123. data/lib/elasticsearch/api/actions/fleet/search.rb +14 -3
  124. data/lib/elasticsearch/api/actions/get.rb +47 -28
  125. data/lib/elasticsearch/api/actions/get_script.rb +12 -1
  126. data/lib/elasticsearch/api/actions/get_script_context.rb +12 -1
  127. data/lib/elasticsearch/api/actions/get_script_languages.rb +12 -1
  128. data/lib/elasticsearch/api/actions/get_source.rb +23 -10
  129. data/lib/elasticsearch/api/actions/graph/explore.rb +12 -1
  130. data/lib/elasticsearch/api/actions/health_report.rb +12 -1
  131. data/lib/elasticsearch/api/actions/index.rb +54 -42
  132. data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +11 -0
  133. data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +13 -2
  134. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +11 -0
  135. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +12 -1
  136. data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +13 -2
  137. data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +13 -2
  138. data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +11 -0
  139. data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +12 -1
  140. data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +12 -1
  141. data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +11 -0
  142. data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +11 -0
  143. data/lib/elasticsearch/api/actions/indices/add_block.rb +19 -8
  144. data/lib/elasticsearch/api/actions/indices/analyze.rb +14 -3
  145. data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +12 -1
  146. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +23 -13
  147. data/lib/elasticsearch/api/actions/indices/clone.rb +16 -5
  148. data/lib/elasticsearch/api/actions/indices/close.rb +18 -8
  149. data/lib/elasticsearch/api/actions/indices/create.rb +27 -8
  150. data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +14 -3
  151. data/lib/elasticsearch/api/actions/indices/create_from.rb +12 -1
  152. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +14 -3
  153. data/lib/elasticsearch/api/actions/indices/delete.rb +16 -6
  154. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +13 -2
  155. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +12 -1
  156. data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +13 -2
  157. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +11 -0
  158. data/lib/elasticsearch/api/actions/indices/delete_template.rb +13 -1
  159. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +20 -9
  160. data/lib/elasticsearch/api/actions/indices/downsample.rb +14 -3
  161. data/lib/elasticsearch/api/actions/indices/exists.rb +18 -8
  162. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +17 -7
  163. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +11 -0
  164. data/lib/elasticsearch/api/actions/indices/exists_template.rb +13 -2
  165. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +11 -0
  166. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +15 -4
  167. data/lib/elasticsearch/api/actions/indices/flush.rb +19 -9
  168. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +22 -10
  169. data/lib/elasticsearch/api/actions/indices/get.rb +11 -0
  170. data/lib/elasticsearch/api/actions/indices/get_alias.rb +18 -8
  171. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +15 -5
  172. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +12 -1
  173. data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +13 -2
  174. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -9
  175. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +11 -0
  176. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +17 -7
  177. data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +12 -1
  178. data/lib/elasticsearch/api/actions/indices/get_settings.rb +23 -12
  179. data/lib/elasticsearch/api/actions/indices/get_template.rb +16 -5
  180. data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +12 -1
  181. data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +12 -1
  182. data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +12 -1
  183. data/lib/elasticsearch/api/actions/indices/open.rb +22 -12
  184. data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +11 -0
  185. data/lib/elasticsearch/api/actions/indices/put_alias.rb +12 -1
  186. data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +14 -4
  187. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +16 -5
  188. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +25 -24
  189. data/lib/elasticsearch/api/actions/indices/put_settings.rb +65 -13
  190. data/lib/elasticsearch/api/actions/indices/put_template.rb +13 -2
  191. data/lib/elasticsearch/api/actions/indices/recovery.rb +21 -4
  192. data/lib/elasticsearch/api/actions/indices/refresh.rb +18 -8
  193. data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +14 -3
  194. data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +34 -24
  195. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +16 -6
  196. data/lib/elasticsearch/api/actions/indices/rollover.rb +21 -10
  197. data/lib/elasticsearch/api/actions/indices/segments.rb +16 -6
  198. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +12 -1
  199. data/lib/elasticsearch/api/actions/indices/shrink.rb +13 -2
  200. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +11 -0
  201. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +11 -0
  202. data/lib/elasticsearch/api/actions/indices/split.rb +18 -5
  203. data/lib/elasticsearch/api/actions/indices/stats.rb +18 -7
  204. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +11 -0
  205. data/lib/elasticsearch/api/actions/indices/validate_query.rb +24 -14
  206. data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +17 -0
  207. data/lib/elasticsearch/api/actions/inference/completion.rb +11 -0
  208. data/lib/elasticsearch/api/actions/inference/delete.rb +11 -0
  209. data/lib/elasticsearch/api/actions/inference/get.rb +12 -1
  210. data/lib/elasticsearch/api/actions/inference/inference.rb +11 -0
  211. data/lib/elasticsearch/api/actions/inference/put.rb +31 -7
  212. data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +14 -7
  213. data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +14 -2
  214. data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +15 -8
  215. data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +14 -7
  216. data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +15 -8
  217. data/lib/elasticsearch/api/actions/inference/put_cohere.rb +14 -7
  218. data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
  219. data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +15 -3
  220. data/lib/elasticsearch/api/actions/inference/put_elser.rb +14 -2
  221. data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +14 -7
  222. data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +14 -7
  223. data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +22 -15
  224. data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +16 -9
  225. data/lib/elasticsearch/api/actions/inference/put_mistral.rb +15 -8
  226. data/lib/elasticsearch/api/actions/inference/put_openai.rb +15 -8
  227. data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +14 -2
  228. data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +16 -9
  229. data/lib/elasticsearch/api/actions/inference/rerank.rb +12 -1
  230. data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +11 -0
  231. data/lib/elasticsearch/api/actions/inference/stream_completion.rb +14 -2
  232. data/lib/elasticsearch/api/actions/inference/text_embedding.rb +11 -0
  233. data/lib/elasticsearch/api/actions/inference/update.rb +13 -2
  234. data/lib/elasticsearch/api/actions/info.rb +13 -1
  235. data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +11 -0
  236. data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +13 -2
  237. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +12 -1
  238. data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
  239. data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +14 -3
  240. data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +13 -5
  241. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +13 -2
  242. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
  243. data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +11 -0
  244. data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +13 -2
  245. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
  246. data/lib/elasticsearch/api/actions/ingest/simulate.rb +13 -2
  247. data/lib/elasticsearch/api/actions/license/delete.rb +11 -0
  248. data/lib/elasticsearch/api/actions/license/get.rb +13 -2
  249. data/lib/elasticsearch/api/actions/license/get_basic_status.rb +12 -1
  250. data/lib/elasticsearch/api/actions/license/get_trial_status.rb +12 -1
  251. data/lib/elasticsearch/api/actions/license/post.rb +11 -0
  252. data/lib/elasticsearch/api/actions/license/post_start_basic.rb +12 -1
  253. data/lib/elasticsearch/api/actions/license/post_start_trial.rb +12 -1
  254. data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +12 -1
  255. data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +12 -1
  256. data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +12 -1
  257. data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +12 -1
  258. data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +15 -4
  259. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +12 -1
  260. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +12 -1
  261. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +12 -1
  262. data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +12 -1
  263. data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +11 -0
  264. data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +13 -2
  265. data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +12 -1
  266. data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +14 -3
  267. data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +11 -0
  268. data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +13 -2
  269. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +11 -0
  270. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +13 -2
  271. data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +12 -1
  272. data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +12 -1
  273. data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +12 -1
  274. data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +13 -2
  275. data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +13 -2
  276. data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +15 -4
  277. data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +13 -2
  278. data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +12 -1
  279. data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +11 -0
  280. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +13 -2
  281. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +14 -3
  282. data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +19 -8
  283. data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +17 -6
  284. data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +11 -0
  285. data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +13 -2
  286. data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
  287. data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +14 -3
  288. data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +13 -2
  289. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +13 -2
  290. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +13 -2
  291. data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +30 -19
  292. data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +12 -1
  293. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +12 -1
  294. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +11 -0
  295. data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +11 -0
  296. data/lib/elasticsearch/api/actions/machine_learning/info.rb +12 -1
  297. data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +11 -0
  298. data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +12 -1
  299. data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +11 -0
  300. data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +12 -1
  301. data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +11 -0
  302. data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +12 -1
  303. data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +12 -1
  304. data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +13 -2
  305. data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +16 -5
  306. data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +13 -2
  307. data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +18 -12
  308. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +12 -1
  309. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +11 -0
  310. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +13 -2
  311. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +13 -2
  312. data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +11 -0
  313. data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +12 -1
  314. data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +12 -1
  315. data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +12 -1
  316. data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +18 -7
  317. data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +13 -2
  318. data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +11 -0
  319. data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +16 -5
  320. data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +13 -2
  321. data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
  322. data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +16 -10
  323. data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +12 -1
  324. data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +12 -1
  325. data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +12 -1
  326. data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +11 -0
  327. data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +11 -0
  328. data/lib/elasticsearch/api/actions/mget.rb +24 -13
  329. data/lib/elasticsearch/api/actions/migration/deprecations.rb +12 -1
  330. data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +12 -1
  331. data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +12 -1
  332. data/lib/elasticsearch/api/actions/msearch.rb +27 -10
  333. data/lib/elasticsearch/api/actions/msearch_template.rb +21 -9
  334. data/lib/elasticsearch/api/actions/mtermvectors.rb +20 -9
  335. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +13 -2
  336. data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +12 -1
  337. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +11 -0
  338. data/lib/elasticsearch/api/actions/nodes/info.rb +11 -0
  339. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +11 -0
  340. data/lib/elasticsearch/api/actions/nodes/stats.rb +12 -1
  341. data/lib/elasticsearch/api/actions/nodes/usage.rb +13 -2
  342. data/lib/elasticsearch/api/actions/open_point_in_time.rb +22 -11
  343. data/lib/elasticsearch/api/actions/ping.rb +12 -1
  344. data/lib/elasticsearch/api/actions/put_script.rb +13 -2
  345. data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +12 -1
  346. data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +11 -0
  347. data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +12 -1
  348. data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +12 -1
  349. data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +11 -0
  350. data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +12 -1
  351. data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +14 -3
  352. data/lib/elasticsearch/api/actions/query_rules/test.rb +12 -1
  353. data/lib/elasticsearch/api/actions/rank_eval.rb +15 -4
  354. data/lib/elasticsearch/api/actions/reindex.rb +34 -122
  355. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +16 -3
  356. data/lib/elasticsearch/api/actions/render_search_template.rb +13 -2
  357. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
  358. data/lib/elasticsearch/api/actions/scroll.rb +15 -4
  359. data/lib/elasticsearch/api/actions/search.rb +70 -59
  360. data/lib/elasticsearch/api/actions/search_application/delete.rb +12 -1
  361. data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +12 -1
  362. data/lib/elasticsearch/api/actions/search_application/get.rb +12 -1
  363. data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +12 -1
  364. data/lib/elasticsearch/api/actions/search_application/list.rb +11 -0
  365. data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +11 -0
  366. data/lib/elasticsearch/api/actions/search_application/put.rb +12 -1
  367. data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +12 -1
  368. data/lib/elasticsearch/api/actions/search_application/render_query.rb +14 -3
  369. data/lib/elasticsearch/api/actions/search_application/search.rb +11 -0
  370. data/lib/elasticsearch/api/actions/search_mvt.rb +38 -69
  371. data/lib/elasticsearch/api/actions/search_shards.rb +21 -11
  372. data/lib/elasticsearch/api/actions/search_template.rb +23 -13
  373. data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +11 -0
  374. data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +13 -2
  375. data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +12 -1
  376. data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +11 -0
  377. data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +16 -5
  378. data/lib/elasticsearch/api/actions/security/authenticate.rb +12 -1
  379. data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +12 -1
  380. data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +12 -1
  381. data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +14 -3
  382. data/lib/elasticsearch/api/actions/security/change_password.rb +12 -1
  383. data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +13 -2
  384. data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +13 -2
  385. data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +12 -1
  386. data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +13 -2
  387. data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +16 -5
  388. data/lib/elasticsearch/api/actions/security/create_api_key.rb +12 -1
  389. data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +15 -4
  390. data/lib/elasticsearch/api/actions/security/create_service_token.rb +14 -3
  391. data/lib/elasticsearch/api/actions/security/delegate_pki.rb +14 -3
  392. data/lib/elasticsearch/api/actions/security/delete_privileges.rb +13 -2
  393. data/lib/elasticsearch/api/actions/security/delete_role.rb +12 -1
  394. data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +12 -1
  395. data/lib/elasticsearch/api/actions/security/delete_service_token.rb +12 -1
  396. data/lib/elasticsearch/api/actions/security/delete_user.rb +12 -1
  397. data/lib/elasticsearch/api/actions/security/disable_user.rb +12 -1
  398. data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +11 -0
  399. data/lib/elasticsearch/api/actions/security/enable_user.rb +12 -1
  400. data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +11 -0
  401. data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +12 -1
  402. data/lib/elasticsearch/api/actions/security/enroll_node.rb +12 -1
  403. data/lib/elasticsearch/api/actions/security/get_api_key.rb +19 -8
  404. data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +12 -1
  405. data/lib/elasticsearch/api/actions/security/get_privileges.rb +13 -2
  406. data/lib/elasticsearch/api/actions/security/get_role.rb +11 -0
  407. data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +12 -1
  408. data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +15 -4
  409. data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +14 -3
  410. data/lib/elasticsearch/api/actions/security/get_settings.rb +14 -3
  411. data/lib/elasticsearch/api/actions/security/get_token.rb +14 -3
  412. data/lib/elasticsearch/api/actions/security/get_user.rb +12 -1
  413. data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +11 -3
  414. data/lib/elasticsearch/api/actions/security/get_user_profile.rb +16 -5
  415. data/lib/elasticsearch/api/actions/security/grant_api_key.rb +16 -1
  416. data/lib/elasticsearch/api/actions/security/has_privileges.rb +12 -1
  417. data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +12 -1
  418. data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +20 -9
  419. data/lib/elasticsearch/api/actions/security/invalidate_token.rb +15 -4
  420. data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +12 -1
  421. data/lib/elasticsearch/api/actions/security/oidc_logout.rb +13 -2
  422. data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +12 -1
  423. data/lib/elasticsearch/api/actions/security/put_privileges.rb +17 -6
  424. data/lib/elasticsearch/api/actions/security/put_role.rb +12 -1
  425. data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +15 -4
  426. data/lib/elasticsearch/api/actions/security/put_user.rb +12 -1
  427. data/lib/elasticsearch/api/actions/security/query_api_keys.rb +17 -5
  428. data/lib/elasticsearch/api/actions/security/query_role.rb +12 -1
  429. data/lib/elasticsearch/api/actions/security/query_user.rb +11 -0
  430. data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +13 -2
  431. data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +12 -1
  432. data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +13 -2
  433. data/lib/elasticsearch/api/actions/security/saml_logout.rb +12 -1
  434. data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +15 -4
  435. data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +12 -1
  436. data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +16 -5
  437. data/lib/elasticsearch/api/actions/security/update_api_key.rb +16 -5
  438. data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +16 -4
  439. data/lib/elasticsearch/api/actions/security/update_settings.rb +13 -2
  440. data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +15 -4
  441. data/lib/elasticsearch/api/actions/simulate/ingest.rb +11 -0
  442. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +13 -2
  443. data/lib/elasticsearch/api/actions/snapshot/clone.rb +12 -1
  444. data/lib/elasticsearch/api/actions/snapshot/create.rb +13 -2
  445. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +16 -5
  446. data/lib/elasticsearch/api/actions/snapshot/delete.rb +15 -2
  447. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +14 -3
  448. data/lib/elasticsearch/api/actions/snapshot/get.rb +29 -18
  449. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +15 -4
  450. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +20 -9
  451. data/lib/elasticsearch/api/actions/snapshot/restore.rb +18 -5
  452. data/lib/elasticsearch/api/actions/snapshot/status.rb +18 -7
  453. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +13 -2
  454. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +11 -0
  455. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +11 -0
  456. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +11 -0
  457. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +11 -0
  458. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +11 -0
  459. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +13 -2
  460. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +13 -2
  461. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +13 -2
  462. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +13 -2
  463. data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +12 -1
  464. data/lib/elasticsearch/api/actions/sql/delete_async.rb +13 -2
  465. data/lib/elasticsearch/api/actions/sql/get_async.rb +13 -2
  466. data/lib/elasticsearch/api/actions/sql/get_async_status.rb +12 -1
  467. data/lib/elasticsearch/api/actions/sql/query.rb +13 -2
  468. data/lib/elasticsearch/api/actions/sql/translate.rb +13 -2
  469. data/lib/elasticsearch/api/actions/ssl/certificates.rb +14 -3
  470. data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +12 -1
  471. data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +12 -1
  472. data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +11 -0
  473. data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +12 -1
  474. data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +11 -0
  475. data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +13 -1
  476. data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +12 -1
  477. data/lib/elasticsearch/api/actions/tasks/cancel.rb +13 -2
  478. data/lib/elasticsearch/api/actions/tasks/get.rb +12 -1
  479. data/lib/elasticsearch/api/actions/tasks/list.rb +29 -14
  480. data/lib/elasticsearch/api/actions/terms_enum.rb +14 -3
  481. data/lib/elasticsearch/api/actions/termvectors.rb +27 -14
  482. data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +52 -41
  483. data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +52 -41
  484. data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +44 -44
  485. data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +12 -1
  486. data/lib/elasticsearch/api/actions/transform/delete_transform.rb +11 -0
  487. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
  488. data/lib/elasticsearch/api/actions/transform/get_transform.rb +13 -2
  489. data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +13 -2
  490. data/lib/elasticsearch/api/actions/transform/preview_transform.rb +11 -0
  491. data/lib/elasticsearch/api/actions/transform/put_transform.rb +18 -7
  492. data/lib/elasticsearch/api/actions/transform/reset_transform.rb +13 -2
  493. data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +12 -1
  494. data/lib/elasticsearch/api/actions/transform/start_transform.rb +14 -3
  495. data/lib/elasticsearch/api/actions/transform/stop_transform.rb +14 -3
  496. data/lib/elasticsearch/api/actions/transform/update_transform.rb +14 -3
  497. data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +11 -0
  498. data/lib/elasticsearch/api/actions/update.rb +19 -7
  499. data/lib/elasticsearch/api/actions/update_by_query.rb +75 -55
  500. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +12 -1
  501. data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +15 -3
  502. data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +12 -1
  503. data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +12 -1
  504. data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +14 -3
  505. data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +13 -1
  506. data/lib/elasticsearch/api/actions/watcher/get_settings.rb +13 -2
  507. data/lib/elasticsearch/api/actions/watcher/get_watch.rb +12 -1
  508. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +17 -6
  509. data/lib/elasticsearch/api/actions/watcher/query_watches.rb +13 -2
  510. data/lib/elasticsearch/api/actions/watcher/start.rb +11 -0
  511. data/lib/elasticsearch/api/actions/watcher/stats.rb +12 -1
  512. data/lib/elasticsearch/api/actions/watcher/stop.rb +12 -1
  513. data/lib/elasticsearch/api/actions/watcher/update_settings.rb +16 -5
  514. data/lib/elasticsearch/api/actions/xpack/info.rb +12 -1
  515. data/lib/elasticsearch/api/actions/xpack/usage.rb +12 -1
  516. data/lib/elasticsearch/api/version.rb +2 -2
  517. data/lib/elasticsearch/api.rb +2 -0
  518. metadata +5 -4
@@ -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,12 +133,23 @@ 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
+ # `"eixsts_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
  #
@@ -27,7 +27,18 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Integer] :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
+ # `"eixsts_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
44
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-by-query-rethrottle
@@ -27,10 +27,21 @@ 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
+ # `"eixsts_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
47
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-script
@@ -27,6 +27,17 @@ 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
+ # `"eixsts_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
43
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-delete-policy
@@ -27,7 +27,18 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String] :name Enrich policy to execute. (*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] :wait_for_completion If +true+, the request blocks other enrich policy execution requests until complete. Server default: true.
30
+ # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks other enrich policy execution requests until complete. Server default: true.
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
+ # `"eixsts_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
44
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-execute-policy
@@ -28,6 +28,17 @@ module Elasticsearch
28
28
  # @option arguments [String, Array<String>] :name Comma-separated list of enrich policy names used to limit the request.
29
29
  # To return information for all enrich policies, omit this parameter.
30
30
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
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
+ # `"eixsts_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
44
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-get-policy
@@ -27,6 +27,17 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String] :name Name of the enrich policy to create or update. (*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
+ # `"eixsts_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
  # @option arguments [Hash] :body request body
32
43
  #
@@ -26,6 +26,17 @@ module Elasticsearch
26
26
  # Returns enrich coordinator statistics and information about enrich policies that are currently executing.
27
27
  #
28
28
  # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
29
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
30
+ # when they occur.
31
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
32
+ # returned by Elasticsearch.
33
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
34
+ # For example `"exists_time": "1h"` for humans and
35
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
36
+ # readable values will be omitted. This makes sense for responses being consumed
37
+ # only by machines.
38
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
39
+ # this option for debugging only.
29
40
  # @option arguments [Hash] :headers Custom HTTP headers
30
41
  #
31
42
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-stats
@@ -28,7 +28,18 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :id Identifier for the search to delete.
30
30
  # A search ID is provided in the EQL search API's response for an async search.
31
- # A search ID is also provided if the request’s +keep_on_completion+ parameter is +true+. (*Required*)
31
+ # A search ID is also provided if the request’s `keep_on_completion` parameter is `true`. (*Required*)
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
+ # `"eixsts_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
45
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-delete
@@ -52,7 +63,7 @@ module Elasticsearch
52
63
 
53
64
  method = Elasticsearch::API::HTTP_DELETE
54
65
  path = "_eql/search/#{Utils.listify(_id)}"
55
- params = {}
66
+ params = Utils.process_params(arguments)
56
67
 
57
68
  Elasticsearch::API::Response.new(
58
69
  perform_request(method, path, params, body, headers, request_opts)
@@ -30,6 +30,17 @@ module Elasticsearch
30
30
  # Defaults to the keep_alive value set by the search’s EQL search API request.
31
31
  # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish.
32
32
  # Defaults to no timeout, meaning the request waits for complete search results.
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
+ # `"eixsts_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
46
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get
@@ -26,6 +26,17 @@ module Elasticsearch
26
26
  # Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
27
27
  #
28
28
  # @option arguments [String] :id Identifier for the search. (*Required*)
29
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
30
+ # when they occur.
31
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
32
+ # returned by Elasticsearch.
33
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
34
+ # For example `"exists_time": "1h"` for humans and
35
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
36
+ # readable values will be omitted. This makes sense for responses being consumed
37
+ # only by machines.
38
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
39
+ # this option for debugging only.
29
40
  # @option arguments [Hash] :headers Custom HTTP headers
30
41
  #
31
42
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get-status
@@ -49,7 +60,7 @@ module Elasticsearch
49
60
 
50
61
  method = Elasticsearch::API::HTTP_GET
51
62
  path = "_eql/search/status/#{Utils.listify(_id)}"
52
- params = {}
63
+ params = Utils.process_params(arguments)
53
64
 
54
65
  Elasticsearch::API::Response.new(
55
66
  perform_request(method, path, params, body, headers, request_opts)
@@ -27,15 +27,27 @@ module Elasticsearch
27
27
  # EQL assumes each document in a data stream or index corresponds to an event.
28
28
  #
29
29
  # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
30
- # @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
30
+ # @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) Server default: true.
31
31
  # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
32
32
  # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
33
33
  # This flag has effect only if allow_partial_search_results is true.
34
- # @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
34
+ # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
35
+ # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true.
35
36
  # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
36
37
  # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
37
38
  # @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.
38
39
  # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.
40
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
41
+ # when they occur.
42
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
43
+ # returned by Elasticsearch.
44
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
45
+ # For example `"exists_time": "1h"` for humans and
46
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
47
+ # readable values will be omitted. This makes sense for responses being consumed
48
+ # only by machines.
49
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
50
+ # this option for debugging only.
39
51
  # @option arguments [Hash] :headers Custom HTTP headers
40
52
  # @option arguments [Hash] :body request body
41
53
  #
@@ -28,19 +28,20 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :delimiter The character to use between values within a CSV row.
30
30
  # It is valid only for the CSV format.
31
- # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.
32
- # If +true+, the response will include an extra section under the name +all_columns+ which has the name of all the columns.
33
- # @option arguments [String] :format A short version of the Accept header, for example +json+ or +yaml+.
34
- # @option arguments [Time] :keep_alive The period for which the query and its results are stored in the cluster.
35
- # The default period is five days.
36
- # When this period expires, the query and its results are deleted, even if the query is still ongoing.
37
- # If the +keep_on_completion+ parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the +wait_for_completion_timeout+ parameter, regardless of this value. Server default: 5d.
38
- # @option arguments [Boolean] :keep_on_completion Indicates whether the query and its results are stored in the cluster.
39
- # If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the +wait_for_completion_timeout+ parameter.
40
- # @option arguments [Time] :wait_for_completion_timeout The period to wait for the request to finish.
41
- # By default, the request waits for 1 second for the query results.
42
- # If the query completes during this period, results are returned
43
- # Otherwise, a query ID is returned that can later be used to retrieve the results. Server default: 1s.
31
+ # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
32
+ # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
33
+ # @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`.
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
+ # `"eixsts_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.
44
45
  # @option arguments [Hash] :headers Custom HTTP headers
45
46
  # @option arguments [Hash] :body request body
46
47
  #
@@ -27,11 +27,22 @@ module Elasticsearch
27
27
  # Otherwise, the stored results are deleted.
28
28
  # If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:
29
29
  # * The authenticated user that submitted the original query request
30
- # * Users with the +cancel_task+ cluster privilege
30
+ # * Users with the `cancel_task` cluster privilege
31
31
  #
32
32
  # @option arguments [String] :id The unique identifier of the query.
33
33
  # A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.
34
- # A query ID is also provided when the request was submitted with the +keep_on_completion+ parameter set to +true+. (*Required*)
34
+ # A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*)
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
+ # `"eixsts_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
48
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-delete
@@ -55,7 +66,7 @@ module Elasticsearch
55
66
 
56
67
  method = Elasticsearch::API::HTTP_DELETE
57
68
  path = "_query/async/#{Utils.listify(_id)}"
58
- params = {}
69
+ params = Utils.process_params(arguments)
59
70
 
60
71
  Elasticsearch::API::Response.new(
61
72
  perform_request(method, path, params, body, headers, request_opts)
@@ -28,15 +28,27 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :id The unique identifier of the query.
30
30
  # A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.
31
- # A query ID is also provided when the request was submitted with the +keep_on_completion+ parameter set to +true+. (*Required*)
32
- # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.
33
- # If +true+, the response will include an extra section under the name +all_columns+ which has the name of all the columns.
31
+ # A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*)
32
+ # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
33
+ # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
34
+ # @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`.
34
35
  # @option arguments [Time] :keep_alive The period for which the query and its results are stored in the cluster.
35
36
  # When this period expires, the query and its results are deleted, even if the query is still ongoing.
36
37
  # @option arguments [Time] :wait_for_completion_timeout The period to wait for the request to finish.
37
38
  # By default, the request waits for complete query results.
38
39
  # If the request completes during the period specified in this parameter, complete query results are returned.
39
- # Otherwise, the response returns an +is_running+ value of +true+ and no results.
40
+ # Otherwise, the response returns an `is_running` value of `true` and no results.
41
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
42
+ # when they occur.
43
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
44
+ # returned by Elasticsearch.
45
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
46
+ # For example `"exists_time": "1h"` for humans and
47
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
48
+ # readable values will be omitted. This makes sense for responses being consumed
49
+ # only by machines.
50
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
51
+ # this option for debugging only.
40
52
  # @option arguments [Hash] :headers Custom HTTP headers
41
53
  #
42
54
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-get
@@ -28,9 +28,20 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :id The unique identifier of the query.
30
30
  # A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.
31
- # A query ID is also provided when the request was submitted with the +keep_on_completion+ parameter set to +true+. (*Required*)
32
- # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely +null+ will be removed from the +columns+ and +values+ portion of the results.
33
- # If +true+, the response will include an extra section under the name +all_columns+ which has the name of all the columns.
31
+ # A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*)
32
+ # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
33
+ # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
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
+ # `"eixsts_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
47
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-stop
@@ -30,8 +30,19 @@ module Elasticsearch
30
30
  #
31
31
  # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.
32
32
  # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
33
- # @option arguments [Boolean] :drop_null_columns Should columns that are entirely +null+ be removed from the +columns+ and +values+ portion of the results?
34
- # Defaults to +false+. If +true+ then the response will include an extra section under the name +all_columns+ which has the name of all columns.
33
+ # @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
34
+ # Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.
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
+ # `"eixsts_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
  # @option arguments [Hash] :body request body
37
48
  #