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,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,69 +15,47 @@ module OpenSearch
30
15
  module Actions
31
16
  # Allows a user to validate a potentially expensive query without executing it.
32
17
  #
33
- # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
34
- # @option arguments [Boolean] :explain Return detailed information about the error
35
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
36
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
37
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
38
- # @option arguments [String] :q Query in the Lucene query string syntax
39
- # @option arguments [String] :analyzer The analyzer to use for the query string
40
- # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
41
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
42
- # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
43
- # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
44
- # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed.
45
- # @option arguments [Boolean] :all_shards Execute validation on all shards instead of one random shard per index
46
- # @option arguments [Hash] :headers Custom HTTP headers
47
- # @option arguments [Hash] :body The query definition specified with the Query DSL
48
- #
49
- # *Deprecation notice*:
50
- # Specifying types in urls has been deprecated
51
- # Deprecated since version 7.0.0
52
- #
53
- #
54
- #
55
- def validate_query(arguments = {})
56
- headers = arguments.delete(:headers) || {}
57
-
58
- arguments = arguments.clone
59
-
60
- _index = arguments.delete(:index)
61
-
62
- method = if arguments[:body]
63
- OpenSearch::API::HTTP_POST
64
- else
65
- OpenSearch::API::HTTP_GET
66
- end
18
+ # @option args [Boolean] :all_shards If `true`, the validation is executed on all shards instead of one random shard per index.
19
+ # @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.
20
+ # @option args [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
21
+ # @option args [String] :analyzer Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified.
22
+ # @option args [String] :default_operator The default operator for query string query: `AND` or `OR`.
23
+ # @option args [String] :df Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified.
24
+ # @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
25
+ # @option args [Boolean] :explain If `true`, the response returns detailed information if an error has occurred.
26
+ # @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
27
+ # @option args [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
28
+ # @option args [String] :q Query in the Lucene query string syntax.
29
+ # @option args [Boolean] :rewrite If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.
30
+ # @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`.
31
+ # @option args [Hash] :body The query definition specified with the Query DSL
32
+ def validate_query(args = {})
33
+ args = Utils.clone_and_normalize_arguments(args)
34
+ _index = args.delete('index')
67
35
 
68
- path = if _index
69
- "#{Utils.__listify(_index)}/_validate/query"
70
- else
71
- '_validate/query'
72
- end
73
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
36
+ headers = args.delete('headers') || {}
37
+ body = args.delete('body')
38
+ method = body ? 'POST' : 'GET'
39
+ url = Utils.build_url(_index, '_validate/query')
74
40
 
75
- body = arguments[:body]
76
- perform_request(method, path, params, body, headers).body
41
+ Utils.validate_query_params! args, VALIDATE_QUERY_QUERY_PARAMS
42
+ transport.perform_request(method, url, args, body, headers).body
77
43
  end
78
44
 
79
- # Register this action with its valid params when the module is loaded.
80
- #
81
- # @since 6.2.0
82
- ParamsRegistry.register(:validate_query, %i[
83
- explain
84
- ignore_unavailable
45
+ VALIDATE_QUERY_QUERY_PARAMS = Set.new(%w[
46
+ all_shards
85
47
  allow_no_indices
86
- expand_wildcards
87
- q
88
- analyzer
89
48
  analyze_wildcard
49
+ analyzer
90
50
  default_operator
91
51
  df
52
+ expand_wildcards
53
+ explain
54
+ ignore_unavailable
92
55
  lenient
56
+ q
93
57
  rewrite
94
- all_shards
95
- ].freeze)
58
+ ]).freeze
96
59
  end
97
60
  end
98
61
  end
@@ -3,46 +3,28 @@
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.
26
6
 
27
- module OpenSearch
28
- module API
29
- module Actions
30
- # Returns basic information about the cluster.
31
- #
32
- # @option arguments [Hash] :headers Custom HTTP headers
33
- #
34
- #
35
- def info(arguments = {})
36
- headers = arguments.delete(:headers) || {}
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.
37
9
 
38
- arguments = arguments.clone
10
+ # frozen_string_literal: true
39
11
 
40
- method = OpenSearch::API::HTTP_GET
41
- path = ''
42
- params = {}
12
+ module OpenSearch
13
+ module API
14
+ module Root
15
+ module Actions
16
+ # Returns basic information about the cluster.
17
+ #
18
+ def info(args = {})
19
+ args = Utils.clone_and_normalize_arguments(args)
20
+ headers = args.delete('headers') || {}
21
+ body = args.delete('body')
22
+ method = 'GET'
23
+ url = '/'
43
24
 
44
- body = nil
45
- perform_request(method, path, params, body, headers).body
25
+ Utils.validate_query_params! args
26
+ transport.perform_request(method, url, args, body, headers).body
27
+ end
46
28
  end
47
29
  end
48
30
  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,38 +15,30 @@ module OpenSearch
30
15
  module Actions
31
16
  # Deletes a pipeline.
32
17
  #
33
- # @option arguments [String] :id Pipeline ID
34
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
35
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
36
- # @option arguments [Time] :timeout Explicit operation timeout
37
- # @option arguments [Hash] :headers Custom HTTP headers
38
- #
39
- #
40
- def delete_pipeline(arguments = {})
41
- raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
42
-
43
- headers = arguments.delete(:headers) || {}
44
-
45
- arguments = arguments.clone
18
+ # @option args [String] :id *Required* Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`.
19
+ # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
20
+ # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
21
+ # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
22
+ def delete_pipeline(args = {})
23
+ args = Utils.clone_and_normalize_arguments(args)
24
+ raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
46
25
 
47
- _id = arguments.delete(:id)
26
+ _id = args.delete('id')
48
27
 
49
- method = OpenSearch::API::HTTP_DELETE
50
- path = "_ingest/pipeline/#{Utils.__listify(_id)}"
51
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
28
+ headers = args.delete('headers') || {}
29
+ body = args.delete('body')
30
+ method = 'DELETE'
31
+ url = Utils.build_url('_ingest/pipeline', _id)
52
32
 
53
- body = nil
54
- perform_request(method, path, params, body, headers).body
33
+ Utils.validate_query_params! args, DELETE_PIPELINE_QUERY_PARAMS
34
+ transport.perform_delete_request method, url, args, body, headers
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(:delete_pipeline, %i[
61
- master_timeout
37
+ DELETE_PIPELINE_QUERY_PARAMS = Set.new(%w[
62
38
  cluster_manager_timeout
39
+ master_timeout
63
40
  timeout
64
- ].freeze)
41
+ ]).freeze
65
42
  end
66
43
  end
67
44
  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,40 +15,26 @@ module OpenSearch
30
15
  module Actions
31
16
  # Returns a pipeline.
32
17
  #
33
- # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported
34
- # @option arguments [Boolean] :summary Return pipelines without their definitions (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 [Hash] :headers Custom HTTP headers
38
- #
39
- #
40
- def get_pipeline(arguments = {})
41
- headers = arguments.delete(:headers) || {}
42
-
43
- arguments = arguments.clone
44
-
45
- _id = arguments.delete(:id)
18
+ # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
19
+ # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
20
+ # @option args [String] :id Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`.
21
+ def get_pipeline(args = {})
22
+ args = Utils.clone_and_normalize_arguments(args)
23
+ _id = args.delete('id')
46
24
 
47
- method = OpenSearch::API::HTTP_GET
48
- path = if _id
49
- "_ingest/pipeline/#{Utils.__listify(_id)}"
50
- else
51
- '_ingest/pipeline'
52
- end
53
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
25
+ headers = args.delete('headers') || {}
26
+ body = args.delete('body')
27
+ method = 'GET'
28
+ url = Utils.build_url('_ingest/pipeline', _id)
54
29
 
55
- body = nil
56
- perform_request(method, path, params, body, headers).body
30
+ Utils.validate_query_params! args, GET_PIPELINE_QUERY_PARAMS
31
+ transport.perform_request(method, url, args, body, headers).body
57
32
  end
58
33
 
59
- # Register this action with its valid params when the module is loaded.
60
- #
61
- # @since 6.2.0
62
- ParamsRegistry.register(:get_pipeline, %i[
63
- summary
64
- master_timeout
34
+ GET_PIPELINE_QUERY_PARAMS = Set.new(%w[
65
35
  cluster_manager_timeout
66
- ].freeze)
36
+ master_timeout
37
+ ]).freeze
67
38
  end
68
39
  end
69
40
  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,21 +15,21 @@ module OpenSearch
30
15
  module Actions
31
16
  # Returns a list of the built-in patterns.
32
17
  #
33
- # @option arguments [Hash] :headers Custom HTTP headers
34
- #
35
- #
36
- def processor_grok(arguments = {})
37
- headers = arguments.delete(:headers) || {}
38
-
39
- arguments = arguments.clone
18
+ # @option args [Boolean] :s Sort returned patterns by key name.
19
+ def processor_grok(args = {})
20
+ args = Utils.clone_and_normalize_arguments(args)
21
+ headers = args.delete('headers') || {}
22
+ body = args.delete('body')
23
+ method = 'GET'
24
+ url = '_ingest/processor/grok'
40
25
 
41
- method = OpenSearch::API::HTTP_GET
42
- path = '_ingest/processor/grok'
43
- params = {}
44
-
45
- body = nil
46
- perform_request(method, path, params, body, headers).body
26
+ Utils.validate_query_params! args, PROCESSOR_GROK_QUERY_PARAMS
27
+ transport.perform_request(method, url, args, body, headers).body
47
28
  end
29
+
30
+ PROCESSOR_GROK_QUERY_PARAMS = Set.new(%w[
31
+ s
32
+ ]).freeze
48
33
  end
49
34
  end
50
35
  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,40 +15,32 @@ module OpenSearch
30
15
  module Actions
31
16
  # Creates or updates a pipeline.
32
17
  #
33
- # @option arguments [String] :id Pipeline ID
34
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
35
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
36
- # @option arguments [Time] :timeout Explicit operation timeout
37
- # @option arguments [Hash] :headers Custom HTTP headers
38
- # @option arguments [Hash] :body The ingest definition (*Required*)
39
- #
40
- #
41
- def put_pipeline(arguments = {})
42
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
43
- raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
44
-
45
- headers = arguments.delete(:headers) || {}
46
-
47
- arguments = arguments.clone
18
+ # @option args [String] :id *Required* ID of the ingest pipeline to create or update.
19
+ # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
20
+ # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
21
+ # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
22
+ # @option args [Hash] :body *Required* The ingest definition
23
+ def put_pipeline(args = {})
24
+ args = Utils.clone_and_normalize_arguments(args)
25
+ raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
26
+ raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
48
27
 
49
- _id = arguments.delete(:id)
28
+ _id = args.delete('id')
50
29
 
51
- method = OpenSearch::API::HTTP_PUT
52
- path = "_ingest/pipeline/#{Utils.__listify(_id)}"
53
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
30
+ headers = args.delete('headers') || {}
31
+ body = args.delete('body')
32
+ method = 'PUT'
33
+ url = Utils.build_url('_ingest/pipeline', _id)
54
34
 
55
- body = arguments[:body]
56
- perform_request(method, path, params, body, headers).body
35
+ Utils.validate_query_params! args, PUT_PIPELINE_QUERY_PARAMS
36
+ transport.perform_request(method, url, args, body, headers).body
57
37
  end
58
38
 
59
- # Register this action with its valid params when the module is loaded.
60
- #
61
- # @since 6.2.0
62
- ParamsRegistry.register(:put_pipeline, %i[
63
- master_timeout
39
+ PUT_PIPELINE_QUERY_PARAMS = Set.new(%w[
64
40
  cluster_manager_timeout
41
+ master_timeout
65
42
  timeout
66
- ].freeze)
43
+ ]).freeze
67
44
  end
68
45
  end
69
46
  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,39 +15,27 @@ module OpenSearch
30
15
  module Actions
31
16
  # Allows to simulate a pipeline with example documents.
32
17
  #
33
- # @option arguments [String] :id Pipeline ID
34
- # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline
35
- # @option arguments [Hash] :headers Custom HTTP headers
36
- # @option arguments [Hash] :body The simulate definition (*Required*)
37
- #
38
- #
39
- def simulate(arguments = {})
40
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
41
-
42
- headers = arguments.delete(:headers) || {}
18
+ # @option args [Boolean] :verbose If `true`, the response includes output data for each processor in the executed pipeline.
19
+ # @option args [String] :id Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.
20
+ # @option args [Hash] :body *Required* The simulate definition
21
+ def simulate(args = {})
22
+ args = Utils.clone_and_normalize_arguments(args)
23
+ raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
43
24
 
44
- arguments = arguments.clone
25
+ _id = args.delete('id')
45
26
 
46
- _id = arguments.delete(:id)
27
+ headers = args.delete('headers') || {}
28
+ body = args.delete('body')
29
+ method = body ? 'POST' : 'GET'
30
+ url = Utils.build_url('_ingest/pipeline', _id, '_simulate')
47
31
 
48
- method = OpenSearch::API::HTTP_POST
49
- path = if _id
50
- "_ingest/pipeline/#{Utils.__listify(_id)}/_simulate"
51
- else
52
- '_ingest/pipeline/_simulate'
53
- end
54
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
55
-
56
- body = arguments[:body]
57
- perform_request(method, path, params, body, headers).body
32
+ Utils.validate_query_params! args, SIMULATE_QUERY_PARAMS
33
+ transport.perform_request(method, url, args, body, headers).body
58
34
  end
59
35
 
60
- # Register this action with its valid params when the module is loaded.
61
- #
62
- # @since 6.2.0
63
- ParamsRegistry.register(:simulate, [
64
- :verbose
65
- ].freeze)
36
+ SIMULATE_QUERY_PARAMS = Set.new(%w[
37
+ verbose
38
+ ]).freeze
66
39
  end
67
40
  end
68
41
  end