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
@@ -30,10 +30,21 @@ module Elasticsearch
30
30
  # For more information, refer to the documentation about controlling the user cache.
31
31
  #
32
32
  # @option arguments [String, Array<String>] :realms A comma-separated list of realms.
33
- # To clear all realms, use an asterisk (+*+).
33
+ # To clear all realms, use an asterisk (`*`).
34
34
  # It does not support other wildcard patterns. (*Required*)
35
35
  # @option arguments [Array<String>] :usernames A comma-separated list of the users to clear from the cache.
36
36
  # If you do not specify this parameter, the API evicts all users from the user cache.
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-security-clear-cached-realms
@@ -26,8 +26,19 @@ module Elasticsearch
26
26
  # Evict roles from the native role cache.
27
27
  #
28
28
  # @option arguments [String, Array<String>] :name A comma-separated list of roles to evict from the role cache.
29
- # To evict all roles, use an asterisk (+*+).
29
+ # To evict all roles, use an asterisk (`*`).
30
30
  # It does not support other wildcard patterns. (*Required*)
31
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+ # when they occur.
33
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+ # returned by Elasticsearch.
35
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+ # For example `"exists_time": "1h"` for humans and
37
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
38
+ # readable values will be omitted. This makes sense for responses being consumed
39
+ # only by machines.
40
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41
+ # this option for debugging only.
31
42
  # @option arguments [Hash] :headers Custom HTTP headers
32
43
  #
33
44
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-roles
@@ -51,7 +62,7 @@ module Elasticsearch
51
62
 
52
63
  method = Elasticsearch::API::HTTP_POST
53
64
  path = "_security/role/#{Utils.listify(_name)}/_clear_cache"
54
- params = {}
65
+ params = Utils.process_params(arguments)
55
66
 
56
67
  Elasticsearch::API::Response.new(
57
68
  perform_request(method, path, params, body, headers, request_opts)
@@ -24,16 +24,27 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Clear service account token caches.
26
26
  # Evict a subset of all entries from the service account token caches.
27
- # Two separate caches exist for service account tokens: one cache for tokens backed by the +service_tokens+ file, and another for tokens backed by the +.security+ index.
27
+ # Two separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.
28
28
  # This API clears matching entries from both caches.
29
- # The cache for service account tokens backed by the +.security+ index is cleared automatically on state changes of the security index.
30
- # The cache for tokens backed by the +service_tokens+ file is cleared automatically on file changes.
29
+ # The cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.
30
+ # The cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.
31
31
  #
32
32
  # @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*)
33
33
  # @option arguments [String] :service The name of the service, which must be unique within its namespace. (*Required*)
34
34
  # @option arguments [String, Array<String>] :name A comma-separated list of token names to evict from the service account token caches.
35
- # Use a wildcard (+*+) to evict all tokens that belong to a service account.
35
+ # Use a wildcard (`*`) to evict all tokens that belong to a service account.
36
36
  # It does not support other wildcard patterns. (*Required*)
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-security-clear-cached-service-tokens
@@ -63,7 +74,7 @@ module Elasticsearch
63
74
 
64
75
  method = Elasticsearch::API::HTTP_POST
65
76
  path = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}/_clear_cache"
66
- params = {}
77
+ params = Utils.process_params(arguments)
67
78
 
68
79
  Elasticsearch::API::Response.new(
69
80
  perform_request(method, path, params, body, headers, request_opts)
@@ -32,7 +32,18 @@ module Elasticsearch
32
32
  # The API keys are created by the Elasticsearch API key service, which is automatically enabled.
33
33
  # To configure or turn off the API key service, refer to API key service setting documentation.
34
34
  #
35
- # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
35
+ # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
36
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
37
+ # when they occur.
38
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
39
+ # returned by Elasticsearch.
40
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
41
+ # For example `"exists_time": "1h"` for humans and
42
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
43
+ # readable values will be omitted. This makes sense for responses being consumed
44
+ # only by machines.
45
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
46
+ # this option for debugging only.
36
47
  # @option arguments [Hash] :headers Custom HTTP headers
37
48
  # @option arguments [Hash] :body request body
38
49
  #
@@ -23,16 +23,27 @@ module Elasticsearch
23
23
  module Security
24
24
  module Actions
25
25
  # Create a cross-cluster API key.
26
- # Create an API key of the +cross_cluster+ type for the API key based remote cluster access.
27
- # A +cross_cluster+ API key cannot be used to authenticate through the REST interface.
26
+ # Create an API key of the `cross_cluster` type for the API key based remote cluster access.
27
+ # A `cross_cluster` API key cannot be used to authenticate through the REST interface.
28
28
  # IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.
29
29
  # Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.
30
- # NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the +access+ property.
30
+ # NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.
31
31
  # A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.
32
32
  # By default, API keys never expire. You can specify expiration information when you create the API keys.
33
33
  # Cross-cluster API keys can only be updated with the update cross-cluster API key API.
34
34
  # Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.
35
35
  #
36
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
37
+ # when they occur.
38
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
39
+ # returned by Elasticsearch.
40
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
41
+ # For example `"exists_time": "1h"` for humans and
42
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
43
+ # readable values will be omitted. This makes sense for responses being consumed
44
+ # only by machines.
45
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
46
+ # this option for debugging only.
36
47
  # @option arguments [Hash] :headers Custom HTTP headers
37
48
  # @option arguments [Hash] :body request body
38
49
  #
@@ -50,7 +61,7 @@ module Elasticsearch
50
61
 
51
62
  method = Elasticsearch::API::HTTP_POST
52
63
  path = '_security/cross_cluster/api_key'
53
- params = {}
64
+ params = Utils.process_params(arguments)
54
65
 
55
66
  Elasticsearch::API::Response.new(
56
67
  perform_request(method, path, params, body, headers, request_opts)
@@ -31,9 +31,20 @@ module Elasticsearch
31
31
  # @option arguments [String] :service The name of the service. (*Required*)
32
32
  # @option arguments [String] :name The name for the service account token.
33
33
  # If omitted, a random name will be generated.Token names must be at least one and no more than 256 characters.
34
- # They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (+-+), and underscores (+_+), but cannot begin with an underscore.NOTE: Token names must be unique in the context of the associated service account.
35
- # They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as +<namespace>/<service>/<token-name>+.
36
- # @option arguments [String] :refresh If +true+ then refresh the affected shards to make this operation visible to search, if +wait_for+ (the default) then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
34
+ # They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.NOTE: Token names must be unique in the context of the associated service account.
35
+ # They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.
36
+ # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
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-security-create-service-token
@@ -24,13 +24,24 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Delegate PKI authentication.
26
26
  # This API implements the exchange of an X509Certificate chain for an Elasticsearch access token.
27
- # The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has +delegation.enabled+ set to +true+.
28
- # A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw +username_pattern+ of the respective realm.
27
+ # The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.
28
+ # A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.
29
29
  # This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.
30
30
  # IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.
31
31
  # This is part of the TLS authentication process and it is delegated to the proxy that calls this API.
32
32
  # The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.
33
33
  #
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
  #
@@ -48,7 +59,7 @@ module Elasticsearch
48
59
 
49
60
  method = Elasticsearch::API::HTTP_POST
50
61
  path = '_security/delegate_pki'
51
- params = {}
62
+ params = Utils.process_params(arguments)
52
63
 
53
64
  Elasticsearch::API::Response.new(
54
65
  perform_request(method, path, params, body, headers, request_opts)
@@ -24,13 +24,24 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Delete application privileges.
26
26
  # To use this API, you must have one of the following privileges:
27
- # * The +manage_security+ cluster privilege (or a greater privilege such as +all+).
27
+ # * The `manage_security` cluster privilege (or a greater privilege such as `all`).
28
28
  # * The "Manage Application Privileges" global privilege for the application being referenced in the request.
29
29
  #
30
30
  # @option arguments [String] :application The name of the application.
31
31
  # Application privileges are always associated with exactly one application. (*Required*)
32
32
  # @option arguments [String, Array<String>] :name The name of the privilege. (*Required*)
33
- # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
33
+ # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
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-security-delete-privileges
@@ -28,7 +28,18 @@ module Elasticsearch
28
28
  # The delete roles API cannot remove roles that are defined in roles files.
29
29
  #
30
30
  # @option arguments [String] :name The name of the role. (*Required*)
31
- # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
31
+ # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
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-security-delete-role
@@ -29,7 +29,18 @@ module Elasticsearch
29
29
  #
30
30
  # @option arguments [String] :name The distinct name that identifies the role mapping.
31
31
  # The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. (*Required*)
32
- # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
32
+ # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
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-security-delete-role-mapping
@@ -28,7 +28,18 @@ module Elasticsearch
28
28
  # @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*)
29
29
  # @option arguments [String] :service The service name. (*Required*)
30
30
  # @option arguments [String] :name The name of the service account token. (*Required*)
31
- # @option arguments [String] :refresh If +true+ then refresh the affected shards to make this operation visible to search, if +wait_for+ (the default) then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
31
+ # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
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-security-delete-service-token
@@ -26,7 +26,18 @@ module Elasticsearch
26
26
  # Delete users from the native realm.
27
27
  #
28
28
  # @option arguments [String] :username An identifier for the user. (*Required*)
29
- # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
29
+ # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
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-security-delete-user
@@ -28,7 +28,18 @@ module Elasticsearch
28
28
  # You can use this API to revoke a user's access to Elasticsearch.
29
29
  #
30
30
  # @option arguments [String] :username An identifier for the user. (*Required*)
31
- # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
31
+ # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
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-security-disable-user
@@ -34,6 +34,17 @@ module Elasticsearch
34
34
  # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
35
35
  # If 'wait_for', it waits for a refresh to make this operation visible to search.
36
36
  # If 'false', it does nothing with refreshes. Server default: false.
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-security-disable-user-profile
@@ -27,7 +27,18 @@ module Elasticsearch
27
27
  # By default, when you create users, they are enabled.
28
28
  #
29
29
  # @option arguments [String] :username An identifier for the user. (*Required*)
30
- # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
30
+ # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
31
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+ # when they occur.
33
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+ # returned by Elasticsearch.
35
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+ # For example `"exists_time": "1h"` for humans and
37
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
38
+ # readable values will be omitted. This makes sense for responses being consumed
39
+ # only by machines.
40
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41
+ # this option for debugging only.
31
42
  # @option arguments [Hash] :headers Custom HTTP headers
32
43
  #
33
44
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-enable-user
@@ -35,6 +35,17 @@ module Elasticsearch
35
35
  # visible to search.
36
36
  # If 'wait_for', it waits for a refresh to make this operation visible to search.
37
37
  # If 'false', nothing is done with refreshes. Server default: false.
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
  #
40
51
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-enable-user-profile
@@ -27,6 +27,17 @@ module Elasticsearch
27
27
  # NOTE: This API is currently intended for internal use only by Kibana.
28
28
  # Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.
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-security-enroll-kibana
@@ -41,7 +52,7 @@ module Elasticsearch
41
52
 
42
53
  method = Elasticsearch::API::HTTP_GET
43
54
  path = '_security/enroll/kibana'
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)
@@ -27,6 +27,17 @@ module Elasticsearch
27
27
  # The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.
28
28
  # The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.
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-security-enroll-node
@@ -41,7 +52,7 @@ module Elasticsearch
41
52
 
42
53
  method = Elasticsearch::API::HTTP_GET
43
54
  path = '_security/enroll/node'
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)
@@ -24,26 +24,37 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get API key information.
26
26
  # Retrieves information for one or more API keys.
27
- # NOTE: If you have only the +manage_own_api_key+ privilege, this API returns only the API keys that you own.
28
- # If you have +read_security+, +manage_api_key+ or greater privileges (including +manage_security+), this API returns all API keys regardless of ownership.
27
+ # NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
28
+ # If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
29
29
  #
30
30
  # @option arguments [String] :id An API key id.
31
- # This parameter cannot be used with any of +name+, +realm_name+ or +username+.
31
+ # This parameter cannot be used with any of `name`, `realm_name` or `username`.
32
32
  # @option arguments [String] :name An API key name.
33
- # This parameter cannot be used with any of +id+, +realm_name+ or +username+.
33
+ # This parameter cannot be used with any of `id`, `realm_name` or `username`.
34
34
  # It supports prefix search with wildcard.
35
35
  # @option arguments [Boolean] :owner A boolean flag that can be used to query API keys owned by the currently authenticated user.
36
- # The +realm_name+ or +username+ parameters cannot be specified when this parameter is set to +true+ as they are assumed to be the currently authenticated ones.
36
+ # The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.
37
37
  # @option arguments [String] :realm_name The name of an authentication realm.
38
- # This parameter cannot be used with either +id+ or +name+ or when +owner+ flag is set to +true+.
38
+ # This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.
39
39
  # @option arguments [String] :username The username of a user.
40
- # This parameter cannot be used with either +id+ or +name+ or when +owner+ flag is set to +true+.
40
+ # This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.
41
41
  # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors
42
42
  # associated with the API key. An API key's actual
43
43
  # permission is the intersection of its assigned role
44
44
  # descriptors and the owner user's role descriptors.
45
- # @option arguments [Boolean] :active_only A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as +owner+ or +name+. If +active_only+ is false, the response will include both active and inactive (expired or invalidated) keys.
45
+ # @option arguments [Boolean] :active_only A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.
46
46
  # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
47
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48
+ # when they occur.
49
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
50
+ # returned by Elasticsearch.
51
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
52
+ # For example `"exists_time": "1h"` for humans and
53
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
54
+ # readable values will be omitted. This makes sense for responses being consumed
55
+ # only by machines.
56
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
57
+ # this option for debugging only.
47
58
  # @option arguments [Hash] :headers Custom HTTP headers
48
59
  #
49
60
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-api-key
@@ -25,6 +25,17 @@ module Elasticsearch
25
25
  # Get builtin privileges.
26
26
  # Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
27
27
  #
28
+ # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
29
+ # when they occur.
30
+ # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
31
+ # returned by Elasticsearch.
32
+ # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
33
+ # For example `"exists_time": "1h"` for humans and
34
+ # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
35
+ # readable values will be omitted. This makes sense for responses being consumed
36
+ # only by machines.
37
+ # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
38
+ # this option for debugging only.
28
39
  # @option arguments [Hash] :headers Custom HTTP headers
29
40
  #
30
41
  # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-builtin-privileges
@@ -39,7 +50,7 @@ module Elasticsearch
39
50
 
40
51
  method = Elasticsearch::API::HTTP_GET
41
52
  path = '_security/privilege/_builtin'
42
- params = {}
53
+ params = Utils.process_params(arguments)
43
54
 
44
55
  Elasticsearch::API::Response.new(
45
56
  perform_request(method, path, params, body, headers, request_opts)
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  module Actions
25
25
  # Get application privileges.
26
26
  # To use this API, you must have one of the following privileges:
27
- # * The +read_security+ cluster privilege (or a greater privilege such as +manage_security+ or +all+).
27
+ # * The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).
28
28
  # * The "Manage Application Privileges" global privilege for the application being referenced in the request.
29
29
  #
30
30
  # @option arguments [String] :application The name of the application.
@@ -32,6 +32,17 @@ module Elasticsearch
32
32
  # If you do not specify this parameter, the API returns information about all privileges for all applications.
33
33
  # @option arguments [String, Array<String>] :name The name of the privilege.
34
34
  # If you do not specify this parameter, the API returns information about all privileges for the requested application.
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-security-get-privileges
@@ -61,7 +72,7 @@ module Elasticsearch
61
72
  else
62
73
  '_security/privilege'
63
74
  end
64
- params = {}
75
+ params = Utils.process_params(arguments)
65
76
 
66
77
  Elasticsearch::API::Response.new(
67
78
  perform_request(method, path, params, body, headers, request_opts)
@@ -30,6 +30,17 @@ module Elasticsearch
30
30
  # @option arguments [String, Array<String>] :name The name of the role.
31
31
  # You can specify multiple roles as a comma-separated list.
32
32
  # If you do not specify this parameter, the API returns information about all roles.
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-security-get-role