opensearch-ruby 3.4.0 → 4.0.0.pre.beta.2

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 (477) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/lib/opensearch/api/actions/asynchronous_search/delete.rb +36 -0
  4. data/lib/opensearch/api/actions/asynchronous_search/get.rb +36 -0
  5. data/lib/opensearch/api/actions/asynchronous_search/search.rb +43 -0
  6. data/lib/opensearch/api/actions/asynchronous_search/stats.rb +31 -0
  7. data/lib/opensearch/api/actions/bulk.rb +48 -79
  8. data/lib/opensearch/api/actions/bulk_stream.rb +64 -0
  9. data/lib/opensearch/api/actions/cat/aliases.rb +27 -55
  10. data/lib/opensearch/api/actions/cat/all_pit_segments.rb +23 -22
  11. data/lib/opensearch/api/actions/cat/allocation.rb +29 -57
  12. data/lib/opensearch/api/actions/cat/cluster_manager.rb +27 -31
  13. data/lib/opensearch/api/actions/cat/count.rb +23 -51
  14. data/lib/opensearch/api/actions/cat/fielddata.rb +25 -53
  15. data/lib/opensearch/api/actions/cat/health.rb +22 -46
  16. data/lib/opensearch/api/actions/cat/help.rb +13 -43
  17. data/lib/opensearch/api/actions/cat/indices.rb +37 -65
  18. data/lib/opensearch/api/actions/cat/master.rb +27 -50
  19. data/lib/opensearch/api/actions/cat/nodeattrs.rb +26 -49
  20. data/lib/opensearch/api/actions/cat/nodes.rb +30 -56
  21. data/lib/opensearch/api/actions/cat/pending_tasks.rb +28 -52
  22. data/lib/opensearch/api/actions/cat/pit_segments.rb +24 -25
  23. data/lib/opensearch/api/actions/cat/plugins.rb +27 -52
  24. data/lib/opensearch/api/actions/cat/recovery.rb +28 -57
  25. data/lib/opensearch/api/actions/cat/repositories.rb +27 -50
  26. data/lib/opensearch/api/actions/cat/segment_replication.rb +70 -0
  27. data/lib/opensearch/api/actions/cat/segments.rb +28 -51
  28. data/lib/opensearch/api/actions/cat/shards.rb +31 -59
  29. data/lib/opensearch/api/actions/cat/snapshots.rb +31 -56
  30. data/lib/opensearch/api/actions/cat/tasks.rb +29 -52
  31. data/lib/opensearch/api/actions/cat/templates.rb +29 -56
  32. data/lib/opensearch/api/actions/cat/thread_pool.rb +31 -59
  33. data/lib/opensearch/api/actions/clear_scroll.rb +21 -48
  34. data/lib/opensearch/api/actions/cluster/allocation_explain.rb +20 -48
  35. data/lib/opensearch/api/actions/cluster/delete_component_template.rb +24 -47
  36. data/lib/opensearch/api/actions/cluster/delete_decommission_awareness.rb +31 -0
  37. data/lib/opensearch/api/actions/cluster/delete_voting_config_exclusions.rb +18 -41
  38. data/lib/opensearch/api/actions/cluster/delete_weighted_routing.rb +32 -0
  39. data/lib/opensearch/api/actions/cluster/exists_component_template.rb +26 -51
  40. data/lib/opensearch/api/actions/cluster/get_component_template.rb +24 -49
  41. data/lib/opensearch/api/actions/cluster/get_decommission_awareness.rb +36 -0
  42. data/lib/opensearch/api/actions/cluster/get_settings.rb +22 -45
  43. data/lib/opensearch/api/actions/cluster/get_weighted_routing.rb +36 -0
  44. data/lib/opensearch/api/actions/cluster/health.rb +34 -59
  45. data/lib/opensearch/api/actions/cluster/pending_tasks.rb +21 -44
  46. data/lib/opensearch/api/actions/cluster/post_voting_config_exclusions.rb +19 -42
  47. data/lib/opensearch/api/actions/cluster/put_component_template.rb +27 -50
  48. data/lib/opensearch/api/actions/cluster/put_decommission_awareness.rb +39 -0
  49. data/lib/opensearch/api/actions/cluster/put_settings.rb +22 -45
  50. data/lib/opensearch/api/actions/cluster/put_weighted_routing.rb +37 -0
  51. data/lib/opensearch/api/actions/cluster/remote_info.rb +13 -33
  52. data/lib/opensearch/api/actions/cluster/reroute.rb +26 -49
  53. data/lib/opensearch/api/actions/cluster/state.rb +34 -64
  54. data/lib/opensearch/api/actions/cluster/stats.rb +24 -47
  55. data/lib/opensearch/api/actions/count.rb +51 -81
  56. data/lib/opensearch/api/actions/create.rb +46 -47
  57. data/lib/opensearch/api/actions/create_pit.rb +34 -30
  58. data/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb +26 -48
  59. data/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb +26 -47
  60. data/lib/opensearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -34
  61. data/lib/opensearch/api/actions/delete.rb +45 -76
  62. data/lib/opensearch/api/actions/delete_all_pits.rb +18 -13
  63. data/lib/opensearch/api/actions/delete_by_query.rb +91 -117
  64. data/lib/opensearch/api/actions/delete_by_query_rethrottle.rb +25 -46
  65. data/lib/opensearch/api/actions/delete_pit.rb +19 -17
  66. data/lib/opensearch/api/actions/delete_script.rb +29 -50
  67. data/lib/opensearch/api/actions/exists.rb +49 -81
  68. data/lib/opensearch/api/actions/exists_source.rb +48 -77
  69. data/lib/opensearch/api/actions/explain.rb +51 -83
  70. data/lib/opensearch/api/actions/field_caps.rb +33 -63
  71. data/lib/opensearch/api/actions/flow_framework/create.rb +45 -0
  72. data/lib/opensearch/api/actions/flow_framework/delete.rb +41 -0
  73. data/lib/opensearch/api/actions/flow_framework/deprovision.rb +41 -0
  74. data/lib/opensearch/api/actions/flow_framework/get.rb +36 -0
  75. data/lib/opensearch/api/actions/flow_framework/get_status.rb +41 -0
  76. data/lib/opensearch/api/actions/flow_framework/get_steps.rb +36 -0
  77. data/lib/opensearch/api/actions/flow_framework/provision.rb +37 -0
  78. data/lib/opensearch/api/actions/flow_framework/search.rb +34 -0
  79. data/lib/opensearch/api/actions/flow_framework/search_state.rb +34 -0
  80. data/lib/opensearch/api/actions/flow_framework/update.rb +50 -0
  81. data/lib/opensearch/api/actions/get.rb +49 -80
  82. data/lib/opensearch/api/actions/get_all_pits.rb +18 -13
  83. data/lib/opensearch/api/actions/get_script.rb +27 -48
  84. data/lib/opensearch/api/actions/get_script_context.rb +18 -40
  85. data/lib/opensearch/api/actions/get_script_languages.rb +18 -40
  86. data/lib/opensearch/api/actions/get_source.rb +48 -75
  87. data/lib/opensearch/api/actions/index.rb +49 -80
  88. data/lib/opensearch/api/actions/indices/add_block.rb +34 -58
  89. data/lib/opensearch/api/actions/indices/analyze.rb +16 -52
  90. data/lib/opensearch/api/actions/indices/clear_cache.rb +30 -56
  91. data/lib/opensearch/api/actions/indices/clone.rb +36 -56
  92. data/lib/opensearch/api/actions/indices/close.rb +29 -52
  93. data/lib/opensearch/api/actions/indices/create.rb +26 -49
  94. data/lib/opensearch/api/actions/indices/create_data_stream.rb +37 -0
  95. data/lib/opensearch/api/actions/indices/data_streams_stats.rb +34 -0
  96. data/lib/opensearch/api/actions/indices/delete.rb +28 -55
  97. data/lib/opensearch/api/actions/indices/delete_alias.rb +29 -53
  98. data/lib/opensearch/api/actions/indices/delete_data_stream.rb +36 -0
  99. data/lib/opensearch/api/actions/indices/delete_index_template.rb +23 -46
  100. data/lib/opensearch/api/actions/indices/delete_template.rb +23 -50
  101. data/lib/opensearch/api/actions/indices/exists.rb +31 -57
  102. data/lib/opensearch/api/actions/indices/exists_alias.rb +28 -61
  103. data/lib/opensearch/api/actions/indices/exists_index_template.rb +27 -52
  104. data/lib/opensearch/api/actions/indices/exists_template.rb +27 -55
  105. data/lib/opensearch/api/actions/indices/flush.rb +26 -53
  106. data/lib/opensearch/api/actions/indices/forcemerge.rb +30 -53
  107. data/lib/opensearch/api/actions/indices/get.rb +30 -53
  108. data/lib/opensearch/api/actions/indices/get_alias.rb +24 -56
  109. data/lib/opensearch/api/actions/indices/get_data_stream.rb +34 -0
  110. data/lib/opensearch/api/actions/indices/get_field_mapping.rb +27 -59
  111. data/lib/opensearch/api/actions/indices/get_index_template.rb +23 -50
  112. data/lib/opensearch/api/actions/indices/get_mapping.rb +27 -59
  113. data/lib/opensearch/api/actions/indices/get_settings.rb +32 -64
  114. data/lib/opensearch/api/actions/indices/get_template.rb +23 -50
  115. data/lib/opensearch/api/actions/indices/get_upgrade.rb +22 -54
  116. data/lib/opensearch/api/actions/indices/open.rb +33 -52
  117. data/lib/opensearch/api/actions/indices/put_alias.rb +27 -54
  118. data/lib/opensearch/api/actions/indices/put_index_template.rb +26 -49
  119. data/lib/opensearch/api/actions/indices/put_mapping.rb +31 -58
  120. data/lib/opensearch/api/actions/indices/put_settings.rb +32 -59
  121. data/lib/opensearch/api/actions/indices/put_template.rb +26 -49
  122. data/lib/opensearch/api/actions/indices/recovery.rb +20 -47
  123. data/lib/opensearch/api/actions/indices/refresh.rb +22 -49
  124. data/lib/opensearch/api/actions/indices/resolve_index.rb +21 -48
  125. data/lib/opensearch/api/actions/indices/rollover.rb +31 -59
  126. data/lib/opensearch/api/actions/indices/segments.rb +22 -49
  127. data/lib/opensearch/api/actions/indices/shard_stores.rb +24 -51
  128. data/lib/opensearch/api/actions/indices/shrink.rb +36 -56
  129. data/lib/opensearch/api/actions/indices/simulate_index_template.rb +23 -50
  130. data/lib/opensearch/api/actions/indices/simulate_template.rb +25 -52
  131. data/lib/opensearch/api/actions/indices/split.rb +36 -56
  132. data/lib/opensearch/api/actions/indices/stats.rb +31 -74
  133. data/lib/opensearch/api/actions/indices/update_aliases.rb +22 -45
  134. data/lib/opensearch/api/actions/indices/upgrade.rb +24 -56
  135. data/lib/opensearch/api/actions/indices/validate_query.rb +36 -73
  136. data/lib/opensearch/api/actions/info.rb +18 -36
  137. data/lib/opensearch/api/actions/ingest/delete_pipeline.rb +22 -45
  138. data/lib/opensearch/api/actions/ingest/get_pipeline.rb +20 -49
  139. data/lib/opensearch/api/actions/ingest/processor_grok.rb +18 -33
  140. data/lib/opensearch/api/actions/ingest/put_pipeline.rb +24 -47
  141. data/lib/opensearch/api/actions/ingest/simulate.rb +21 -48
  142. data/lib/opensearch/api/actions/insights/top_queries.rb +38 -0
  143. data/lib/opensearch/api/actions/ism/add_policy.rb +37 -0
  144. data/lib/opensearch/api/actions/ism/change_policy.rb +37 -0
  145. data/lib/opensearch/api/actions/ism/delete_policy.rb +36 -0
  146. data/lib/opensearch/api/actions/ism/exists_policy.rb +36 -0
  147. data/lib/opensearch/api/actions/ism/explain_policy.rb +35 -0
  148. data/lib/opensearch/api/actions/ism/get_policies.rb +31 -0
  149. data/lib/opensearch/api/actions/ism/get_policy.rb +36 -0
  150. data/lib/opensearch/api/actions/ism/put_policies.rb +43 -0
  151. data/lib/opensearch/api/actions/ism/put_policy.rb +44 -0
  152. data/lib/opensearch/api/actions/ism/refresh_search_analyzers.rb +36 -0
  153. data/lib/opensearch/api/actions/ism/remove_policy.rb +36 -0
  154. data/lib/opensearch/api/actions/ism/retry_index.rb +37 -0
  155. data/lib/opensearch/api/actions/knn/delete_model.rb +36 -0
  156. data/lib/opensearch/api/actions/knn/get_model.rb +36 -0
  157. data/lib/opensearch/api/actions/knn/search_models.rb +119 -0
  158. data/lib/opensearch/api/actions/knn/stats.rb +41 -0
  159. data/lib/opensearch/api/actions/knn/train_model.rb +40 -0
  160. data/lib/opensearch/api/actions/knn/warmup.rb +36 -0
  161. data/lib/opensearch/api/actions/list/help.rb +31 -0
  162. data/lib/opensearch/api/actions/list/indices.rb +71 -0
  163. data/lib/opensearch/api/actions/list/shards.rb +63 -0
  164. data/lib/opensearch/api/actions/mget.rb +40 -70
  165. data/lib/opensearch/api/actions/ml/chunk_model.rb +40 -0
  166. data/lib/opensearch/api/actions/ml/create_connector.rb +32 -0
  167. data/lib/opensearch/api/actions/ml/create_controller.rb +37 -0
  168. data/lib/opensearch/api/actions/ml/create_memory.rb +32 -0
  169. data/lib/opensearch/api/actions/ml/create_message.rb +37 -0
  170. data/lib/opensearch/api/actions/ml/create_model_meta.rb +32 -0
  171. data/lib/opensearch/api/actions/ml/delete_agent.rb +36 -0
  172. data/lib/opensearch/api/actions/ml/delete_connector.rb +36 -0
  173. data/lib/opensearch/api/actions/ml/delete_controller.rb +36 -0
  174. data/lib/opensearch/api/actions/ml/delete_memory.rb +36 -0
  175. data/lib/opensearch/api/actions/ml/delete_model.rb +36 -0
  176. data/lib/opensearch/api/actions/ml/delete_model_group.rb +36 -0
  177. data/lib/opensearch/api/actions/ml/delete_task.rb +36 -0
  178. data/lib/opensearch/api/actions/ml/deploy_model.rb +36 -0
  179. data/lib/opensearch/api/actions/ml/execute_agent.rb +37 -0
  180. data/lib/opensearch/api/actions/ml/execute_algorithm.rb +37 -0
  181. data/lib/opensearch/api/actions/ml/get_agent.rb +36 -0
  182. data/lib/opensearch/api/actions/ml/get_all_memories.rb +38 -0
  183. data/lib/opensearch/api/actions/ml/get_all_messages.rb +43 -0
  184. data/lib/opensearch/api/actions/ml/get_all_tools.rb +31 -0
  185. data/lib/opensearch/api/actions/ml/get_connector.rb +36 -0
  186. data/lib/opensearch/api/actions/ml/get_controller.rb +36 -0
  187. data/lib/opensearch/api/actions/ml/get_memory.rb +36 -0
  188. data/lib/opensearch/api/actions/ml/get_message.rb +36 -0
  189. data/lib/opensearch/api/actions/ml/get_message_traces.rb +43 -0
  190. data/lib/opensearch/api/actions/ml/get_model.rb +36 -0
  191. data/lib/opensearch/api/actions/ml/get_model_group.rb +36 -0
  192. data/lib/opensearch/api/actions/ml/get_profile.rb +32 -0
  193. data/lib/opensearch/api/actions/ml/get_profile_models.rb +35 -0
  194. data/lib/opensearch/api/actions/ml/get_profile_tasks.rb +35 -0
  195. data/lib/opensearch/api/actions/ml/get_stats.rb +36 -0
  196. data/lib/opensearch/api/actions/ml/get_task.rb +36 -0
  197. data/lib/opensearch/api/actions/ml/get_tool.rb +36 -0
  198. data/lib/opensearch/api/actions/ml/load_model.rb +36 -0
  199. data/lib/opensearch/api/actions/ml/predict.rb +40 -0
  200. data/lib/opensearch/api/actions/ml/predict_model.rb +37 -0
  201. data/lib/opensearch/api/actions/ml/register_agents.rb +32 -0
  202. data/lib/opensearch/api/actions/ml/register_model.rb +32 -0
  203. data/lib/opensearch/api/actions/ml/register_model_group.rb +32 -0
  204. data/lib/opensearch/api/actions/ml/register_model_meta.rb +32 -0
  205. data/lib/opensearch/api/actions/ml/search_agents.rb +32 -0
  206. data/lib/opensearch/api/actions/ml/search_connectors.rb +32 -0
  207. data/lib/opensearch/api/actions/ml/search_memory.rb +32 -0
  208. data/lib/opensearch/api/actions/ml/search_message.rb +37 -0
  209. data/lib/opensearch/api/actions/ml/search_model_group.rb +32 -0
  210. data/lib/opensearch/api/actions/ml/search_models.rb +32 -0
  211. data/lib/opensearch/api/actions/ml/search_tasks.rb +32 -0
  212. data/lib/opensearch/api/actions/ml/train.rb +37 -0
  213. data/lib/opensearch/api/actions/ml/train_predict.rb +37 -0
  214. data/lib/opensearch/api/actions/ml/undeploy_model.rb +35 -0
  215. data/lib/opensearch/api/actions/ml/unload_model.rb +35 -0
  216. data/lib/opensearch/api/actions/ml/update_connector.rb +37 -0
  217. data/lib/opensearch/api/actions/ml/update_controller.rb +37 -0
  218. data/lib/opensearch/api/actions/ml/update_memory.rb +37 -0
  219. data/lib/opensearch/api/actions/ml/update_message.rb +37 -0
  220. data/lib/opensearch/api/actions/ml/update_model.rb +37 -0
  221. data/lib/opensearch/api/actions/ml/update_model_group.rb +37 -0
  222. data/lib/opensearch/api/actions/ml/upload_chunk.rb +40 -0
  223. data/lib/opensearch/api/actions/ml/upload_model.rb +32 -0
  224. data/lib/opensearch/api/actions/msearch.rb +40 -91
  225. data/lib/opensearch/api/actions/msearch_template.rb +36 -75
  226. data/lib/opensearch/api/actions/mtermvectors.rb +47 -87
  227. data/lib/opensearch/api/actions/nodes/hot_threads.rb +25 -57
  228. data/lib/opensearch/api/actions/nodes/info.rb +23 -53
  229. data/lib/opensearch/api/actions/nodes/reload_secure_settings.rb +20 -47
  230. data/lib/opensearch/api/actions/nodes/stats.rb +33 -72
  231. data/lib/opensearch/api/actions/nodes/usage.rb +21 -53
  232. data/lib/opensearch/api/actions/notifications/create_config.rb +34 -0
  233. data/lib/opensearch/api/actions/notifications/delete_config.rb +36 -0
  234. data/lib/opensearch/api/actions/notifications/delete_configs.rb +40 -0
  235. data/lib/opensearch/api/actions/notifications/get_config.rb +36 -0
  236. data/lib/opensearch/api/actions/notifications/get_configs.rb +115 -0
  237. data/lib/opensearch/api/actions/notifications/list_channels.rb +31 -0
  238. data/lib/opensearch/api/actions/notifications/list_features.rb +31 -0
  239. data/lib/opensearch/api/actions/notifications/send_test.rb +36 -0
  240. data/lib/opensearch/api/actions/notifications/update_config.rb +38 -0
  241. data/lib/opensearch/api/actions/observability/create_object.rb +32 -0
  242. data/lib/opensearch/api/actions/observability/delete_object.rb +36 -0
  243. data/lib/opensearch/api/actions/observability/delete_objects.rb +38 -0
  244. data/lib/opensearch/api/actions/observability/get_localstats.rb +31 -0
  245. data/lib/opensearch/api/actions/observability/get_object.rb +36 -0
  246. data/lib/opensearch/api/actions/observability/list_objects.rb +31 -0
  247. data/lib/opensearch/api/actions/observability/update_object.rb +37 -0
  248. data/lib/opensearch/api/actions/ping.rb +17 -40
  249. data/lib/opensearch/api/actions/ppl/explain.rb +41 -0
  250. data/lib/opensearch/api/actions/ppl/get_stats.rb +38 -0
  251. data/lib/opensearch/api/actions/ppl/post_stats.rb +41 -0
  252. data/lib/opensearch/api/actions/ppl/query.rb +41 -0
  253. data/lib/opensearch/api/actions/put_script.rb +37 -64
  254. data/lib/opensearch/api/actions/query/datasource_delete.rb +36 -0
  255. data/lib/opensearch/api/actions/query/datasource_retrieve.rb +36 -0
  256. data/lib/opensearch/api/actions/query/datasources_create.rb +32 -0
  257. data/lib/opensearch/api/actions/query/datasources_list.rb +31 -0
  258. data/lib/opensearch/api/actions/query/datasources_update.rb +32 -0
  259. data/lib/opensearch/api/actions/rank_eval.rb +32 -61
  260. data/lib/opensearch/api/actions/reindex.rb +42 -61
  261. data/lib/opensearch/api/actions/reindex_rethrottle.rb +25 -46
  262. data/lib/opensearch/api/actions/remote_store/restore.rb +19 -21
  263. data/lib/opensearch/api/actions/render_search_template.rb +21 -48
  264. data/lib/opensearch/api/actions/replication/autofollow_stats.rb +31 -0
  265. data/lib/opensearch/api/actions/replication/create_replication_rule.rb +34 -0
  266. data/lib/opensearch/api/actions/replication/delete_replication_rule.rb +34 -0
  267. data/lib/opensearch/api/actions/replication/follower_stats.rb +31 -0
  268. data/lib/opensearch/api/actions/replication/leader_stats.rb +31 -0
  269. data/lib/opensearch/api/actions/replication/pause.rb +38 -0
  270. data/lib/opensearch/api/actions/replication/resume.rb +38 -0
  271. data/lib/opensearch/api/actions/replication/start.rb +38 -0
  272. data/lib/opensearch/api/actions/replication/status.rb +36 -0
  273. data/lib/opensearch/api/actions/replication/stop.rb +38 -0
  274. data/lib/opensearch/api/actions/replication/update_settings.rb +38 -0
  275. data/lib/opensearch/api/actions/rollups/delete.rb +36 -0
  276. data/lib/opensearch/api/actions/rollups/explain.rb +36 -0
  277. data/lib/opensearch/api/actions/rollups/get.rb +36 -0
  278. data/lib/opensearch/api/actions/rollups/put.rb +44 -0
  279. data/lib/opensearch/api/actions/rollups/start.rb +36 -0
  280. data/lib/opensearch/api/actions/rollups/stop.rb +36 -0
  281. data/lib/opensearch/api/actions/scripts_painless_execute.rb +19 -46
  282. data/lib/opensearch/api/actions/scroll.rb +27 -63
  283. data/lib/opensearch/api/actions/search.rb +115 -146
  284. data/lib/opensearch/api/actions/search_pipeline/delete.rb +43 -0
  285. data/lib/opensearch/api/actions/search_pipeline/get.rb +39 -0
  286. data/lib/opensearch/api/actions/search_pipeline/put.rb +45 -0
  287. data/lib/opensearch/api/actions/search_shards.rb +34 -59
  288. data/lib/opensearch/api/actions/search_template.rb +50 -80
  289. data/lib/opensearch/api/actions/security/authinfo.rb +38 -0
  290. data/lib/opensearch/api/actions/security/authtoken.rb +31 -0
  291. data/lib/opensearch/api/actions/security/change_password.rb +12 -17
  292. data/lib/opensearch/api/actions/security/config_upgrade_check.rb +31 -0
  293. data/lib/opensearch/api/actions/security/config_upgrade_perform.rb +32 -0
  294. data/lib/opensearch/api/actions/security/create_action_group.rb +15 -19
  295. data/lib/opensearch/api/actions/security/create_allowlist.rb +34 -0
  296. data/lib/opensearch/api/actions/security/create_role.rb +15 -20
  297. data/lib/opensearch/api/actions/security/create_role_mapping.rb +15 -20
  298. data/lib/opensearch/api/actions/security/create_tenant.rb +15 -19
  299. data/lib/opensearch/api/actions/security/create_update_tenancy_config.rb +34 -0
  300. data/lib/opensearch/api/actions/security/create_user.rb +15 -20
  301. data/lib/opensearch/api/actions/security/create_user_legacy.rb +38 -0
  302. data/lib/opensearch/api/actions/security/delete_action_group.rb +14 -19
  303. data/lib/opensearch/api/actions/security/delete_distinguished_name.rb +36 -0
  304. data/lib/opensearch/api/actions/security/delete_role.rb +14 -19
  305. data/lib/opensearch/api/actions/security/delete_role_mapping.rb +13 -18
  306. data/lib/opensearch/api/actions/security/delete_tenant.rb +14 -19
  307. data/lib/opensearch/api/actions/security/delete_user.rb +14 -19
  308. data/lib/opensearch/api/actions/security/delete_user_legacy.rb +36 -0
  309. data/lib/opensearch/api/actions/security/flush_cache.rb +11 -16
  310. data/lib/opensearch/api/actions/security/generate_obo_token.rb +34 -0
  311. data/lib/opensearch/api/actions/security/generate_user_token.rb +36 -0
  312. data/lib/opensearch/api/actions/security/generate_user_token_legacy.rb +36 -0
  313. data/lib/opensearch/api/actions/security/get_account_details.rb +11 -16
  314. data/lib/opensearch/api/actions/security/get_action_group.rb +13 -18
  315. data/lib/opensearch/api/actions/security/get_action_groups.rb +10 -15
  316. data/lib/opensearch/api/actions/security/get_all_certificates.rb +38 -0
  317. data/lib/opensearch/api/actions/security/get_allowlist.rb +31 -0
  318. data/lib/opensearch/api/actions/security/get_audit_configuration.rb +10 -15
  319. data/lib/opensearch/api/actions/security/get_certificates.rb +11 -16
  320. data/lib/opensearch/api/actions/security/get_configuration.rb +11 -16
  321. data/lib/opensearch/api/actions/security/get_dashboards_info.rb +31 -0
  322. data/lib/opensearch/api/actions/security/get_distinguished_name.rb +41 -0
  323. data/lib/opensearch/api/actions/security/get_distinguished_names.rb +16 -19
  324. data/lib/opensearch/api/actions/security/get_node_certificates.rb +43 -0
  325. data/lib/opensearch/api/actions/security/get_permissions_info.rb +31 -0
  326. data/lib/opensearch/api/actions/security/get_role.rb +13 -18
  327. data/lib/opensearch/api/actions/security/get_role_mapping.rb +14 -19
  328. data/lib/opensearch/api/actions/security/get_role_mappings.rb +10 -15
  329. data/lib/opensearch/api/actions/security/get_roles.rb +10 -15
  330. data/lib/opensearch/api/actions/security/get_sslinfo.rb +36 -0
  331. data/lib/opensearch/api/actions/security/get_tenancy_config.rb +31 -0
  332. data/lib/opensearch/api/actions/security/get_tenant.rb +14 -19
  333. data/lib/opensearch/api/actions/security/get_tenants.rb +10 -15
  334. data/lib/opensearch/api/actions/security/get_user.rb +14 -19
  335. data/lib/opensearch/api/actions/security/get_user_legacy.rb +36 -0
  336. data/lib/opensearch/api/actions/security/get_users.rb +10 -15
  337. data/lib/opensearch/api/actions/security/get_users_legacy.rb +31 -0
  338. data/lib/opensearch/api/actions/security/health.rb +16 -16
  339. data/lib/opensearch/api/actions/security/migrate.rb +31 -0
  340. data/lib/opensearch/api/actions/security/patch_action_group.rb +16 -20
  341. data/lib/opensearch/api/actions/security/patch_action_groups.rb +14 -17
  342. data/lib/opensearch/api/actions/security/patch_allowlist.rb +34 -0
  343. data/lib/opensearch/api/actions/security/patch_audit_configuration.rb +13 -18
  344. data/lib/opensearch/api/actions/security/patch_configuration.rb +13 -18
  345. data/lib/opensearch/api/actions/security/patch_distinguished_name.rb +37 -0
  346. data/lib/opensearch/api/actions/security/patch_distinguished_names.rb +13 -18
  347. data/lib/opensearch/api/actions/security/patch_role.rb +16 -21
  348. data/lib/opensearch/api/actions/security/patch_role_mapping.rb +16 -21
  349. data/lib/opensearch/api/actions/security/patch_role_mappings.rb +13 -18
  350. data/lib/opensearch/api/actions/security/patch_roles.rb +12 -17
  351. data/lib/opensearch/api/actions/security/patch_tenant.rb +16 -21
  352. data/lib/opensearch/api/actions/security/patch_tenants.rb +13 -18
  353. data/lib/opensearch/api/actions/security/patch_user.rb +16 -21
  354. data/lib/opensearch/api/actions/security/patch_users.rb +13 -18
  355. data/lib/opensearch/api/actions/security/post_dashboards_info.rb +31 -0
  356. data/lib/opensearch/api/actions/security/reload_http_certificates.rb +11 -16
  357. data/lib/opensearch/api/actions/security/reload_transport_certificates.rb +11 -16
  358. data/lib/opensearch/api/actions/security/tenant_info.rb +31 -0
  359. data/lib/opensearch/api/actions/security/update_audit_configuration.rb +12 -17
  360. data/lib/opensearch/api/actions/security/update_configuration.rb +13 -18
  361. data/lib/opensearch/api/actions/security/update_distinguished_name.rb +37 -0
  362. data/lib/opensearch/api/actions/security/validate.rb +36 -0
  363. data/lib/opensearch/api/actions/security/who_am_i.rb +31 -0
  364. data/lib/opensearch/api/actions/security/who_am_i_protected.rb +31 -0
  365. data/lib/opensearch/api/actions/sm/create_policy.rb +37 -0
  366. data/lib/opensearch/api/actions/sm/delete_policy.rb +36 -0
  367. data/lib/opensearch/api/actions/sm/explain_policy.rb +36 -0
  368. data/lib/opensearch/api/actions/sm/get_policies.rb +44 -0
  369. data/lib/opensearch/api/actions/sm/get_policy.rb +36 -0
  370. data/lib/opensearch/api/actions/sm/start_policy.rb +36 -0
  371. data/lib/opensearch/api/actions/sm/stop_policy.rb +36 -0
  372. data/lib/opensearch/api/actions/sm/update_policy.rb +46 -0
  373. data/lib/opensearch/api/actions/snapshot/cleanup_repository.rb +22 -45
  374. data/lib/opensearch/api/actions/snapshot/clone.rb +33 -58
  375. data/lib/opensearch/api/actions/snapshot/create.rb +29 -53
  376. data/lib/opensearch/api/actions/snapshot/create_repository.rb +25 -48
  377. data/lib/opensearch/api/actions/snapshot/delete.rb +27 -55
  378. data/lib/opensearch/api/actions/snapshot/delete_repository.rb +22 -49
  379. data/lib/opensearch/api/actions/snapshot/get.rb +29 -61
  380. data/lib/opensearch/api/actions/snapshot/get_repository.rb +21 -51
  381. data/lib/opensearch/api/actions/snapshot/restore.rb +29 -53
  382. data/lib/opensearch/api/actions/snapshot/status.rb +23 -57
  383. data/lib/opensearch/api/actions/snapshot/verify_repository.rb +22 -45
  384. data/lib/opensearch/api/actions/sql/close.rb +39 -0
  385. data/lib/opensearch/api/actions/sql/explain.rb +39 -0
  386. data/lib/opensearch/api/actions/sql/get_stats.rb +38 -0
  387. data/lib/opensearch/api/actions/sql/post_stats.rb +39 -0
  388. data/lib/opensearch/api/actions/sql/query.rb +39 -0
  389. data/lib/opensearch/api/actions/sql/settings.rb +37 -0
  390. data/lib/opensearch/api/actions/tasks/cancel.rb +22 -53
  391. data/lib/opensearch/api/actions/tasks/get.rb +21 -46
  392. data/lib/opensearch/api/actions/tasks/list.rb +25 -52
  393. data/lib/opensearch/api/actions/termvectors.rb +48 -92
  394. data/lib/opensearch/api/actions/transforms/delete.rb +36 -0
  395. data/lib/opensearch/api/actions/transforms/explain.rb +36 -0
  396. data/lib/opensearch/api/actions/transforms/get.rb +36 -0
  397. data/lib/opensearch/api/actions/transforms/preview.rb +32 -0
  398. data/lib/opensearch/api/actions/transforms/put.rb +44 -0
  399. data/lib/opensearch/api/actions/transforms/search.rb +44 -0
  400. data/lib/opensearch/api/actions/transforms/start.rb +36 -0
  401. data/lib/opensearch/api/actions/transforms/stop.rb +36 -0
  402. data/lib/opensearch/api/actions/update.rb +52 -83
  403. data/lib/opensearch/api/actions/update_by_query.rb +93 -121
  404. data/lib/opensearch/api/actions/update_by_query_rethrottle.rb +25 -46
  405. data/lib/opensearch/api/actions/wlm/create_query_group.rb +34 -0
  406. data/lib/opensearch/api/actions/wlm/delete_query_group.rb +36 -0
  407. data/lib/opensearch/api/actions/wlm/get_query_group.rb +34 -0
  408. data/lib/opensearch/api/actions/wlm/update_query_group.rb +38 -0
  409. data/lib/opensearch/api/http.rb +94 -0
  410. data/lib/opensearch/api/namespace.rb +23 -0
  411. data/lib/opensearch/api/utils.rb +41 -236
  412. data/lib/opensearch/api.rb +10 -82
  413. data/lib/opensearch/dsl/search.rb +2 -2
  414. data/lib/opensearch/dsl.rb +3 -3
  415. data/lib/opensearch/transport/client.rb +30 -2
  416. data/lib/opensearch/transport/transport/base.rb +3 -8
  417. data/lib/opensearch/transport/transport/http/faraday.rb +3 -1
  418. data/lib/opensearch/version.rb +1 -1
  419. data/lib/opensearch.rb +106 -68
  420. data/opensearch-ruby.gemspec +2 -1
  421. data/spec/spec_helper.rb +3 -18
  422. data/test/transport/unit/transport_base_test.rb +0 -26
  423. data.tar.gz.sig +0 -0
  424. metadata +240 -67
  425. metadata.gz.sig +0 -0
  426. data/lib/opensearch/api/actions/abort_benchmark.rb +0 -49
  427. data/lib/opensearch/api/actions/benchmark.rb +0 -88
  428. data/lib/opensearch/api/actions/cat/params_registry.rb +0 -69
  429. data/lib/opensearch/api/actions/cluster/params_registry.rb +0 -69
  430. data/lib/opensearch/api/actions/dangling_indices/params_registry.rb +0 -69
  431. data/lib/opensearch/api/actions/features/get_features.rb +0 -61
  432. data/lib/opensearch/api/actions/features/params_registry.rb +0 -69
  433. data/lib/opensearch/api/actions/features/reset_features.rb +0 -55
  434. data/lib/opensearch/api/actions/http/connect.rb +0 -28
  435. data/lib/opensearch/api/actions/http/delete.rb +0 -28
  436. data/lib/opensearch/api/actions/http/get.rb +0 -28
  437. data/lib/opensearch/api/actions/http/head.rb +0 -28
  438. data/lib/opensearch/api/actions/http/options.rb +0 -28
  439. data/lib/opensearch/api/actions/http/patch.rb +0 -28
  440. data/lib/opensearch/api/actions/http/post.rb +0 -28
  441. data/lib/opensearch/api/actions/http/put.rb +0 -28
  442. data/lib/opensearch/api/actions/http/request.rb +0 -27
  443. data/lib/opensearch/api/actions/http/trace.rb +0 -28
  444. data/lib/opensearch/api/actions/indices/disk_usage.rb +0 -76
  445. data/lib/opensearch/api/actions/indices/field_usage_stats.rb +0 -74
  446. data/lib/opensearch/api/actions/indices/params_registry.rb +0 -69
  447. data/lib/opensearch/api/actions/ingest/geo_ip_stats.rb +0 -51
  448. data/lib/opensearch/api/actions/ingest/params_registry.rb +0 -69
  449. data/lib/opensearch/api/actions/nodes/params_registry.rb +0 -69
  450. data/lib/opensearch/api/actions/nodes/shutdown.rb +0 -65
  451. data/lib/opensearch/api/actions/params_registry.rb +0 -67
  452. data/lib/opensearch/api/actions/remote/info.rb +0 -45
  453. data/lib/opensearch/api/actions/security/delete_distinguished_names.rb +0 -41
  454. data/lib/opensearch/api/actions/security/update_distinguished_names.rb +0 -42
  455. data/lib/opensearch/api/actions/shutdown/delete_node.rb +0 -60
  456. data/lib/opensearch/api/actions/shutdown/get_node.rb +0 -62
  457. data/lib/opensearch/api/actions/shutdown/params_registry.rb +0 -69
  458. data/lib/opensearch/api/actions/shutdown/put_node.rb +0 -62
  459. data/lib/opensearch/api/actions/snapshot/get_features.rb +0 -61
  460. data/lib/opensearch/api/actions/snapshot/params_registry.rb +0 -69
  461. data/lib/opensearch/api/actions/snapshot/repository_analyze.rb +0 -84
  462. data/lib/opensearch/api/actions/tasks/params_registry.rb +0 -69
  463. data/lib/opensearch/api/namespace/cat.rb +0 -47
  464. data/lib/opensearch/api/namespace/cluster.rb +0 -47
  465. data/lib/opensearch/api/namespace/common.rb +0 -72
  466. data/lib/opensearch/api/namespace/dangling_indices.rb +0 -47
  467. data/lib/opensearch/api/namespace/features.rb +0 -47
  468. data/lib/opensearch/api/namespace/http.rb +0 -30
  469. data/lib/opensearch/api/namespace/indices.rb +0 -47
  470. data/lib/opensearch/api/namespace/ingest.rb +0 -47
  471. data/lib/opensearch/api/namespace/nodes.rb +0 -47
  472. data/lib/opensearch/api/namespace/remote.rb +0 -47
  473. data/lib/opensearch/api/namespace/remote_store.rb +0 -30
  474. data/lib/opensearch/api/namespace/security.rb +0 -30
  475. data/lib/opensearch/api/namespace/shutdown.rb +0 -47
  476. data/lib/opensearch/api/namespace/snapshot.rb +0 -47
  477. data/lib/opensearch/api/namespace/tasks.rb +0 -47
@@ -3,72 +3,47 @@
3
3
  # The OpenSearch Contributors require contributions made to
4
4
  # this file be licensed under the Apache-2.0 license or a
5
5
  # compatible open source license.
6
- #
7
- # Modifications Copyright OpenSearch Contributors. See
8
- # GitHub history for details.
9
- #
10
- # Licensed to Elasticsearch B.V. under one or more contributor
11
- # license agreements. See the NOTICE file distributed with
12
- # this work for additional information regarding copyright
13
- # ownership. Elasticsearch B.V. licenses this file to you under
14
- # the Apache License, Version 2.0 (the "License"); you may
15
- # not use this file except in compliance with the License.
16
- # You may obtain a copy of the License at
17
- #
18
- # http://www.apache.org/licenses/LICENSE-2.0
19
- #
20
- # Unless required by applicable law or agreed to in writing,
21
- # software distributed under the License is distributed on an
22
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23
- # KIND, either express or implied. See the License for the
24
- # specific language governing permissions and limitations
25
- # under the License.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
26
11
 
27
12
  module OpenSearch
28
13
  module API
29
14
  module Cat
30
15
  module Actions
31
- # Returns information about installed plugins across nodes node.
32
- #
33
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
34
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
35
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
36
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
37
- # @option arguments [List] :h Comma-separated list of column names to display
38
- # @option arguments [Boolean] :help Return help information
39
- # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response
40
- # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
41
- # @option arguments [Boolean] :v Verbose mode. Display column headers
42
- # @option arguments [Hash] :headers Custom HTTP headers
16
+ # Returns information about the names, components, and versions of the installed plugins.
43
17
  #
44
- #
45
- def plugins(arguments = {})
46
- headers = arguments.delete(:headers) || {}
47
-
48
- arguments = arguments.clone
18
+ # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
19
+ # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
20
+ # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
21
+ # @option args [Boolean] :help Returns help information.
22
+ # @option args [Boolean] :local Returns local information but does not retrieve the state from the cluster manager node.
23
+ # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
24
+ # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
25
+ # @option args [Boolean] :v Enables verbose mode, which displays column headers.
26
+ def plugins(args = {})
27
+ args = Utils.clone_and_normalize_arguments(args)
28
+ headers = args.delete('headers') || {}
29
+ body = args.delete('body')
30
+ method = 'GET'
31
+ url = '_cat/plugins'
49
32
 
50
- method = OpenSearch::API::HTTP_GET
51
- path = '_cat/plugins'
52
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
53
-
54
- body = nil
55
- perform_request(method, path, params, body, headers).body
33
+ Utils.validate_query_params! args, PLUGINS_QUERY_PARAMS
34
+ transport.perform_request(method, url, args, body, headers).body
56
35
  end
57
36
 
58
- # Register this action with its valid params when the module is loaded.
59
- #
60
- # @since 6.2.0
61
- ParamsRegistry.register(:plugins, %i[
62
- format
63
- local
64
- master_timeout
37
+ PLUGINS_QUERY_PARAMS = Set.new(%w[
65
38
  cluster_manager_timeout
39
+ format
66
40
  h
67
41
  help
68
- include_bootstrap
42
+ local
43
+ master_timeout
69
44
  s
70
45
  v
71
- ].freeze)
46
+ ]).freeze
72
47
  end
73
48
  end
74
49
  end
@@ -3,81 +3,52 @@
3
3
  # The OpenSearch Contributors require contributions made to
4
4
  # this file be licensed under the Apache-2.0 license or a
5
5
  # compatible open source license.
6
- #
7
- # Modifications Copyright OpenSearch Contributors. See
8
- # GitHub history for details.
9
- #
10
- # Licensed to Elasticsearch B.V. under one or more contributor
11
- # license agreements. See the NOTICE file distributed with
12
- # this work for additional information regarding copyright
13
- # ownership. Elasticsearch B.V. licenses this file to you under
14
- # the Apache License, Version 2.0 (the "License"); you may
15
- # not use this file except in compliance with the License.
16
- # You may obtain a copy of the License at
17
- #
18
- # http://www.apache.org/licenses/LICENSE-2.0
19
- #
20
- # Unless required by applicable law or agreed to in writing,
21
- # software distributed under the License is distributed on an
22
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23
- # KIND, either express or implied. See the License for the
24
- # specific language governing permissions and limitations
25
- # under the License.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
26
11
 
27
12
  module OpenSearch
28
13
  module API
29
14
  module Cat
30
15
  module Actions
31
- # Returns information about index shard recoveries, both on-going completed.
32
- #
33
- # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
34
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
- # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries
36
- # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
37
- # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries
38
- # @option arguments [List] :h Comma-separated list of column names to display
39
- # @option arguments [Boolean] :help Return help information
40
- # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
41
- # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
42
- # @option arguments [Boolean] :v Verbose mode. Display column headers
43
- # @option arguments [Hash] :headers Custom HTTP headers
16
+ # Returns all completed and ongoing index and shard recoveries.
44
17
  #
45
- #
46
- def recovery(arguments = {})
47
- headers = arguments.delete(:headers) || {}
48
-
49
- arguments = arguments.clone
50
-
51
- _index = arguments.delete(:index)
18
+ # @option args [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
19
+ # @option args [String] :bytes The units used to display byte values.
20
+ # @option args [Boolean] :detailed When `true`, includes detailed information about shard recoveries.
21
+ # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
22
+ # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
23
+ # @option args [Boolean] :help Returns help information.
24
+ # @option args [Enumerable<String>] :index A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
25
+ # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
26
+ # @option args [String] :time Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
27
+ # @option args [Boolean] :v Enables verbose mode, which displays column headers.
28
+ def recovery(args = {})
29
+ args = Utils.clone_and_normalize_arguments(args)
30
+ _index = args.delete('index')
52
31
 
53
- method = OpenSearch::API::HTTP_GET
54
- path = if _index
55
- "_cat/recovery/#{Utils.__listify(_index)}"
56
- else
57
- '_cat/recovery'
58
- end
59
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
60
- params[:h] = Utils.__listify(params[:h]) if params[:h]
32
+ headers = args.delete('headers') || {}
33
+ body = args.delete('body')
34
+ method = 'GET'
35
+ url = Utils.build_url('_cat/recovery', _index)
61
36
 
62
- body = nil
63
- perform_request(method, path, params, body, headers).body
37
+ Utils.validate_query_params! args, RECOVERY_QUERY_PARAMS
38
+ transport.perform_request(method, url, args, body, headers).body
64
39
  end
65
40
 
66
- # Register this action with its valid params when the module is loaded.
67
- #
68
- # @since 6.2.0
69
- ParamsRegistry.register(:recovery, %i[
70
- format
41
+ RECOVERY_QUERY_PARAMS = Set.new(%w[
71
42
  active_only
72
43
  bytes
73
44
  detailed
45
+ format
74
46
  h
75
47
  help
76
- index
77
48
  s
78
49
  time
79
50
  v
80
- ].freeze)
51
+ ]).freeze
81
52
  end
82
53
  end
83
54
  end
@@ -3,70 +3,47 @@
3
3
  # The OpenSearch Contributors require contributions made to
4
4
  # this file be licensed under the Apache-2.0 license or a
5
5
  # compatible open source license.
6
- #
7
- # Modifications Copyright OpenSearch Contributors. See
8
- # GitHub history for details.
9
- #
10
- # Licensed to Elasticsearch B.V. under one or more contributor
11
- # license agreements. See the NOTICE file distributed with
12
- # this work for additional information regarding copyright
13
- # ownership. Elasticsearch B.V. licenses this file to you under
14
- # the Apache License, Version 2.0 (the "License"); you may
15
- # not use this file except in compliance with the License.
16
- # You may obtain a copy of the License at
17
- #
18
- # http://www.apache.org/licenses/LICENSE-2.0
19
- #
20
- # Unless required by applicable law or agreed to in writing,
21
- # software distributed under the License is distributed on an
22
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23
- # KIND, either express or implied. See the License for the
24
- # specific language governing permissions and limitations
25
- # under the License.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
26
11
 
27
12
  module OpenSearch
28
13
  module API
29
14
  module Cat
30
15
  module Actions
31
- # Returns information about snapshot repositories registered in the cluster.
32
- #
33
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
34
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node
35
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
36
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
37
- # @option arguments [List] :h Comma-separated list of column names to display
38
- # @option arguments [Boolean] :help Return help information
39
- # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
40
- # @option arguments [Boolean] :v Verbose mode. Display column headers
41
- # @option arguments [Hash] :headers Custom HTTP headers
16
+ # Returns information about all snapshot repositories for a cluster.
42
17
  #
43
- #
44
- def repositories(arguments = {})
45
- headers = arguments.delete(:headers) || {}
46
-
47
- arguments = arguments.clone
18
+ # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
19
+ # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
20
+ # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
21
+ # @option args [Boolean] :help Returns help information.
22
+ # @option args [Boolean] :local Returns local information but does not retrieve the state from the cluster manager node.
23
+ # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
24
+ # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
25
+ # @option args [Boolean] :v Enables verbose mode, which displays column headers.
26
+ def repositories(args = {})
27
+ args = Utils.clone_and_normalize_arguments(args)
28
+ headers = args.delete('headers') || {}
29
+ body = args.delete('body')
30
+ method = 'GET'
31
+ url = '_cat/repositories'
48
32
 
49
- method = OpenSearch::API::HTTP_GET
50
- path = '_cat/repositories'
51
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
52
-
53
- body = nil
54
- perform_request(method, path, params, body, headers).body
33
+ Utils.validate_query_params! args, REPOSITORIES_QUERY_PARAMS
34
+ transport.perform_request(method, url, args, body, headers).body
55
35
  end
56
36
 
57
- # Register this action with its valid params when the module is loaded.
58
- #
59
- # @since 6.2.0
60
- ParamsRegistry.register(:repositories, %i[
61
- format
62
- local
63
- master_timeout
37
+ REPOSITORIES_QUERY_PARAMS = Set.new(%w[
64
38
  cluster_manager_timeout
39
+ format
65
40
  h
66
41
  help
42
+ local
43
+ master_timeout
67
44
  s
68
45
  v
69
- ].freeze)
46
+ ]).freeze
70
47
  end
71
48
  end
72
49
  end
@@ -0,0 +1,70 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ #
3
+ # The OpenSearch Contributors require contributions made to
4
+ # this file be licensed under the Apache-2.0 license or a
5
+ # compatible open source license.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
11
+
12
+ module OpenSearch
13
+ module API
14
+ module Cat
15
+ module Actions
16
+ # Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.
17
+ # These metrics provide information about how far behind the primary shard the replicas are lagging.
18
+ #
19
+ # @option args [Boolean] :active_only When `true`, the response only includes ongoing segment replication events.
20
+ # @option args [Boolean] :allow_no_indices Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified.
21
+ # @option args [String] :bytes The units used to display byte values.
22
+ # @option args [Boolean] :completed_only When `true`, the response only includes the last-completed segment replication events.
23
+ # @option args [Boolean] :detailed When `true`, the response includes additional metrics for each stage of a segment replication event.
24
+ # @option args [Enumerable<String>, String] :expand_wildcards Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
25
+ # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
26
+ # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
27
+ # @option args [Boolean] :help Returns help information.
28
+ # @option args [Boolean] :ignore_throttled Whether specified concrete, expanded, or aliased indexes should be ignored when throttled.
29
+ # @option args [Boolean] :ignore_unavailable Whether the specified concrete indexes should be ignored when missing or closed.
30
+ # @option args [Enumerable<String>] :index A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
31
+ # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
32
+ # @option args [Enumerable<String>] :shards A comma-separated list of shards to display.
33
+ # @option args [String] :time Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
34
+ # @option args [String] :timeout The operation timeout.
35
+ # @option args [Boolean] :v Enables verbose mode, which displays column headers.
36
+ def segment_replication(args = {})
37
+ args = Utils.clone_and_normalize_arguments(args)
38
+ _index = args.delete('index')
39
+
40
+ headers = args.delete('headers') || {}
41
+ body = args.delete('body')
42
+ method = 'GET'
43
+ url = Utils.build_url('_cat/segment_replication', _index)
44
+
45
+ Utils.validate_query_params! args, SEGMENT_REPLICATION_QUERY_PARAMS
46
+ transport.perform_request(method, url, args, body, headers).body
47
+ end
48
+
49
+ SEGMENT_REPLICATION_QUERY_PARAMS = Set.new(%w[
50
+ active_only
51
+ allow_no_indices
52
+ bytes
53
+ completed_only
54
+ detailed
55
+ expand_wildcards
56
+ format
57
+ h
58
+ help
59
+ ignore_throttled
60
+ ignore_unavailable
61
+ s
62
+ shards
63
+ time
64
+ timeout
65
+ v
66
+ ]).freeze
67
+ end
68
+ end
69
+ end
70
+ end
@@ -3,26 +3,11 @@
3
3
  # The OpenSearch Contributors require contributions made to
4
4
  # this file be licensed under the Apache-2.0 license or a
5
5
  # compatible open source license.
6
- #
7
- # Modifications Copyright OpenSearch Contributors. See
8
- # GitHub history for details.
9
- #
10
- # Licensed to Elasticsearch B.V. under one or more contributor
11
- # license agreements. See the NOTICE file distributed with
12
- # this work for additional information regarding copyright
13
- # ownership. Elasticsearch B.V. licenses this file to you under
14
- # the Apache License, Version 2.0 (the "License"); you may
15
- # not use this file except in compliance with the License.
16
- # You may obtain a copy of the License at
17
- #
18
- # http://www.apache.org/licenses/LICENSE-2.0
19
- #
20
- # Unless required by applicable law or agreed to in writing,
21
- # software distributed under the License is distributed on an
22
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23
- # KIND, either express or implied. See the License for the
24
- # specific language governing permissions and limitations
25
- # under the License.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
26
11
 
27
12
  module OpenSearch
28
13
  module API
@@ -30,46 +15,38 @@ module OpenSearch
30
15
  module Actions
31
16
  # Provides low-level information about the segments in the shards of an index.
32
17
  #
33
- # @option arguments [List] :index A comma-separated list of index names to limit the returned information
34
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
- # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
36
- # @option arguments [List] :h Comma-separated list of column names to display
37
- # @option arguments [Boolean] :help Return help information
38
- # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
39
- # @option arguments [Boolean] :v Verbose mode. Display column headers
40
- # @option arguments [Hash] :headers Custom HTTP headers
41
- #
42
- #
43
- def segments(arguments = {})
44
- headers = arguments.delete(:headers) || {}
45
-
46
- arguments = arguments.clone
47
-
48
- _index = arguments.delete(:index)
18
+ # @option args [String] :bytes The units used to display byte values.
19
+ # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
20
+ # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
21
+ # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
22
+ # @option args [Boolean] :help Returns help information.
23
+ # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
24
+ # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
25
+ # @option args [Boolean] :v Enables verbose mode, which displays column headers.
26
+ # @option args [Enumerable<String>, String] :index A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
27
+ def segments(args = {})
28
+ args = Utils.clone_and_normalize_arguments(args)
29
+ _index = args.delete('index')
49
30
 
50
- method = OpenSearch::API::HTTP_GET
51
- path = if _index
52
- "_cat/segments/#{Utils.__listify(_index)}"
53
- else
54
- '_cat/segments'
55
- end
56
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
31
+ headers = args.delete('headers') || {}
32
+ body = args.delete('body')
33
+ method = 'GET'
34
+ url = Utils.build_url('_cat/segments', _index)
57
35
 
58
- body = nil
59
- perform_request(method, path, params, body, headers).body
36
+ Utils.validate_query_params! args, SEGMENTS_QUERY_PARAMS
37
+ transport.perform_request(method, url, args, body, headers).body
60
38
  end
61
39
 
62
- # Register this action with its valid params when the module is loaded.
63
- #
64
- # @since 6.2.0
65
- ParamsRegistry.register(:segments, %i[
66
- format
40
+ SEGMENTS_QUERY_PARAMS = Set.new(%w[
67
41
  bytes
42
+ cluster_manager_timeout
43
+ format
68
44
  h
69
45
  help
46
+ master_timeout
70
47
  s
71
48
  v
72
- ].freeze)
49
+ ]).freeze
73
50
  end
74
51
  end
75
52
  end
@@ -3,82 +3,54 @@
3
3
  # The OpenSearch Contributors require contributions made to
4
4
  # this file be licensed under the Apache-2.0 license or a
5
5
  # compatible open source license.
6
- #
7
- # Modifications Copyright OpenSearch Contributors. See
8
- # GitHub history for details.
9
- #
10
- # Licensed to Elasticsearch B.V. under one or more contributor
11
- # license agreements. See the NOTICE file distributed with
12
- # this work for additional information regarding copyright
13
- # ownership. Elasticsearch B.V. licenses this file to you under
14
- # the Apache License, Version 2.0 (the "License"); you may
15
- # not use this file except in compliance with the License.
16
- # You may obtain a copy of the License at
17
- #
18
- # http://www.apache.org/licenses/LICENSE-2.0
19
- #
20
- # Unless required by applicable law or agreed to in writing,
21
- # software distributed under the License is distributed on an
22
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23
- # KIND, either express or implied. See the License for the
24
- # specific language governing permissions and limitations
25
- # under the License.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
26
11
 
27
12
  module OpenSearch
28
13
  module API
29
14
  module Cat
30
15
  module Actions
31
- # Provides a detailed view of shard allocation on nodes.
32
- #
33
- # @option arguments [List] :index A comma-separated list of index names to limit the returned information
34
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
- # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
36
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) *Deprecated*
37
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
38
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
39
- # @option arguments [List] :h Comma-separated list of column names to display
40
- # @option arguments [Boolean] :help Return help information
41
- # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
42
- # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
43
- # @option arguments [Boolean] :v Verbose mode. Display column headers
44
- # @option arguments [Hash] :headers Custom HTTP headers
16
+ # Lists the states of all primary and replica shards and how they are distributed.
45
17
  #
46
- #
47
- def shards(arguments = {})
48
- headers = arguments.delete(:headers) || {}
49
-
50
- arguments = arguments.clone
18
+ # @option args [String] :bytes The units used to display byte values.
19
+ # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
20
+ # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
21
+ # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
22
+ # @option args [Boolean] :help Returns help information.
23
+ # @option args [Boolean] :local Returns local information but does not retrieve the state from the cluster manager node.
24
+ # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
25
+ # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
26
+ # @option args [String] :time Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
27
+ # @option args [Boolean] :v Enables verbose mode, which displays column headers.
28
+ # @option args [Enumerable<String>, String] :index A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
29
+ def shards(args = {})
30
+ args = Utils.clone_and_normalize_arguments(args)
31
+ _index = args.delete('index')
51
32
 
52
- _index = arguments.delete(:index)
33
+ headers = args.delete('headers') || {}
34
+ body = args.delete('body')
35
+ method = 'GET'
36
+ url = Utils.build_url('_cat/shards', _index)
53
37
 
54
- method = OpenSearch::API::HTTP_GET
55
- path = if _index
56
- "_cat/shards/#{Utils.__listify(_index)}"
57
- else
58
- '_cat/shards'
59
- end
60
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
61
- params[:h] = Utils.__listify(params[:h]) if params[:h]
62
-
63
- body = nil
64
- perform_request(method, path, params, body, headers).body
38
+ Utils.validate_query_params! args, SHARDS_QUERY_PARAMS
39
+ transport.perform_request(method, url, args, body, headers).body
65
40
  end
66
41
 
67
- # Register this action with its valid params when the module is loaded.
68
- #
69
- # @since 6.2.0
70
- ParamsRegistry.register(:shards, %i[
71
- format
42
+ SHARDS_QUERY_PARAMS = Set.new(%w[
72
43
  bytes
73
- local
74
- master_timeout
75
44
  cluster_manager_timeout
45
+ format
76
46
  h
77
47
  help
48
+ local
49
+ master_timeout
78
50
  s
79
51
  time
80
52
  v
81
- ].freeze)
53
+ ]).freeze
82
54
  end
83
55
  end
84
56
  end