elasticsearch-api 9.0.3 → 9.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (533) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/lib/elasticsearch/api/actions/async_search/delete.rb +14 -3
  4. data/lib/elasticsearch/api/actions/async_search/get.rb +13 -2
  5. data/lib/elasticsearch/api/actions/async_search/status.rb +13 -2
  6. data/lib/elasticsearch/api/actions/async_search/submit.rb +17 -6
  7. data/lib/elasticsearch/api/actions/bulk.rb +86 -63
  8. data/lib/elasticsearch/api/actions/cat/aliases.rb +20 -9
  9. data/lib/elasticsearch/api/actions/cat/allocation.rb +19 -8
  10. data/lib/elasticsearch/api/actions/cat/component_templates.rb +19 -8
  11. data/lib/elasticsearch/api/actions/cat/count.rb +19 -8
  12. data/lib/elasticsearch/api/actions/cat/fielddata.rb +17 -6
  13. data/lib/elasticsearch/api/actions/cat/health.rb +20 -9
  14. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  15. data/lib/elasticsearch/api/actions/cat/indices.rb +18 -7
  16. data/lib/elasticsearch/api/actions/cat/master.rb +19 -8
  17. data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +16 -5
  18. data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +19 -8
  19. data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +20 -9
  20. data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +18 -7
  21. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +19 -8
  22. data/lib/elasticsearch/api/actions/cat/nodes.rb +23 -11
  23. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +19 -8
  24. data/lib/elasticsearch/api/actions/cat/plugins.rb +19 -8
  25. data/lib/elasticsearch/api/actions/cat/recovery.rb +24 -12
  26. data/lib/elasticsearch/api/actions/cat/repositories.rb +19 -8
  27. data/lib/elasticsearch/api/actions/cat/segments.rb +24 -12
  28. data/lib/elasticsearch/api/actions/cat/shards.rb +22 -11
  29. data/lib/elasticsearch/api/actions/cat/snapshots.rb +21 -9
  30. data/lib/elasticsearch/api/actions/cat/tasks.rb +19 -8
  31. data/lib/elasticsearch/api/actions/cat/templates.rb +19 -8
  32. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +21 -10
  33. data/lib/elasticsearch/api/actions/cat/transforms.rb +18 -7
  34. data/lib/elasticsearch/api/actions/clear_scroll.rb +13 -2
  35. data/lib/elasticsearch/api/actions/close_point_in_time.rb +15 -4
  36. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +13 -1
  37. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +12 -1
  38. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +12 -1
  39. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +12 -1
  40. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +17 -5
  41. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +14 -3
  42. data/lib/elasticsearch/api/actions/cluster/health.rb +13 -2
  43. data/lib/elasticsearch/api/actions/cluster/info.rb +13 -2
  44. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +14 -3
  45. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +16 -5
  46. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +20 -8
  47. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +17 -6
  48. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +13 -2
  49. data/lib/elasticsearch/api/actions/cluster/reroute.rb +16 -5
  50. data/lib/elasticsearch/api/actions/cluster/state.rb +15 -4
  51. data/lib/elasticsearch/api/actions/cluster/stats.rb +13 -2
  52. data/lib/elasticsearch/api/actions/connector/check_in.rb +14 -3
  53. data/lib/elasticsearch/api/actions/connector/delete.rb +12 -1
  54. data/lib/elasticsearch/api/actions/connector/get.rb +12 -1
  55. data/lib/elasticsearch/api/actions/connector/list.rb +12 -1
  56. data/lib/elasticsearch/api/actions/connector/post.rb +13 -2
  57. data/lib/elasticsearch/api/actions/connector/put.rb +13 -2
  58. data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +14 -3
  59. data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +14 -3
  60. data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +15 -4
  61. data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +13 -2
  62. data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +14 -3
  63. data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +13 -2
  64. data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +13 -2
  65. data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +13 -2
  66. data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +15 -4
  67. data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +13 -2
  68. data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +14 -3
  69. data/lib/elasticsearch/api/actions/connector/update_configuration.rb +13 -2
  70. data/lib/elasticsearch/api/actions/connector/update_error.rb +13 -2
  71. data/lib/elasticsearch/api/actions/connector/update_features.rb +13 -2
  72. data/lib/elasticsearch/api/actions/connector/update_filtering.rb +13 -2
  73. data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +13 -2
  74. data/lib/elasticsearch/api/actions/connector/update_index_name.rb +14 -3
  75. data/lib/elasticsearch/api/actions/connector/update_name.rb +13 -2
  76. data/lib/elasticsearch/api/actions/connector/update_native.rb +13 -2
  77. data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +13 -2
  78. data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +13 -2
  79. data/lib/elasticsearch/api/actions/connector/update_service_type.rb +13 -2
  80. data/lib/elasticsearch/api/actions/connector/update_status.rb +13 -2
  81. data/lib/elasticsearch/api/actions/count.rb +29 -18
  82. data/lib/elasticsearch/api/actions/create.rb +44 -41
  83. data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +13 -2
  84. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +12 -1
  85. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +13 -2
  86. data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +12 -1
  87. data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +12 -1
  88. data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +13 -2
  89. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +13 -2
  90. data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +13 -2
  91. data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +12 -1
  92. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +13 -2
  93. data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +12 -1
  94. data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +13 -2
  95. data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +13 -2
  96. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +13 -2
  97. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +13 -2
  98. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -3
  99. data/lib/elasticsearch/api/actions/delete.rb +25 -12
  100. data/lib/elasticsearch/api/actions/delete_by_query.rb +63 -48
  101. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +14 -3
  102. data/lib/elasticsearch/api/actions/delete_script.rb +14 -3
  103. data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +12 -1
  104. data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +13 -2
  105. data/lib/elasticsearch/api/actions/enrich/get_policy.rb +12 -1
  106. data/lib/elasticsearch/api/actions/enrich/put_policy.rb +12 -1
  107. data/lib/elasticsearch/api/actions/enrich/stats.rb +12 -1
  108. data/lib/elasticsearch/api/actions/eql/delete.rb +14 -3
  109. data/lib/elasticsearch/api/actions/eql/get.rb +12 -1
  110. data/lib/elasticsearch/api/actions/eql/get_status.rb +13 -2
  111. data/lib/elasticsearch/api/actions/eql/search.rb +15 -3
  112. data/lib/elasticsearch/api/actions/esql/async_query.rb +17 -14
  113. data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +15 -4
  114. data/lib/elasticsearch/api/actions/esql/async_query_get.rb +17 -5
  115. data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +15 -4
  116. data/lib/elasticsearch/api/actions/esql/get_query.rb +76 -0
  117. data/lib/elasticsearch/api/actions/esql/list_queries.rb +66 -0
  118. data/lib/elasticsearch/api/actions/esql/query.rb +15 -2
  119. data/lib/elasticsearch/api/actions/exists.rb +31 -18
  120. data/lib/elasticsearch/api/actions/exists_source.rb +21 -8
  121. data/lib/elasticsearch/api/actions/explain.rb +25 -14
  122. data/lib/elasticsearch/api/actions/features/get_features.rb +13 -2
  123. data/lib/elasticsearch/api/actions/features/reset_features.rb +12 -1
  124. data/lib/elasticsearch/api/actions/field_caps.rb +18 -7
  125. data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +17 -6
  126. data/lib/elasticsearch/api/actions/fleet/msearch.rb +15 -4
  127. data/lib/elasticsearch/api/actions/fleet/search.rb +15 -4
  128. data/lib/elasticsearch/api/actions/get.rb +48 -29
  129. data/lib/elasticsearch/api/actions/get_script.rb +13 -2
  130. data/lib/elasticsearch/api/actions/get_script_context.rb +13 -2
  131. data/lib/elasticsearch/api/actions/get_script_languages.rb +13 -2
  132. data/lib/elasticsearch/api/actions/get_source.rb +24 -11
  133. data/lib/elasticsearch/api/actions/graph/explore.rb +13 -2
  134. data/lib/elasticsearch/api/actions/health_report.rb +13 -2
  135. data/lib/elasticsearch/api/actions/index.rb +55 -43
  136. data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +12 -1
  137. data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +14 -3
  138. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +12 -1
  139. data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +13 -2
  140. data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +14 -3
  141. data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +14 -3
  142. data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +12 -1
  143. data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +13 -2
  144. data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +13 -2
  145. data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +12 -1
  146. data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +12 -1
  147. data/lib/elasticsearch/api/actions/indices/add_block.rb +20 -9
  148. data/lib/elasticsearch/api/actions/indices/analyze.rb +15 -4
  149. data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +13 -2
  150. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +24 -14
  151. data/lib/elasticsearch/api/actions/indices/clone.rb +17 -6
  152. data/lib/elasticsearch/api/actions/indices/close.rb +19 -9
  153. data/lib/elasticsearch/api/actions/indices/create.rb +24 -13
  154. data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +15 -4
  155. data/lib/elasticsearch/api/actions/indices/create_from.rb +13 -2
  156. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +15 -4
  157. data/lib/elasticsearch/api/actions/indices/delete.rb +17 -7
  158. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +14 -3
  159. data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +13 -2
  160. data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +14 -3
  161. data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +75 -0
  162. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +12 -1
  163. data/lib/elasticsearch/api/actions/indices/delete_template.rb +14 -2
  164. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +21 -10
  165. data/lib/elasticsearch/api/actions/indices/downsample.rb +15 -4
  166. data/lib/elasticsearch/api/actions/indices/exists.rb +19 -9
  167. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +18 -8
  168. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +12 -1
  169. data/lib/elasticsearch/api/actions/indices/exists_template.rb +14 -3
  170. data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +12 -1
  171. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +16 -5
  172. data/lib/elasticsearch/api/actions/indices/flush.rb +20 -10
  173. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +23 -11
  174. data/lib/elasticsearch/api/actions/indices/get.rb +12 -1
  175. data/lib/elasticsearch/api/actions/indices/get_alias.rb +19 -9
  176. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +16 -6
  177. data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +13 -2
  178. data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +14 -3
  179. data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +77 -0
  180. data/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb +75 -0
  181. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -10
  182. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +12 -1
  183. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +18 -8
  184. data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +13 -2
  185. data/lib/elasticsearch/api/actions/indices/get_settings.rb +24 -13
  186. data/lib/elasticsearch/api/actions/indices/get_template.rb +17 -6
  187. data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +13 -2
  188. data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +13 -2
  189. data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +13 -2
  190. data/lib/elasticsearch/api/actions/indices/open.rb +23 -13
  191. data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +12 -1
  192. data/lib/elasticsearch/api/actions/indices/put_alias.rb +13 -2
  193. data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +15 -5
  194. data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +82 -0
  195. data/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb +85 -0
  196. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +17 -6
  197. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +26 -25
  198. data/lib/elasticsearch/api/actions/indices/put_settings.rb +66 -14
  199. data/lib/elasticsearch/api/actions/indices/put_template.rb +14 -3
  200. data/lib/elasticsearch/api/actions/indices/recovery.rb +22 -5
  201. data/lib/elasticsearch/api/actions/indices/refresh.rb +19 -9
  202. data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +15 -4
  203. data/lib/elasticsearch/api/actions/indices/remove_block.rb +93 -0
  204. data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +35 -25
  205. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +17 -7
  206. data/lib/elasticsearch/api/actions/indices/rollover.rb +22 -11
  207. data/lib/elasticsearch/api/actions/indices/segments.rb +17 -7
  208. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +13 -2
  209. data/lib/elasticsearch/api/actions/indices/shrink.rb +14 -3
  210. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +12 -1
  211. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +12 -1
  212. data/lib/elasticsearch/api/actions/indices/split.rb +19 -6
  213. data/lib/elasticsearch/api/actions/indices/stats.rb +19 -8
  214. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +12 -1
  215. data/lib/elasticsearch/api/actions/indices/validate_query.rb +25 -15
  216. data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +18 -1
  217. data/lib/elasticsearch/api/actions/inference/completion.rb +12 -1
  218. data/lib/elasticsearch/api/actions/inference/delete.rb +12 -1
  219. data/lib/elasticsearch/api/actions/inference/get.rb +13 -2
  220. data/lib/elasticsearch/api/actions/inference/inference.rb +12 -1
  221. data/lib/elasticsearch/api/actions/inference/put.rb +33 -8
  222. data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +15 -8
  223. data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +15 -3
  224. data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +16 -9
  225. data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +15 -8
  226. data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +16 -9
  227. data/lib/elasticsearch/api/actions/inference/put_cohere.rb +15 -8
  228. data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
  229. data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +82 -0
  230. data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +16 -4
  231. data/lib/elasticsearch/api/actions/inference/put_elser.rb +15 -3
  232. data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +15 -8
  233. data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +15 -8
  234. data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +43 -19
  235. data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +17 -10
  236. data/lib/elasticsearch/api/actions/inference/put_mistral.rb +16 -10
  237. data/lib/elasticsearch/api/actions/inference/put_openai.rb +16 -9
  238. data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +15 -3
  239. data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +17 -11
  240. data/lib/elasticsearch/api/actions/inference/rerank.rb +13 -2
  241. data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +12 -1
  242. data/lib/elasticsearch/api/actions/inference/stream_completion.rb +15 -3
  243. data/lib/elasticsearch/api/actions/inference/text_embedding.rb +12 -1
  244. data/lib/elasticsearch/api/actions/inference/update.rb +14 -3
  245. data/lib/elasticsearch/api/actions/info.rb +14 -2
  246. data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +12 -1
  247. data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +14 -3
  248. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +13 -2
  249. data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
  250. data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +15 -4
  251. data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +14 -6
  252. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +14 -3
  253. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
  254. data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +12 -1
  255. data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +14 -3
  256. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
  257. data/lib/elasticsearch/api/actions/ingest/simulate.rb +14 -3
  258. data/lib/elasticsearch/api/actions/license/delete.rb +12 -1
  259. data/lib/elasticsearch/api/actions/license/get.rb +14 -3
  260. data/lib/elasticsearch/api/actions/license/get_basic_status.rb +13 -2
  261. data/lib/elasticsearch/api/actions/license/get_trial_status.rb +13 -2
  262. data/lib/elasticsearch/api/actions/license/post.rb +12 -1
  263. data/lib/elasticsearch/api/actions/license/post_start_basic.rb +13 -2
  264. data/lib/elasticsearch/api/actions/license/post_start_trial.rb +13 -2
  265. data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +13 -2
  266. data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +13 -2
  267. data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +13 -2
  268. data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +13 -2
  269. data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +16 -5
  270. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +13 -2
  271. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +13 -2
  272. data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +13 -2
  273. data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +13 -2
  274. data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +12 -1
  275. data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +14 -3
  276. data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +13 -2
  277. data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +15 -4
  278. data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +12 -1
  279. data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +14 -3
  280. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +12 -1
  281. data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +14 -3
  282. data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +13 -2
  283. data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +13 -2
  284. data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +13 -2
  285. data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +14 -3
  286. data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +14 -3
  287. data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +16 -5
  288. data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +14 -3
  289. data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +13 -2
  290. data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +12 -1
  291. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +14 -3
  292. data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +14 -3
  293. data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +19 -8
  294. data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +18 -7
  295. data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +12 -1
  296. data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +14 -3
  297. data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
  298. data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +15 -4
  299. data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +14 -3
  300. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +14 -3
  301. data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +14 -3
  302. data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +31 -20
  303. data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +13 -2
  304. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +13 -2
  305. data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +12 -1
  306. data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +12 -1
  307. data/lib/elasticsearch/api/actions/machine_learning/info.rb +13 -2
  308. data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +12 -1
  309. data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +13 -2
  310. data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +12 -1
  311. data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +13 -2
  312. data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +12 -1
  313. data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +13 -2
  314. data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +13 -2
  315. data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +14 -3
  316. data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +25 -6
  317. data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +14 -3
  318. data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +19 -13
  319. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +13 -2
  320. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +12 -1
  321. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +14 -3
  322. data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +14 -3
  323. data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +12 -1
  324. data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +13 -2
  325. data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +13 -2
  326. data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +13 -2
  327. data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +19 -8
  328. data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +14 -3
  329. data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +12 -1
  330. data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +17 -6
  331. data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +14 -3
  332. data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
  333. data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +17 -11
  334. data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +13 -2
  335. data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +13 -2
  336. data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +13 -2
  337. data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +12 -1
  338. data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +12 -1
  339. data/lib/elasticsearch/api/actions/mget.rb +25 -14
  340. data/lib/elasticsearch/api/actions/migration/deprecations.rb +13 -2
  341. data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +13 -2
  342. data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +13 -2
  343. data/lib/elasticsearch/api/actions/msearch.rb +28 -11
  344. data/lib/elasticsearch/api/actions/msearch_template.rb +22 -10
  345. data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -10
  346. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +14 -3
  347. data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +13 -2
  348. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +12 -1
  349. data/lib/elasticsearch/api/actions/nodes/info.rb +12 -1
  350. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +12 -1
  351. data/lib/elasticsearch/api/actions/nodes/stats.rb +13 -2
  352. data/lib/elasticsearch/api/actions/nodes/usage.rb +14 -3
  353. data/lib/elasticsearch/api/actions/open_point_in_time.rb +23 -12
  354. data/lib/elasticsearch/api/actions/ping.rb +13 -2
  355. data/lib/elasticsearch/api/actions/put_script.rb +14 -3
  356. data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +13 -2
  357. data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +12 -1
  358. data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +13 -2
  359. data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +13 -2
  360. data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +12 -1
  361. data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +13 -2
  362. data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +15 -4
  363. data/lib/elasticsearch/api/actions/query_rules/test.rb +13 -2
  364. data/lib/elasticsearch/api/actions/rank_eval.rb +16 -5
  365. data/lib/elasticsearch/api/actions/reindex.rb +35 -123
  366. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +17 -4
  367. data/lib/elasticsearch/api/actions/render_search_template.rb +14 -3
  368. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
  369. data/lib/elasticsearch/api/actions/scroll.rb +16 -5
  370. data/lib/elasticsearch/api/actions/search.rb +71 -60
  371. data/lib/elasticsearch/api/actions/search_application/delete.rb +13 -2
  372. data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +13 -2
  373. data/lib/elasticsearch/api/actions/search_application/get.rb +13 -2
  374. data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +13 -2
  375. data/lib/elasticsearch/api/actions/search_application/list.rb +12 -1
  376. data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +12 -1
  377. data/lib/elasticsearch/api/actions/search_application/put.rb +13 -2
  378. data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +13 -2
  379. data/lib/elasticsearch/api/actions/search_application/render_query.rb +15 -4
  380. data/lib/elasticsearch/api/actions/search_application/search.rb +12 -1
  381. data/lib/elasticsearch/api/actions/search_mvt.rb +39 -70
  382. data/lib/elasticsearch/api/actions/search_shards.rb +22 -12
  383. data/lib/elasticsearch/api/actions/search_template.rb +24 -14
  384. data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +12 -1
  385. data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +14 -3
  386. data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +13 -2
  387. data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +12 -1
  388. data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +17 -6
  389. data/lib/elasticsearch/api/actions/security/authenticate.rb +13 -2
  390. data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +13 -2
  391. data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +13 -2
  392. data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +15 -4
  393. data/lib/elasticsearch/api/actions/security/change_password.rb +13 -2
  394. data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +14 -3
  395. data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +14 -3
  396. data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +13 -2
  397. data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +14 -3
  398. data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +17 -6
  399. data/lib/elasticsearch/api/actions/security/create_api_key.rb +13 -2
  400. data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +16 -5
  401. data/lib/elasticsearch/api/actions/security/create_service_token.rb +15 -4
  402. data/lib/elasticsearch/api/actions/security/delegate_pki.rb +15 -4
  403. data/lib/elasticsearch/api/actions/security/delete_privileges.rb +14 -3
  404. data/lib/elasticsearch/api/actions/security/delete_role.rb +13 -2
  405. data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +13 -2
  406. data/lib/elasticsearch/api/actions/security/delete_service_token.rb +13 -2
  407. data/lib/elasticsearch/api/actions/security/delete_user.rb +13 -2
  408. data/lib/elasticsearch/api/actions/security/disable_user.rb +13 -2
  409. data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +12 -1
  410. data/lib/elasticsearch/api/actions/security/enable_user.rb +13 -2
  411. data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +12 -1
  412. data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +13 -2
  413. data/lib/elasticsearch/api/actions/security/enroll_node.rb +13 -2
  414. data/lib/elasticsearch/api/actions/security/get_api_key.rb +20 -9
  415. data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +13 -2
  416. data/lib/elasticsearch/api/actions/security/get_privileges.rb +14 -3
  417. data/lib/elasticsearch/api/actions/security/get_role.rb +12 -1
  418. data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +13 -2
  419. data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +16 -5
  420. data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +15 -4
  421. data/lib/elasticsearch/api/actions/security/get_settings.rb +15 -4
  422. data/lib/elasticsearch/api/actions/security/get_token.rb +15 -4
  423. data/lib/elasticsearch/api/actions/security/get_user.rb +13 -2
  424. data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +12 -4
  425. data/lib/elasticsearch/api/actions/security/get_user_profile.rb +17 -6
  426. data/lib/elasticsearch/api/actions/security/grant_api_key.rb +17 -2
  427. data/lib/elasticsearch/api/actions/security/has_privileges.rb +13 -2
  428. data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +13 -2
  429. data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +21 -10
  430. data/lib/elasticsearch/api/actions/security/invalidate_token.rb +16 -5
  431. data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +13 -2
  432. data/lib/elasticsearch/api/actions/security/oidc_logout.rb +14 -3
  433. data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +13 -2
  434. data/lib/elasticsearch/api/actions/security/put_privileges.rb +18 -7
  435. data/lib/elasticsearch/api/actions/security/put_role.rb +13 -2
  436. data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +16 -5
  437. data/lib/elasticsearch/api/actions/security/put_user.rb +13 -2
  438. data/lib/elasticsearch/api/actions/security/query_api_keys.rb +18 -6
  439. data/lib/elasticsearch/api/actions/security/query_role.rb +13 -2
  440. data/lib/elasticsearch/api/actions/security/query_user.rb +12 -1
  441. data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +14 -3
  442. data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +13 -2
  443. data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +14 -3
  444. data/lib/elasticsearch/api/actions/security/saml_logout.rb +13 -2
  445. data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +16 -5
  446. data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +13 -2
  447. data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +17 -6
  448. data/lib/elasticsearch/api/actions/security/update_api_key.rb +17 -6
  449. data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +17 -5
  450. data/lib/elasticsearch/api/actions/security/update_settings.rb +14 -3
  451. data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +16 -5
  452. data/lib/elasticsearch/api/actions/simulate/ingest.rb +12 -1
  453. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +14 -3
  454. data/lib/elasticsearch/api/actions/snapshot/clone.rb +13 -2
  455. data/lib/elasticsearch/api/actions/snapshot/create.rb +14 -3
  456. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +17 -6
  457. data/lib/elasticsearch/api/actions/snapshot/delete.rb +16 -3
  458. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +15 -4
  459. data/lib/elasticsearch/api/actions/snapshot/get.rb +32 -19
  460. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +16 -5
  461. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +38 -16
  462. data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +113 -0
  463. data/lib/elasticsearch/api/actions/snapshot/restore.rb +19 -6
  464. data/lib/elasticsearch/api/actions/snapshot/status.rb +19 -8
  465. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +14 -3
  466. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +12 -1
  467. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +12 -1
  468. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +12 -1
  469. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +12 -1
  470. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +12 -1
  471. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +14 -3
  472. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +14 -3
  473. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +14 -3
  474. data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +14 -3
  475. data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +13 -2
  476. data/lib/elasticsearch/api/actions/sql/delete_async.rb +14 -3
  477. data/lib/elasticsearch/api/actions/sql/get_async.rb +14 -3
  478. data/lib/elasticsearch/api/actions/sql/get_async_status.rb +13 -2
  479. data/lib/elasticsearch/api/actions/sql/query.rb +14 -3
  480. data/lib/elasticsearch/api/actions/sql/translate.rb +14 -3
  481. data/lib/elasticsearch/api/actions/ssl/certificates.rb +15 -4
  482. data/lib/elasticsearch/api/actions/streams/logs_disable.rb +50 -0
  483. data/lib/elasticsearch/api/actions/streams/logs_enable.rb +50 -0
  484. data/lib/elasticsearch/api/actions/streams/status.rb +50 -0
  485. data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +13 -2
  486. data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +15 -2
  487. data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +12 -1
  488. data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +13 -2
  489. data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +12 -1
  490. data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +16 -2
  491. data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +15 -2
  492. data/lib/elasticsearch/api/actions/tasks/cancel.rb +15 -4
  493. data/lib/elasticsearch/api/actions/tasks/get.rb +13 -2
  494. data/lib/elasticsearch/api/actions/tasks/list.rb +30 -15
  495. data/lib/elasticsearch/api/actions/terms_enum.rb +15 -4
  496. data/lib/elasticsearch/api/actions/termvectors.rb +28 -15
  497. data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +53 -42
  498. data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +53 -42
  499. data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +45 -45
  500. data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +13 -2
  501. data/lib/elasticsearch/api/actions/transform/delete_transform.rb +12 -1
  502. data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
  503. data/lib/elasticsearch/api/actions/transform/get_transform.rb +14 -3
  504. data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +14 -3
  505. data/lib/elasticsearch/api/actions/transform/preview_transform.rb +12 -1
  506. data/lib/elasticsearch/api/actions/transform/put_transform.rb +19 -8
  507. data/lib/elasticsearch/api/actions/transform/reset_transform.rb +14 -3
  508. data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +13 -2
  509. data/lib/elasticsearch/api/actions/transform/start_transform.rb +15 -4
  510. data/lib/elasticsearch/api/actions/transform/stop_transform.rb +15 -4
  511. data/lib/elasticsearch/api/actions/transform/update_transform.rb +15 -4
  512. data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +12 -1
  513. data/lib/elasticsearch/api/actions/update.rb +20 -8
  514. data/lib/elasticsearch/api/actions/update_by_query.rb +76 -56
  515. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +13 -2
  516. data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +16 -4
  517. data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +13 -2
  518. data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +13 -2
  519. data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +15 -4
  520. data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +14 -2
  521. data/lib/elasticsearch/api/actions/watcher/get_settings.rb +14 -3
  522. data/lib/elasticsearch/api/actions/watcher/get_watch.rb +13 -2
  523. data/lib/elasticsearch/api/actions/watcher/put_watch.rb +18 -7
  524. data/lib/elasticsearch/api/actions/watcher/query_watches.rb +14 -3
  525. data/lib/elasticsearch/api/actions/watcher/start.rb +12 -1
  526. data/lib/elasticsearch/api/actions/watcher/stats.rb +13 -2
  527. data/lib/elasticsearch/api/actions/watcher/stop.rb +13 -2
  528. data/lib/elasticsearch/api/actions/watcher/update_settings.rb +17 -6
  529. data/lib/elasticsearch/api/actions/xpack/info.rb +13 -2
  530. data/lib/elasticsearch/api/actions/xpack/usage.rb +13 -2
  531. data/lib/elasticsearch/api/version.rb +2 -2
  532. data/lib/elasticsearch/api.rb +1 -0
  533. metadata +18 -4
@@ -38,33 +38,33 @@ module Elasticsearch
38
38
  #
39
39
  # @option arguments [String] :charset The text's character set.
40
40
  # It must be a character set that is supported by the JVM that Elasticsearch uses.
41
- # For example, +UTF-8+, +UTF-16LE+, +windows-1252+, or +EUC-JP+.
41
+ # For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.
42
42
  # If this parameter is not specified, the structure finder chooses an appropriate character set.
43
- # @option arguments [String] :column_names If you have set format to +delimited+, you can specify the column names in a comma-separated list.
43
+ # @option arguments [String] :column_names If you have set format to `delimited`, you can specify the column names in a comma-separated list.
44
44
  # If this parameter is not specified, the structure finder uses the column names from the header row of the text.
45
45
  # If the text does not have a header role, columns are named "column1", "column2", "column3", for example.
46
- # @option arguments [String] :delimiter If you have set +format+ to +delimited+, you can specify the character used to delimit the values in each row.
46
+ # @option arguments [String] :delimiter If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.
47
47
  # Only a single character is supported; the delimiter cannot have multiple characters.
48
- # By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (+|+).
48
+ # By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).
49
49
  # In this default scenario, all rows must have the same number of fields for the delimited format to be detected.
50
50
  # If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.
51
51
  # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns.
52
52
  # Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.
53
- # Valid values are +disabled+ and +v1+.
54
- # This setting primarily has an impact when a whole message Grok pattern such as +%{CATALINALOG}+ matches the input.
55
- # If the structure finder identifies a common structure but has no idea of meaning then generic field names such as +path+, +ipaddress+, +field1+, and +field2+ are used in the +grok_pattern+ output, with the intention that a user who knows the meanings rename these fields before using it. Server default: disabled.
56
- # @option arguments [Boolean] :explain If this parameter is set to +true+, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.
53
+ # Valid values are `disabled` and `v1`.
54
+ # This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.
55
+ # If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. Server default: disabled.
56
+ # @option arguments [Boolean] :explain If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.
57
57
  # If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.
58
58
  # @option arguments [String] :format The high level structure of the text.
59
- # Valid values are +ndjson+, +xml+, +delimited+, and +semi_structured_text+.
59
+ # Valid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`.
60
60
  # By default, the API chooses the format.
61
61
  # In this default scenario, all rows must have the same number of fields for a delimited format to be detected.
62
- # If the format is set to +delimited+ and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.
63
- # @option arguments [String] :grok_pattern If you have set +format+ to +semi_structured_text+, you can specify a Grok pattern that is used to extract fields from every message in the text.
64
- # The name of the timestamp field in the Grok pattern must match what is specified in the +timestamp_field+ parameter.
62
+ # If the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.
63
+ # @option arguments [String] :grok_pattern If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.
64
+ # The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.
65
65
  # If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp".
66
- # If +grok_pattern+ is not specified, the structure finder creates a Grok pattern.
67
- # @option arguments [Boolean] :has_header_row If you have set +format+ to +delimited+, you can use this parameter to indicate whether the column names are in the first row of the text.
66
+ # If `grok_pattern` is not specified, the structure finder creates a Grok pattern.
67
+ # @option arguments [Boolean] :has_header_row If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text.
68
68
  # If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.
69
69
  # @option arguments [Integer] :line_merge_size_limit The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.
70
70
  # If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected. Server default: 10000.
@@ -73,48 +73,48 @@ module Elasticsearch
73
73
  # If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.NOTE: The number of lines and the variation of the lines affects the speed of the analysis.
74
74
  # For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.
75
75
  # If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety. Server default: 1000.
76
- # @option arguments [String] :quote If you have set +format+ to +delimited+, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.
76
+ # @option arguments [String] :quote If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.
77
77
  # Only a single character is supported.
78
- # If this parameter is not specified, the default value is a double quote (+"+).
78
+ # If this parameter is not specified, the default value is a double quote (`"`).
79
79
  # If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.
80
- # @option arguments [Boolean] :should_trim_fields If you have set +format+ to +delimited+, you can specify whether values between delimiters should have whitespace trimmed from them.
81
- # If this parameter is not specified and the delimiter is pipe (+|+), the default value is +true+.
82
- # Otherwise, the default value is +false+.
80
+ # @option arguments [Boolean] :should_trim_fields If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.
81
+ # If this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`.
82
+ # Otherwise, the default value is `false`.
83
83
  # @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take.
84
84
  # If the analysis is still running when the timeout expires then it will be stopped. Server default: 25s.
85
85
  # @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text.
86
- # In particular, if the text were ingested into an index, this is the field that would be used to populate the +@timestamp+ field.If the +format+ is +semi_structured_text+, this field must match the name of the appropriate extraction in the +grok_pattern+.
87
- # Therefore, for semi-structured text, it is best not to specify this parameter unless +grok_pattern+ is also specified.For structured text, if you specify this parameter, the field must exist within the text.If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.
86
+ # In particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.If the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.
87
+ # Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.For structured text, if you specify this parameter, the field must exist within the text.If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.
88
88
  # For structured text, it is not compulsory to have a timestamp in the text.
89
89
  # @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text.Only a subset of Java time format letter groups are supported:
90
- # - +a+
91
- # - +d+
92
- # - +dd+
93
- # - +EEE+
94
- # - +EEEE+
95
- # - +H+
96
- # - +HH+
97
- # - +h+
98
- # - +M+
99
- # - +MM+
100
- # - +MMM+
101
- # - +MMMM+
102
- # - +mm+
103
- # - +ss+
104
- # - +XX+
105
- # - +XXX+
106
- # - +yy+
107
- # - +yyyy+
108
- # - +zzz+
109
- # Additionally +S+ letter groups (fractional seconds) of length one to nine are supported providing they occur after +ss+ and separated from the +ss+ by a +.+, +,+ or +:+.
110
- # Spacing and punctuation is also permitted with the exception of +?+, newline and carriage return, together with literal text enclosed in single quotes.
111
- # For example, +MM/dd HH.mm.ss,SSSSSS 'in' yyyy+ is a valid override format.One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full +grok_pattern+.
112
- # Another is when the timestamp format is one that the structure finder does not consider by default.If this parameter is not specified, the structure finder chooses the best format from a built-in set.If the special value +null+ is specified the structure finder will not look for a primary timestamp in the text.
90
+ # - `a`
91
+ # - `d`
92
+ # - `dd`
93
+ # - `EEE`
94
+ # - `EEEE`
95
+ # - `H`
96
+ # - `HH`
97
+ # - `h`
98
+ # - `M`
99
+ # - `MM`
100
+ # - `MMM`
101
+ # - `MMMM`
102
+ # - `mm`
103
+ # - `ss`
104
+ # - `XX`
105
+ # - `XXX`
106
+ # - `yy`
107
+ # - `yyyy`
108
+ # - `zzz`
109
+ # Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`.
110
+ # Spacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes.
111
+ # For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.
112
+ # Another is when the timestamp format is one that the structure finder does not consider by default.If this parameter is not specified, the structure finder chooses the best format from a built-in set.If the special value `null` is specified the structure finder will not look for a primary timestamp in the text.
113
113
  # When the format is semi-structured text this will result in the structure finder treating the text as single-line messages.
114
114
  # @option arguments [Hash] :headers Custom HTTP headers
115
115
  # @option arguments [Hash] :body text_files
116
116
  #
117
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-structure
117
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure
118
118
  #
119
119
  def find_structure(arguments = {})
120
120
  request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_structure' }
@@ -28,11 +28,22 @@ module Elasticsearch
28
28
  #
29
29
  # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns.
30
30
  # Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.
31
- # Valid values are +disabled+ and +v1+. Server default: disabled.
31
+ # Valid values are `disabled` and `v1`. Server default: disabled.
32
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
33
+ # when they occur.
34
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
35
+ # returned by Elasticsearch.
36
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
37
+ # For example `"exists_time": "1h"` for humans and
38
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
39
+ # readable values will be omitted. This makes sense for responses being consumed
40
+ # only by machines.
41
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
42
+ # this option for debugging only.
32
43
  # @option arguments [Hash] :headers Custom HTTP headers
33
44
  # @option arguments [Hash] :body request body
34
45
  #
35
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-test-grok-pattern
46
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern
36
47
  #
37
48
  def test_grok_pattern(arguments = {})
38
49
  request_opts = { endpoint: arguments[:endpoint] || 'text_structure.test_grok_pattern' }
@@ -30,9 +30,20 @@ module Elasticsearch
30
30
  # @option arguments [Boolean] :delete_dest_index If this value is true, the destination index is deleted together with the transform. If false, the destination
31
31
  # index will not be deleted
32
32
  # @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.
33
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
34
+ # when they occur.
35
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
36
+ # returned by Elasticsearch.
37
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
38
+ # For example `"exists_time": "1h"` for humans and
39
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
40
+ # readable values will be omitted. This makes sense for responses being consumed
41
+ # only by machines.
42
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
43
+ # this option for debugging only.
33
44
  # @option arguments [Hash] :headers Custom HTTP headers
34
45
  #
35
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-delete-transform
46
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform
36
47
  #
37
48
  def delete_transform(arguments = {})
38
49
  request_opts = { endpoint: arguments[:endpoint] || 'transform.delete_transform' }
@@ -34,14 +34,9 @@ module Elasticsearch
34
34
  arguments = arguments.clone
35
35
  headers = arguments.delete(:headers) || {}
36
36
 
37
- body = arguments.delete(:body)
38
-
39
- method = if body
40
- Elasticsearch::API::HTTP_POST
41
- else
42
- Elasticsearch::API::HTTP_GET
43
- end
37
+ body = nil
44
38
 
39
+ method = Elasticsearch::API::HTTP_GET
45
40
  path = '_transform/_node_stats'
46
41
  params = {}
47
42
 
@@ -27,8 +27,8 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array<String>] :transform_id Identifier for the transform. It can be a transform identifier or a
29
29
  # wildcard expression. You can get information for all transforms by using
30
- # +_all+, by specifying +*+ as the +<transform_id>+, or by omitting the
31
- # +<transform_id>+.
30
+ # `_all`, by specifying `*` as the `<transform_id>`, or by omitting the
31
+ # `<transform_id>`.
32
32
  # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
33
33
  # - Contains wildcard expressions and there are no transforms that match.
34
34
  # - Contains the _all string or no identifiers and there are no matches.
@@ -40,9 +40,20 @@ module Elasticsearch
40
40
  # @option arguments [Boolean] :exclude_generated Excludes fields that were automatically added when creating the
41
41
  # transform. This allows the configuration to be in an acceptable format to
42
42
  # be retrieved and then added to another cluster.
43
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44
+ # when they occur.
45
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
46
+ # returned by Elasticsearch.
47
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
48
+ # For example `"exists_time": "1h"` for humans and
49
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
50
+ # readable values will be omitted. This makes sense for responses being consumed
51
+ # only by machines.
52
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
53
+ # this option for debugging only.
43
54
  # @option arguments [Hash] :headers Custom HTTP headers
44
55
  #
45
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform
56
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform
46
57
  #
47
58
  def get_transform(arguments = {})
48
59
  request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform' }
@@ -27,8 +27,8 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [String, Array<String>] :transform_id Identifier for the transform. It can be a transform identifier or a
29
29
  # wildcard expression. You can get information for all transforms by using
30
- # +_all+, by specifying +*+ as the +<transform_id>+, or by omitting the
31
- # +<transform_id>+. (*Required*)
30
+ # `_all`, by specifying `*` as the `<transform_id>`, or by omitting the
31
+ # `<transform_id>`. (*Required*)
32
32
  # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
33
33
  # - Contains wildcard expressions and there are no transforms that match.
34
34
  # - Contains the _all string or no identifiers and there are no matches.
@@ -38,9 +38,20 @@ module Elasticsearch
38
38
  # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
39
39
  # @option arguments [Integer] :size Specifies the maximum number of transforms to obtain. Server default: 100.
40
40
  # @option arguments [Time] :timeout Controls the time to wait for the stats
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
+ # `"exists_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.
41
52
  # @option arguments [Hash] :headers Custom HTTP headers
42
53
  #
43
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform-stats
54
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats
44
55
  #
45
56
  def get_transform_stats(arguments = {})
46
57
  request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform_stats' }
@@ -32,10 +32,21 @@ module Elasticsearch
32
32
  # configuration details in the request body.
33
33
  # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the
34
34
  # timeout expires, the request fails and returns an error. Server default: 30s.
35
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
36
+ # when they occur.
37
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
38
+ # returned by Elasticsearch.
39
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
40
+ # For example `"exists_time": "1h"` for humans and
41
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
42
+ # readable values will be omitted. This makes sense for responses being consumed
43
+ # only by machines.
44
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
45
+ # this option for debugging only.
35
46
  # @option arguments [Hash] :headers Custom HTTP headers
36
47
  # @option arguments [Hash] :body request body
37
48
  #
38
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-preview-transform
49
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform
39
50
  #
40
51
  def preview_transform(arguments = {})
41
52
  request_opts = { endpoint: arguments[:endpoint] || 'transform.preview_transform' }
@@ -28,18 +28,18 @@ module Elasticsearch
28
28
  # a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
29
29
  # unique row per entity.
30
30
  # You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If
31
- # you choose to use the pivot method for your transform, the entities are defined by the set of +group_by+ fields in
32
- # the pivot object. If you choose to use the latest method, the entities are defined by the +unique_key+ field values
31
+ # you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in
32
+ # the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values
33
33
  # in the latest object.
34
- # You must have +create_index+, +index+, and +read+ privileges on the destination index and +read+ and
35
- # +view_index_metadata+ privileges on the source indices. When Elasticsearch security features are enabled, the
34
+ # You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and
35
+ # `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the
36
36
  # transform remembers which roles the user that created it had at the time of creation and uses those same roles. If
37
37
  # those roles do not have the required privileges on the source and destination indices, the transform fails when it
38
38
  # attempts unauthorized operations.
39
39
  # NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any
40
- # +.transform-internal*+ indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
41
- # not give users any privileges on +.transform-internal*+ indices. If you used transforms prior to 7.5, also do not
42
- # give users any privileges on +.data-frame-internal*+ indices.
40
+ # `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do
41
+ # not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not
42
+ # give users any privileges on `.data-frame-internal*` indices.
43
43
  #
44
44
  # @option arguments [String] :transform_id Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
45
45
  # hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (*Required*)
@@ -49,10 +49,21 @@ module Elasticsearch
49
49
  # until after the transform is created. The validations are always run when you start the transform, however, with
50
50
  # the exception of privilege checks.
51
51
  # @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.
52
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
53
+ # when they occur.
54
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
55
+ # returned by Elasticsearch.
56
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
57
+ # For example `"exists_time": "1h"` for humans and
58
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
59
+ # readable values will be omitted. This makes sense for responses being consumed
60
+ # only by machines.
61
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
62
+ # this option for debugging only.
52
63
  # @option arguments [Hash] :headers Custom HTTP headers
53
64
  # @option arguments [Hash] :body request body
54
65
  #
55
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-put-transform
66
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform
56
67
  #
57
68
  def put_transform(arguments = {})
58
69
  request_opts = { endpoint: arguments[:endpoint] || 'transform.put_transform' }
@@ -23,17 +23,28 @@ module Elasticsearch
23
23
  module Transform
24
24
  module Actions
25
25
  # Reset a transform.
26
- # Before you can reset it, you must stop it; alternatively, use the +force+ query parameter.
26
+ # Before you can reset it, you must stop it; alternatively, use the `force` query parameter.
27
27
  # If the destination index was created by the transform, it is deleted.
28
28
  #
29
29
  # @option arguments [String] :transform_id Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
30
30
  # hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (*Required*)
31
- # @option arguments [Boolean] :force If this value is +true+, the transform is reset regardless of its current state. If it's +false+, the transform
31
+ # @option arguments [Boolean] :force If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform
32
32
  # must be stopped before it can be reset.
33
33
  # @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.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  #
36
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-reset-transform
47
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform
37
48
  #
38
49
  def reset_transform(arguments = {})
39
50
  request_opts = { endpoint: arguments[:endpoint] || 'transform.reset_transform' }
@@ -26,14 +26,25 @@ module Elasticsearch
26
26
  # Instantly run a transform to process data.
27
27
  # If you run this API, the transform will process the new data instantly,
28
28
  # without waiting for the configured frequency interval. After the API is called,
29
- # the transform will be processed again at +now + frequency+ unless the API
29
+ # the transform will be processed again at `now + frequency` unless the API
30
30
  # is called again in the meantime.
31
31
  #
32
32
  # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
33
33
  # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place Server default: 30s.
34
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35
+ # when they occur.
36
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
37
+ # returned by Elasticsearch.
38
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39
+ # For example `"exists_time": "1h"` for humans and
40
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
41
+ # readable values will be omitted. This makes sense for responses being consumed
42
+ # only by machines.
43
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44
+ # this option for debugging only.
34
45
  # @option arguments [Hash] :headers Custom HTTP headers
35
46
  #
36
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-schedule-now-transform
47
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform
37
48
  #
38
49
  def schedule_now_transform(arguments = {})
39
50
  request_opts = { endpoint: arguments[:endpoint] || 'transform.schedule_now_transform' }
@@ -23,10 +23,10 @@ module Elasticsearch
23
23
  module Transform
24
24
  module Actions
25
25
  # Start a transform.
26
- # When you start a transform, it creates the destination index if it does not already exist. The +number_of_shards+ is
27
- # set to +1+ and the +auto_expand_replicas+ is set to +0-1+. If it is a pivot transform, it deduces the mapping
26
+ # When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is
27
+ # set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping
28
28
  # definitions for the destination index from the source indices and the transform aggregations. If fields in the
29
- # destination index are derived from scripts (as in the case of +scripted_metric+ or +bucket_script+ aggregations),
29
+ # destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),
30
30
  # the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce
31
31
  # mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you
32
32
  # start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings
@@ -40,9 +40,20 @@ module Elasticsearch
40
40
  # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
41
41
  # @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.
42
42
  # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.
43
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44
+ # when they occur.
45
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
46
+ # returned by Elasticsearch.
47
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
48
+ # For example `"exists_time": "1h"` for humans and
49
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
50
+ # readable values will be omitted. This makes sense for responses being consumed
51
+ # only by machines.
52
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
53
+ # this option for debugging only.
43
54
  # @option arguments [Hash] :headers Custom HTTP headers
44
55
  #
45
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-start-transform
56
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform
46
57
  #
47
58
  def start_transform(arguments = {})
48
59
  request_opts = { endpoint: arguments[:endpoint] || 'transform.start_transform' }
@@ -26,22 +26,33 @@ module Elasticsearch
26
26
  # Stops one or more transforms.
27
27
  #
28
28
  # @option arguments [String] :transform_id Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.
29
- # To stop all transforms, use +_all+ or +*+ as the identifier. (*Required*)
29
+ # To stop all transforms, use `_all` or `*` as the identifier. (*Required*)
30
30
  # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;
31
- # contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there
31
+ # contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there
32
32
  # are only partial matches.If it is true, the API returns a successful acknowledgement message when there are no matches. When there are
33
33
  # only partial matches, the API stops the appropriate transforms.If it is false, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
34
34
  # @option arguments [Boolean] :force If it is true, the API forcefully stops the transforms.
35
- # @option arguments [Time] :timeout Period to wait for a response when +wait_for_completion+ is +true+. If no response is received before the
35
+ # @option arguments [Time] :timeout Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the
36
36
  # timeout expires, the request returns a timeout exception. However, the request continues processing and
37
37
  # eventually moves the transform to a STOPPED state. Server default: 30s.
38
38
  # @option arguments [Boolean] :wait_for_checkpoint If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,
39
39
  # the transform stops as soon as possible.
40
40
  # @option arguments [Boolean] :wait_for_completion If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns
41
41
  # immediately and the indexer is stopped asynchronously in the background.
42
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
43
+ # when they occur.
44
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
45
+ # returned by Elasticsearch.
46
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
47
+ # For example `"exists_time": "1h"` for humans and
48
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
49
+ # readable values will be omitted. This makes sense for responses being consumed
50
+ # only by machines.
51
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
52
+ # this option for debugging only.
42
53
  # @option arguments [Hash] :headers Custom HTTP headers
43
54
  #
44
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-stop-transform
55
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform
45
56
  #
46
57
  def stop_transform(arguments = {})
47
58
  request_opts = { endpoint: arguments[:endpoint] || 'transform.stop_transform' }
@@ -24,9 +24,9 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Update a transform.
26
26
  # Updates certain properties of a transform.
27
- # All updated properties except +description+ do not take effect until after the transform starts the next checkpoint,
28
- # thus there is data consistency in each checkpoint. To use this API, you must have +read+ and +view_index_metadata+
29
- # privileges for the source indices. You must also have +index+ and +read+ privileges for the destination index. When
27
+ # All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
28
+ # thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
29
+ # privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
30
30
  # Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
31
31
  # time of update and runs with those privileges.
32
32
  #
@@ -36,10 +36,21 @@ module Elasticsearch
36
36
  # created.
37
37
  # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the
38
38
  # timeout expires, the request fails and returns an error. Server default: 30s.
39
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
40
+ # when they occur.
41
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
42
+ # returned by Elasticsearch.
43
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
44
+ # For example `"exists_time": "1h"` for humans and
45
+ # `"exists_time_in_millis": 3600000` for computers. When disabled the human
46
+ # readable values will be omitted. This makes sense for responses being consumed
47
+ # only by machines.
48
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
49
+ # this option for debugging only.
39
50
  # @option arguments [Hash] :headers Custom HTTP headers
40
51
  # @option arguments [Hash] :body request body
41
52
  #
42
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-update-transform
53
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform
43
54
  #
44
55
  def update_transform(arguments = {})
45
56
  request_opts = { endpoint: arguments[:endpoint] || 'transform.update_transform' }
@@ -38,9 +38,20 @@ module Elasticsearch
38
38
  # @option arguments [Boolean] :dry_run When true, the request checks for updates but does not run them.
39
39
  # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and
40
40
  # returns an error. Server default: 30s.
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
+ # `"exists_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.
41
52
  # @option arguments [Hash] :headers Custom HTTP headers
42
53
  #
43
- # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-upgrade-transforms
54
+ # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms
44
55
  #
45
56
  def upgrade_transforms(arguments = {})
46
57
  request_opts = { endpoint: arguments[:endpoint] || 'transform.upgrade_transforms' }