elasticsearch-api 9.0.3 → 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 (517) 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 +23 -12
  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 +13 -2
  282. data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +18 -7
  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 +13 -2
  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. metadata +5 -4
@@ -28,7 +28,18 @@ module Elasticsearch
28
28
  # @option arguments [String] :name The auto-follow pattern collection to delete. (*Required*)
29
29
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
30
30
  # If the master node is not available before the timeout expires, the request fails and returns an error.
31
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
31
+ # It can also be set to `-1` to indicate that the request should never timeout. 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
+ # `"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-ccr-delete-auto-follow-pattern
@@ -32,6 +32,17 @@ module Elasticsearch
32
32
  # active.
33
33
  # A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the
34
34
  # remote Lucene segment files to the follower index.
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
  #
@@ -29,7 +29,18 @@ module Elasticsearch
29
29
  # @option arguments [String, Array] :index A comma-delimited list of follower index patterns. (*Required*)
30
30
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
31
31
  # If the master node is not available before the timeout expires, the request fails and returns an error.
32
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
32
+ # It can also be set to `-1` to indicate that the request should never timeout. 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
+ # `"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-ccr-follow-info
@@ -29,6 +29,17 @@ module Elasticsearch
29
29
  # @option arguments [String, Array] :index A comma-delimited list of index patterns. (*Required*)
30
30
  # @option arguments [Time] :timeout The period to wait for a response.
31
31
  # 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
+ # `"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-ccr-follow-stats
@@ -35,6 +35,17 @@ module Elasticsearch
35
35
  #
36
36
  # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed (*Required*)
37
37
  # @option arguments [Time] :timeout 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.
38
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
39
+ # when they occur.
40
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
41
+ # returned by Elasticsearch.
42
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
43
+ # For example `"exists_time": "1h"` for humans and
44
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
45
+ # readable values will be omitted. This makes sense for responses being consumed
46
+ # only by machines.
47
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
48
+ # this option for debugging only.
38
49
  # @option arguments [Hash] :headers Custom HTTP headers
39
50
  # @option arguments [Hash] :body request body
40
51
  #
@@ -29,7 +29,18 @@ module Elasticsearch
29
29
  # If you do not specify a name, the API returns information for all collections.
30
30
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
31
31
  # If the master node is not available before the timeout expires, the request fails and returns an error.
32
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
32
+ # It can also be set to `-1` to indicate that the request should never timeout. 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
+ # `"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-ccr-get-auto-follow-pattern-1
@@ -33,7 +33,18 @@ module Elasticsearch
33
33
  # @option arguments [String] :name The name of the auto-follow pattern to pause. (*Required*)
34
34
  # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
35
35
  # If the master node is not available before the timeout expires, the request fails and returns an error.
36
- # It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
36
+ # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
37
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
38
+ # when they occur.
39
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
40
+ # returned by Elasticsearch.
41
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
42
+ # For example `"exists_time": "1h"` for humans and
43
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
44
+ # readable values will be omitted. This makes sense for responses being consumed
45
+ # only by machines.
46
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
47
+ # this option for debugging only.
37
48
  # @option arguments [Hash] :headers Custom HTTP headers
38
49
  #
39
50
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-auto-follow-pattern
@@ -31,7 +31,18 @@ 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
+ # `"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-ccr-pause-follow
@@ -31,6 +31,17 @@ 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
+ # `"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
  # @option arguments [Hash] :body request body
36
47
  #
@@ -30,7 +30,18 @@ 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
+ # `"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-ccr-resume-auto-follow-pattern
@@ -30,6 +30,17 @@ 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
+ # `"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
  # @option arguments [Hash] :body request body
35
46
  #
@@ -27,8 +27,19 @@ 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
+ # `"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-ccr-stats
@@ -30,7 +30,18 @@ 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
+ # `"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-ccr-unfollow
@@ -24,12 +24,23 @@ 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
+ # `"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-dangling-indices-delete-dangling-index
@@ -24,13 +24,24 @@ 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
+ # `"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-dangling-indices-import-dangling-index
@@ -24,9 +24,20 @@ 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
+ # `"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-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,8 +64,19 @@ 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
+ # `"eixsts_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
82
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete