opensearch-ruby 3.3.0 → 4.0.0.pre.beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (431) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/lib/opensearch/api/actions/asynchronous_search/delete.rb +38 -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 +29 -55
  21. data/lib/opensearch/api/actions/cat/pending_tasks.rb +27 -51
  22. data/lib/opensearch/api/actions/cat/pit_segments.rb +24 -25
  23. data/lib/opensearch/api/actions/cat/plugins.rb +26 -51
  24. data/lib/opensearch/api/actions/cat/recovery.rb +27 -56
  25. data/lib/opensearch/api/actions/cat/repositories.rb +26 -49
  26. data/lib/opensearch/api/actions/cat/segment_replication.rb +69 -0
  27. data/lib/opensearch/api/actions/cat/segments.rb +28 -51
  28. data/lib/opensearch/api/actions/cat/shards.rb +30 -58
  29. data/lib/opensearch/api/actions/cat/snapshots.rb +30 -55
  30. data/lib/opensearch/api/actions/cat/tasks.rb +28 -51
  31. data/lib/opensearch/api/actions/cat/templates.rb +28 -55
  32. data/lib/opensearch/api/actions/cat/thread_pool.rb +30 -58
  33. data/lib/opensearch/api/actions/clear_scroll.rb +23 -48
  34. data/lib/opensearch/api/actions/cluster/allocation_explain.rb +19 -47
  35. data/lib/opensearch/api/actions/cluster/delete_component_template.rb +26 -47
  36. data/lib/opensearch/api/actions/cluster/delete_decommission_awareness.rb +33 -0
  37. data/lib/opensearch/api/actions/cluster/delete_voting_config_exclusions.rb +19 -40
  38. data/lib/opensearch/api/actions/cluster/delete_weighted_routing.rb +34 -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 +22 -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 +19 -42
  46. data/lib/opensearch/api/actions/cluster/post_voting_config_exclusions.rb +18 -41
  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 +33 -63
  54. data/lib/opensearch/api/actions/cluster/stats.rb +23 -46
  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 +28 -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 +47 -76
  62. data/lib/opensearch/api/actions/delete_all_pits.rb +20 -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 +21 -17
  66. data/lib/opensearch/api/actions/delete_script.rb +31 -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 +43 -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 +30 -55
  97. data/lib/opensearch/api/actions/indices/delete_alias.rb +31 -53
  98. data/lib/opensearch/api/actions/indices/delete_data_stream.rb +38 -0
  99. data/lib/opensearch/api/actions/indices/delete_index_template.rb +25 -46
  100. data/lib/opensearch/api/actions/indices/delete_template.rb +25 -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 +25 -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 +24 -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 +38 -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 +38 -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/create_connector.rb +32 -0
  166. data/lib/opensearch/api/actions/ml/delete_agent.rb +38 -0
  167. data/lib/opensearch/api/actions/ml/delete_connector.rb +38 -0
  168. data/lib/opensearch/api/actions/ml/delete_model.rb +38 -0
  169. data/lib/opensearch/api/actions/ml/delete_model_group.rb +38 -0
  170. data/lib/opensearch/api/actions/ml/delete_task.rb +38 -0
  171. data/lib/opensearch/api/actions/ml/deploy_model.rb +36 -0
  172. data/lib/opensearch/api/actions/ml/get_model_group.rb +36 -0
  173. data/lib/opensearch/api/actions/ml/get_task.rb +36 -0
  174. data/lib/opensearch/api/actions/ml/register_agents.rb +32 -0
  175. data/lib/opensearch/api/actions/ml/register_model.rb +32 -0
  176. data/lib/opensearch/api/actions/ml/register_model_group.rb +32 -0
  177. data/lib/opensearch/api/actions/ml/search_models.rb +32 -0
  178. data/lib/opensearch/api/actions/ml/undeploy_model.rb +36 -0
  179. data/lib/opensearch/api/actions/msearch.rb +40 -91
  180. data/lib/opensearch/api/actions/msearch_template.rb +36 -75
  181. data/lib/opensearch/api/actions/mtermvectors.rb +47 -87
  182. data/lib/opensearch/api/actions/nodes/hot_threads.rb +25 -57
  183. data/lib/opensearch/api/actions/nodes/info.rb +23 -53
  184. data/lib/opensearch/api/actions/nodes/reload_secure_settings.rb +20 -47
  185. data/lib/opensearch/api/actions/nodes/stats.rb +33 -72
  186. data/lib/opensearch/api/actions/nodes/usage.rb +21 -53
  187. data/lib/opensearch/api/actions/notifications/create_config.rb +34 -0
  188. data/lib/opensearch/api/actions/notifications/delete_config.rb +38 -0
  189. data/lib/opensearch/api/actions/notifications/delete_configs.rb +42 -0
  190. data/lib/opensearch/api/actions/notifications/get_config.rb +36 -0
  191. data/lib/opensearch/api/actions/notifications/get_configs.rb +115 -0
  192. data/lib/opensearch/api/actions/notifications/list_channels.rb +31 -0
  193. data/lib/opensearch/api/actions/notifications/list_features.rb +31 -0
  194. data/lib/opensearch/api/actions/notifications/send_test.rb +36 -0
  195. data/lib/opensearch/api/actions/notifications/update_config.rb +38 -0
  196. data/lib/opensearch/api/actions/observability/create_object.rb +32 -0
  197. data/lib/opensearch/api/actions/observability/delete_object.rb +38 -0
  198. data/lib/opensearch/api/actions/observability/delete_objects.rb +40 -0
  199. data/lib/opensearch/api/actions/observability/get_localstats.rb +31 -0
  200. data/lib/opensearch/api/actions/observability/get_object.rb +36 -0
  201. data/lib/opensearch/api/actions/observability/list_objects.rb +31 -0
  202. data/lib/opensearch/api/actions/observability/update_object.rb +37 -0
  203. data/lib/opensearch/api/actions/ping.rb +17 -40
  204. data/lib/opensearch/api/actions/ppl/explain.rb +41 -0
  205. data/lib/opensearch/api/actions/ppl/get_stats.rb +38 -0
  206. data/lib/opensearch/api/actions/ppl/post_stats.rb +41 -0
  207. data/lib/opensearch/api/actions/ppl/query.rb +41 -0
  208. data/lib/opensearch/api/actions/put_script.rb +37 -64
  209. data/lib/opensearch/api/actions/query/datasource_delete.rb +38 -0
  210. data/lib/opensearch/api/actions/query/datasource_retrieve.rb +36 -0
  211. data/lib/opensearch/api/actions/query/datasources_create.rb +32 -0
  212. data/lib/opensearch/api/actions/query/datasources_list.rb +31 -0
  213. data/lib/opensearch/api/actions/query/datasources_update.rb +32 -0
  214. data/lib/opensearch/api/actions/rank_eval.rb +32 -61
  215. data/lib/opensearch/api/actions/reindex.rb +40 -61
  216. data/lib/opensearch/api/actions/reindex_rethrottle.rb +25 -46
  217. data/lib/opensearch/api/actions/remote_store/restore.rb +19 -21
  218. data/lib/opensearch/api/actions/render_search_template.rb +21 -48
  219. data/lib/opensearch/api/actions/replication/autofollow_stats.rb +31 -0
  220. data/lib/opensearch/api/actions/replication/create_replication_rule.rb +34 -0
  221. data/lib/opensearch/api/actions/replication/delete_replication_rule.rb +36 -0
  222. data/lib/opensearch/api/actions/replication/follower_stats.rb +31 -0
  223. data/lib/opensearch/api/actions/replication/leader_stats.rb +31 -0
  224. data/lib/opensearch/api/actions/replication/pause.rb +38 -0
  225. data/lib/opensearch/api/actions/replication/resume.rb +38 -0
  226. data/lib/opensearch/api/actions/replication/start.rb +38 -0
  227. data/lib/opensearch/api/actions/replication/status.rb +36 -0
  228. data/lib/opensearch/api/actions/replication/stop.rb +38 -0
  229. data/lib/opensearch/api/actions/replication/update_settings.rb +38 -0
  230. data/lib/opensearch/api/actions/rollups/delete.rb +38 -0
  231. data/lib/opensearch/api/actions/rollups/explain.rb +36 -0
  232. data/lib/opensearch/api/actions/rollups/get.rb +36 -0
  233. data/lib/opensearch/api/actions/rollups/put.rb +44 -0
  234. data/lib/opensearch/api/actions/rollups/start.rb +36 -0
  235. data/lib/opensearch/api/actions/rollups/stop.rb +36 -0
  236. data/lib/opensearch/api/actions/scripts_painless_execute.rb +19 -46
  237. data/lib/opensearch/api/actions/scroll.rb +27 -63
  238. data/lib/opensearch/api/actions/search.rb +115 -146
  239. data/lib/opensearch/api/actions/search_pipeline/delete.rb +45 -0
  240. data/lib/opensearch/api/actions/search_pipeline/get.rb +39 -0
  241. data/lib/opensearch/api/actions/search_pipeline/put.rb +45 -0
  242. data/lib/opensearch/api/actions/search_shards.rb +35 -59
  243. data/lib/opensearch/api/actions/search_template.rb +50 -80
  244. data/lib/opensearch/api/actions/security/authinfo.rb +38 -0
  245. data/lib/opensearch/api/actions/security/authtoken.rb +31 -0
  246. data/lib/opensearch/api/actions/security/change_password.rb +12 -17
  247. data/lib/opensearch/api/actions/security/config_upgrade_check.rb +31 -0
  248. data/lib/opensearch/api/actions/security/config_upgrade_perform.rb +32 -0
  249. data/lib/opensearch/api/actions/security/create_action_group.rb +15 -19
  250. data/lib/opensearch/api/actions/security/create_allowlist.rb +34 -0
  251. data/lib/opensearch/api/actions/security/create_role.rb +15 -20
  252. data/lib/opensearch/api/actions/security/create_role_mapping.rb +15 -20
  253. data/lib/opensearch/api/actions/security/create_tenant.rb +15 -19
  254. data/lib/opensearch/api/actions/security/create_update_tenancy_config.rb +34 -0
  255. data/lib/opensearch/api/actions/security/create_user.rb +15 -20
  256. data/lib/opensearch/api/actions/security/create_user_legacy.rb +38 -0
  257. data/lib/opensearch/api/actions/security/delete_action_group.rb +15 -18
  258. data/lib/opensearch/api/actions/security/delete_distinguished_name.rb +38 -0
  259. data/lib/opensearch/api/actions/security/delete_role.rb +15 -18
  260. data/lib/opensearch/api/actions/security/delete_role_mapping.rb +15 -18
  261. data/lib/opensearch/api/actions/security/delete_tenant.rb +15 -18
  262. data/lib/opensearch/api/actions/security/delete_user.rb +15 -18
  263. data/lib/opensearch/api/actions/security/delete_user_legacy.rb +38 -0
  264. data/lib/opensearch/api/actions/security/flush_cache.rb +12 -15
  265. data/lib/opensearch/api/actions/security/generate_obo_token.rb +34 -0
  266. data/lib/opensearch/api/actions/security/generate_user_token.rb +36 -0
  267. data/lib/opensearch/api/actions/security/generate_user_token_legacy.rb +36 -0
  268. data/lib/opensearch/api/actions/security/get_account_details.rb +10 -15
  269. data/lib/opensearch/api/actions/security/get_action_group.rb +13 -18
  270. data/lib/opensearch/api/actions/security/get_action_groups.rb +10 -15
  271. data/lib/opensearch/api/actions/security/get_all_certificates.rb +38 -0
  272. data/lib/opensearch/api/actions/security/get_allowlist.rb +31 -0
  273. data/lib/opensearch/api/actions/security/get_audit_configuration.rb +10 -15
  274. data/lib/opensearch/api/actions/security/get_certificates.rb +11 -16
  275. data/lib/opensearch/api/actions/security/get_configuration.rb +10 -15
  276. data/lib/opensearch/api/actions/security/get_dashboards_info.rb +31 -0
  277. data/lib/opensearch/api/actions/security/get_distinguished_name.rb +41 -0
  278. data/lib/opensearch/api/actions/security/get_distinguished_names.rb +16 -19
  279. data/lib/opensearch/api/actions/security/get_node_certificates.rb +43 -0
  280. data/lib/opensearch/api/actions/security/get_permissions_info.rb +31 -0
  281. data/lib/opensearch/api/actions/security/get_role.rb +13 -18
  282. data/lib/opensearch/api/actions/security/get_role_mapping.rb +13 -18
  283. data/lib/opensearch/api/actions/security/get_role_mappings.rb +10 -15
  284. data/lib/opensearch/api/actions/security/get_roles.rb +10 -15
  285. data/lib/opensearch/api/actions/security/get_sslinfo.rb +36 -0
  286. data/lib/opensearch/api/actions/security/get_tenancy_config.rb +31 -0
  287. data/lib/opensearch/api/actions/security/get_tenant.rb +13 -18
  288. data/lib/opensearch/api/actions/security/get_tenants.rb +10 -15
  289. data/lib/opensearch/api/actions/security/get_user.rb +13 -18
  290. data/lib/opensearch/api/actions/security/get_user_legacy.rb +36 -0
  291. data/lib/opensearch/api/actions/security/get_users.rb +10 -15
  292. data/lib/opensearch/api/actions/security/get_users_legacy.rb +31 -0
  293. data/lib/opensearch/api/actions/security/health.rb +15 -15
  294. data/lib/opensearch/api/actions/security/migrate.rb +31 -0
  295. data/lib/opensearch/api/actions/security/patch_action_group.rb +15 -19
  296. data/lib/opensearch/api/actions/security/patch_action_groups.rb +13 -16
  297. data/lib/opensearch/api/actions/security/patch_allowlist.rb +34 -0
  298. data/lib/opensearch/api/actions/security/patch_audit_configuration.rb +12 -17
  299. data/lib/opensearch/api/actions/security/patch_configuration.rb +13 -18
  300. data/lib/opensearch/api/actions/security/patch_distinguished_name.rb +37 -0
  301. data/lib/opensearch/api/actions/security/patch_distinguished_names.rb +13 -18
  302. data/lib/opensearch/api/actions/security/patch_role.rb +15 -20
  303. data/lib/opensearch/api/actions/security/patch_role_mapping.rb +15 -20
  304. data/lib/opensearch/api/actions/security/patch_role_mappings.rb +12 -17
  305. data/lib/opensearch/api/actions/security/patch_roles.rb +12 -17
  306. data/lib/opensearch/api/actions/security/patch_tenant.rb +15 -20
  307. data/lib/opensearch/api/actions/security/patch_tenants.rb +12 -17
  308. data/lib/opensearch/api/actions/security/patch_user.rb +15 -20
  309. data/lib/opensearch/api/actions/security/patch_users.rb +12 -17
  310. data/lib/opensearch/api/actions/security/post_dashboards_info.rb +31 -0
  311. data/lib/opensearch/api/actions/security/reload_http_certificates.rb +10 -15
  312. data/lib/opensearch/api/actions/security/reload_transport_certificates.rb +11 -16
  313. data/lib/opensearch/api/actions/security/tenant_info.rb +31 -0
  314. data/lib/opensearch/api/actions/security/update_audit_configuration.rb +12 -17
  315. data/lib/opensearch/api/actions/security/update_configuration.rb +13 -18
  316. data/lib/opensearch/api/actions/security/update_distinguished_name.rb +37 -0
  317. data/lib/opensearch/api/actions/security/validate.rb +36 -0
  318. data/lib/opensearch/api/actions/security/who_am_i.rb +31 -0
  319. data/lib/opensearch/api/actions/security/who_am_i_protected.rb +31 -0
  320. data/lib/opensearch/api/actions/sm/create_policy.rb +37 -0
  321. data/lib/opensearch/api/actions/sm/delete_policy.rb +38 -0
  322. data/lib/opensearch/api/actions/sm/explain_policy.rb +36 -0
  323. data/lib/opensearch/api/actions/sm/get_policies.rb +44 -0
  324. data/lib/opensearch/api/actions/sm/get_policy.rb +36 -0
  325. data/lib/opensearch/api/actions/sm/start_policy.rb +36 -0
  326. data/lib/opensearch/api/actions/sm/stop_policy.rb +36 -0
  327. data/lib/opensearch/api/actions/sm/update_policy.rb +46 -0
  328. data/lib/opensearch/api/actions/snapshot/cleanup_repository.rb +22 -45
  329. data/lib/opensearch/api/actions/snapshot/clone.rb +33 -58
  330. data/lib/opensearch/api/actions/snapshot/create.rb +29 -53
  331. data/lib/opensearch/api/actions/snapshot/create_repository.rb +25 -48
  332. data/lib/opensearch/api/actions/snapshot/delete.rb +29 -55
  333. data/lib/opensearch/api/actions/snapshot/delete_repository.rb +24 -49
  334. data/lib/opensearch/api/actions/snapshot/get.rb +29 -61
  335. data/lib/opensearch/api/actions/snapshot/get_repository.rb +21 -51
  336. data/lib/opensearch/api/actions/snapshot/restore.rb +29 -53
  337. data/lib/opensearch/api/actions/snapshot/status.rb +23 -57
  338. data/lib/opensearch/api/actions/snapshot/verify_repository.rb +22 -45
  339. data/lib/opensearch/api/actions/sql/close.rb +39 -0
  340. data/lib/opensearch/api/actions/sql/explain.rb +39 -0
  341. data/lib/opensearch/api/actions/sql/get_stats.rb +38 -0
  342. data/lib/opensearch/api/actions/sql/post_stats.rb +39 -0
  343. data/lib/opensearch/api/actions/sql/query.rb +39 -0
  344. data/lib/opensearch/api/actions/sql/settings.rb +37 -0
  345. data/lib/opensearch/api/actions/tasks/cancel.rb +22 -53
  346. data/lib/opensearch/api/actions/tasks/get.rb +21 -46
  347. data/lib/opensearch/api/actions/tasks/list.rb +25 -52
  348. data/lib/opensearch/api/actions/termvectors.rb +48 -92
  349. data/lib/opensearch/api/actions/transforms/delete.rb +38 -0
  350. data/lib/opensearch/api/actions/transforms/explain.rb +36 -0
  351. data/lib/opensearch/api/actions/transforms/get.rb +36 -0
  352. data/lib/opensearch/api/actions/transforms/preview.rb +32 -0
  353. data/lib/opensearch/api/actions/transforms/put.rb +44 -0
  354. data/lib/opensearch/api/actions/transforms/search.rb +44 -0
  355. data/lib/opensearch/api/actions/transforms/start.rb +36 -0
  356. data/lib/opensearch/api/actions/transforms/stop.rb +36 -0
  357. data/lib/opensearch/api/actions/update.rb +52 -83
  358. data/lib/opensearch/api/actions/update_by_query.rb +93 -121
  359. data/lib/opensearch/api/actions/update_by_query_rethrottle.rb +25 -46
  360. data/lib/opensearch/api/actions/wlm/create_query_group.rb +34 -0
  361. data/lib/opensearch/api/actions/wlm/delete_query_group.rb +38 -0
  362. data/lib/opensearch/api/actions/wlm/get_query_group.rb +34 -0
  363. data/lib/opensearch/api/actions/wlm/update_query_group.rb +38 -0
  364. data/lib/opensearch/api/http.rb +94 -0
  365. data/lib/opensearch/api/namespace.rb +23 -0
  366. data/lib/opensearch/api/utils.rb +41 -236
  367. data/lib/opensearch/api.rb +10 -82
  368. data/lib/opensearch/dsl/search/queries/script_score.rb +62 -0
  369. data/lib/opensearch/dsl/search.rb +2 -2
  370. data/lib/opensearch/dsl.rb +3 -3
  371. data/lib/opensearch/transport/client.rb +26 -1
  372. data/lib/opensearch/transport/transport/http/faraday.rb +3 -1
  373. data/lib/opensearch/version.rb +1 -1
  374. data/lib/opensearch.rb +106 -68
  375. data/opensearch-ruby.gemspec +1 -1
  376. data/spec/spec_helper.rb +3 -18
  377. data.tar.gz.sig +0 -0
  378. metadata +182 -67
  379. metadata.gz.sig +0 -0
  380. data/lib/opensearch/api/actions/abort_benchmark.rb +0 -49
  381. data/lib/opensearch/api/actions/benchmark.rb +0 -88
  382. data/lib/opensearch/api/actions/cat/params_registry.rb +0 -69
  383. data/lib/opensearch/api/actions/cluster/params_registry.rb +0 -69
  384. data/lib/opensearch/api/actions/dangling_indices/params_registry.rb +0 -69
  385. data/lib/opensearch/api/actions/features/get_features.rb +0 -61
  386. data/lib/opensearch/api/actions/features/params_registry.rb +0 -69
  387. data/lib/opensearch/api/actions/features/reset_features.rb +0 -55
  388. data/lib/opensearch/api/actions/http/connect.rb +0 -28
  389. data/lib/opensearch/api/actions/http/delete.rb +0 -28
  390. data/lib/opensearch/api/actions/http/get.rb +0 -28
  391. data/lib/opensearch/api/actions/http/head.rb +0 -28
  392. data/lib/opensearch/api/actions/http/options.rb +0 -28
  393. data/lib/opensearch/api/actions/http/patch.rb +0 -28
  394. data/lib/opensearch/api/actions/http/post.rb +0 -28
  395. data/lib/opensearch/api/actions/http/put.rb +0 -28
  396. data/lib/opensearch/api/actions/http/request.rb +0 -27
  397. data/lib/opensearch/api/actions/http/trace.rb +0 -28
  398. data/lib/opensearch/api/actions/indices/disk_usage.rb +0 -76
  399. data/lib/opensearch/api/actions/indices/field_usage_stats.rb +0 -74
  400. data/lib/opensearch/api/actions/indices/params_registry.rb +0 -69
  401. data/lib/opensearch/api/actions/ingest/geo_ip_stats.rb +0 -51
  402. data/lib/opensearch/api/actions/ingest/params_registry.rb +0 -69
  403. data/lib/opensearch/api/actions/nodes/params_registry.rb +0 -69
  404. data/lib/opensearch/api/actions/nodes/shutdown.rb +0 -65
  405. data/lib/opensearch/api/actions/params_registry.rb +0 -67
  406. data/lib/opensearch/api/actions/remote/info.rb +0 -45
  407. data/lib/opensearch/api/actions/security/delete_distinguished_names.rb +0 -41
  408. data/lib/opensearch/api/actions/security/update_distinguished_names.rb +0 -42
  409. data/lib/opensearch/api/actions/shutdown/delete_node.rb +0 -60
  410. data/lib/opensearch/api/actions/shutdown/get_node.rb +0 -62
  411. data/lib/opensearch/api/actions/shutdown/params_registry.rb +0 -69
  412. data/lib/opensearch/api/actions/shutdown/put_node.rb +0 -62
  413. data/lib/opensearch/api/actions/snapshot/get_features.rb +0 -61
  414. data/lib/opensearch/api/actions/snapshot/params_registry.rb +0 -69
  415. data/lib/opensearch/api/actions/snapshot/repository_analyze.rb +0 -84
  416. data/lib/opensearch/api/actions/tasks/params_registry.rb +0 -69
  417. data/lib/opensearch/api/namespace/cat.rb +0 -47
  418. data/lib/opensearch/api/namespace/cluster.rb +0 -47
  419. data/lib/opensearch/api/namespace/common.rb +0 -72
  420. data/lib/opensearch/api/namespace/dangling_indices.rb +0 -47
  421. data/lib/opensearch/api/namespace/features.rb +0 -47
  422. data/lib/opensearch/api/namespace/http.rb +0 -30
  423. data/lib/opensearch/api/namespace/indices.rb +0 -47
  424. data/lib/opensearch/api/namespace/ingest.rb +0 -47
  425. data/lib/opensearch/api/namespace/nodes.rb +0 -47
  426. data/lib/opensearch/api/namespace/remote.rb +0 -47
  427. data/lib/opensearch/api/namespace/remote_store.rb +0 -30
  428. data/lib/opensearch/api/namespace/security.rb +0 -30
  429. data/lib/opensearch/api/namespace/shutdown.rb +0 -47
  430. data/lib/opensearch/api/namespace/snapshot.rb +0 -47
  431. 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,52 +15,42 @@ module OpenSearch
30
15
  module Actions
31
16
  # Returns all snapshots in a specific repository.
32
17
  #
33
- # @option arguments [List] :repository Name of repository from which to fetch the snapshot information
34
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
- # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots
36
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
37
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
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
44
- #
45
- #
46
- def snapshots(arguments = {})
47
- headers = arguments.delete(:headers) || {}
18
+ # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
19
+ # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
20
+ # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
21
+ # @option args [Boolean] :help Return help information.
22
+ # @option args [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots.
23
+ # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
24
+ # @option args [Enumerable<String>, String] :repository *Required* A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error.
25
+ # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
26
+ # @option args [String] :time The unit in which to display time values.
27
+ # @option args [Boolean] :v Verbose mode. Display column headers.
28
+ def snapshots(args = {})
29
+ args = Utils.clone_and_normalize_arguments(args)
30
+ raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
48
31
 
49
- arguments = arguments.clone
32
+ _repository = args.delete('repository')
50
33
 
51
- _repository = arguments.delete(:repository)
34
+ headers = args.delete('headers') || {}
35
+ body = args.delete('body')
36
+ method = 'GET'
37
+ url = Utils.build_url('_cat/snapshots', _repository)
52
38
 
53
- method = OpenSearch::API::HTTP_GET
54
- path = if _repository
55
- "_cat/snapshots/#{Utils.__listify(_repository)}"
56
- else
57
- '_cat/snapshots'
58
- end
59
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
60
-
61
- body = nil
62
- perform_request(method, path, params, body, headers).body
39
+ Utils.validate_query_params! args, SNAPSHOTS_QUERY_PARAMS
40
+ transport.perform_request(method, url, args, body, headers).body
63
41
  end
64
42
 
65
- # Register this action with its valid params when the module is loaded.
66
- #
67
- # @since 6.2.0
68
- ParamsRegistry.register(:snapshots, %i[
69
- format
70
- ignore_unavailable
71
- master_timeout
43
+ SNAPSHOTS_QUERY_PARAMS = Set.new(%w[
72
44
  cluster_manager_timeout
45
+ format
73
46
  h
74
47
  help
48
+ ignore_unavailable
49
+ master_timeout
75
50
  s
76
51
  time
77
52
  v
78
- ].freeze)
53
+ ]).freeze
79
54
  end
80
55
  end
81
56
  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,47 +15,39 @@ module OpenSearch
30
15
  module Actions
31
16
  # Returns information about the tasks currently executing on one or more nodes in the cluster.
32
17
  #
33
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
34
- # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
35
- # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
36
- # @option arguments [Boolean] :detailed Return detailed task information (default: false)
37
- # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
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
44
- #
45
- #
46
- def tasks(arguments = {})
47
- headers = arguments.delete(:headers) || {}
48
-
49
- arguments = arguments.clone
18
+ # @option args [Enumerable<String>] :actions The task action names, which are used to limit the response.
19
+ # @option args [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
20
+ # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
21
+ # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
22
+ # @option args [Boolean] :help Return help information.
23
+ # @option args [Enumerable<String>] :nodes Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
24
+ # @option args [String] :parent_task_id The parent task identifier, which is used to limit the response.
25
+ # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
26
+ # @option args [String] :time The unit in which to display time values.
27
+ # @option args [Boolean] :v Verbose mode. Display column headers.
28
+ def tasks(args = {})
29
+ args = Utils.clone_and_normalize_arguments(args)
30
+ headers = args.delete('headers') || {}
31
+ body = args.delete('body')
32
+ method = 'GET'
33
+ url = '_cat/tasks'
50
34
 
51
- method = OpenSearch::API::HTTP_GET
52
- path = '_cat/tasks'
53
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
54
-
55
- body = nil
56
- perform_request(method, path, params, body, headers).body
35
+ Utils.validate_query_params! args, TASKS_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(:tasks, %i[
63
- format
64
- nodes
39
+ TASKS_QUERY_PARAMS = Set.new(%w[
65
40
  actions
66
41
  detailed
67
- parent_task_id
42
+ format
68
43
  h
69
44
  help
45
+ nodes
46
+ parent_task_id
70
47
  s
71
48
  time
72
49
  v
73
- ].freeze)
50
+ ]).freeze
74
51
  end
75
52
  end
76
53
  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,50 +15,38 @@ module OpenSearch
30
15
  module Actions
31
16
  # Returns information about existing templates.
32
17
  #
33
- # @option arguments [String] :name A pattern that returned template names must match
34
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
35
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
36
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
37
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
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 [Boolean] :v Verbose mode. Display column headers
42
- # @option arguments [Hash] :headers Custom HTTP headers
43
- #
44
- #
45
- def templates(arguments = {})
46
- headers = arguments.delete(:headers) || {}
47
-
48
- arguments = arguments.clone
18
+ # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
19
+ # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
20
+ # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
21
+ # @option args [Boolean] :help Return help information.
22
+ # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
23
+ # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
24
+ # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
25
+ # @option args [Boolean] :v Verbose mode. Display column headers.
26
+ # @option args [String] :name The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
27
+ def templates(args = {})
28
+ args = Utils.clone_and_normalize_arguments(args)
29
+ _name = args.delete('name')
49
30
 
50
- _name = arguments.delete(:name)
31
+ headers = args.delete('headers') || {}
32
+ body = args.delete('body')
33
+ method = 'GET'
34
+ url = Utils.build_url('_cat/templates', _name)
51
35
 
52
- method = OpenSearch::API::HTTP_GET
53
- path = if _name
54
- "_cat/templates/#{Utils.__listify(_name)}"
55
- else
56
- '_cat/templates'
57
- end
58
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
59
-
60
- body = nil
61
- perform_request(method, path, params, body, headers).body
36
+ Utils.validate_query_params! args, TEMPLATES_QUERY_PARAMS
37
+ transport.perform_request(method, url, args, body, headers).body
62
38
  end
63
39
 
64
- # Register this action with its valid params when the module is loaded.
65
- #
66
- # @since 6.2.0
67
- ParamsRegistry.register(:templates, %i[
68
- format
69
- local
70
- master_timeout
40
+ TEMPLATES_QUERY_PARAMS = Set.new(%w[
71
41
  cluster_manager_timeout
42
+ format
72
43
  h
73
44
  help
45
+ local
46
+ master_timeout
74
47
  s
75
48
  v
76
- ].freeze)
49
+ ]).freeze
77
50
  end
78
51
  end
79
52
  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
@@ -31,53 +16,40 @@ module OpenSearch
31
16
  # Returns cluster-wide thread pool statistics per node.
32
17
  # By default the active, queue and rejected statistics are returned for all thread pools.
33
18
  #
34
- # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output
35
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
36
- # @option arguments [String] :size The multiplier in which to display values *Deprecated* (options: , k, m, g, t, p)
37
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
38
- # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
39
- # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
40
- # @option arguments [List] :h Comma-separated list of column names to display
41
- # @option arguments [Boolean] :help Return help information
42
- # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
43
- # @option arguments [Boolean] :v Verbose mode. Display column headers
44
- # @option arguments [Hash] :headers Custom HTTP headers
45
- #
46
- #
47
- def thread_pool(arguments = {})
48
- headers = arguments.delete(:headers) || {}
49
-
50
- arguments = arguments.clone
51
-
52
- _thread_pool_patterns = arguments.delete(:thread_pool_patterns)
19
+ # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
20
+ # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
21
+ # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
22
+ # @option args [Boolean] :help Return help information.
23
+ # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
24
+ # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
25
+ # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
26
+ # @option args [Integer] :size The multiplier in which to display values.
27
+ # @option args [Boolean] :v Verbose mode. Display column headers.
28
+ # @option args [Enumerable<String>, String] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.
29
+ def thread_pool(args = {})
30
+ args = Utils.clone_and_normalize_arguments(args)
31
+ _thread_pool_patterns = args.delete('thread_pool_patterns')
53
32
 
54
- method = OpenSearch::API::HTTP_GET
55
- path = if _thread_pool_patterns
56
- "_cat/thread_pool/#{Utils.__listify(_thread_pool_patterns)}"
57
- else
58
- '_cat/thread_pool'
59
- end
60
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
61
- params[:h] = Utils.__listify(params[:h]) if params[:h]
33
+ headers = args.delete('headers') || {}
34
+ body = args.delete('body')
35
+ method = 'GET'
36
+ url = Utils.build_url('_cat/thread_pool', _thread_pool_patterns)
62
37
 
63
- body = nil
64
- perform_request(method, path, params, body, headers).body
38
+ Utils.validate_query_params! args, THREAD_POOL_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(:thread_pool, %i[
71
- format
72
- size
73
- local
74
- master_timeout
42
+ THREAD_POOL_QUERY_PARAMS = Set.new(%w[
75
43
  cluster_manager_timeout
44
+ format
76
45
  h
77
46
  help
47
+ local
48
+ master_timeout
78
49
  s
50
+ size
79
51
  v
80
- ].freeze)
52
+ ]).freeze
81
53
  end
82
54
  end
83
55
  end
@@ -3,59 +3,34 @@
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
- # Explicitly clears the search context for a scroll.
31
- #
32
- # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear *Deprecated*
33
- # @option arguments [Hash] :headers Custom HTTP headers
34
- # @option arguments [Hash] :body A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
35
- #
36
- # *Deprecation notice*:
37
- # A scroll id can be quite large and should be specified as part of the body
38
- # Deprecated since version 7.0.0
39
- #
40
- #
41
- #
42
- def clear_scroll(arguments = {})
43
- 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.
44
9
 
45
- arguments = arguments.clone
10
+ # frozen_string_literal: true
46
11
 
47
- _scroll_id = arguments.delete(:scroll_id)
12
+ module OpenSearch
13
+ module API
14
+ module Root
15
+ module Actions
16
+ # Explicitly clears the search context for a scroll.
17
+ #
18
+ # @option args [Enumerable<String>, String] :scroll_id DEPRECATED Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`.
19
+ # @option args [Hash] :body Comma-separated list of scroll IDs to clear if none was specified using the `scroll_id` parameter
20
+ # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
21
+ def clear_scroll(args = {})
22
+ args = Utils.clone_and_normalize_arguments(args)
23
+ _scroll_id = args.delete('scroll_id')
48
24
 
49
- method = OpenSearch::API::HTTP_DELETE
50
- path = if _scroll_id
51
- "_search/scroll/#{Utils.__listify(_scroll_id)}"
52
- else
53
- '_search/scroll'
54
- end
55
- params = {}
25
+ ignore = args.delete('ignore') || []
26
+ headers = args.delete('headers') || {}
27
+ body = args.delete('body')
28
+ method = 'DELETE'
29
+ url = Utils.build_url('_search/scroll', _scroll_id)
56
30
 
57
- body = arguments[:body]
58
- perform_request(method, path, params, body, headers).body
31
+ Utils.validate_query_params! args
32
+ transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
33
+ end
59
34
  end
60
35
  end
61
36
  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,37 +15,24 @@ module OpenSearch
30
15
  module Actions
31
16
  # Provides explanations for shard allocations in the cluster.
32
17
  #
33
- # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false)
34
- # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false)
35
- # @option arguments [Hash] :headers Custom HTTP headers
36
- # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
37
- #
38
- #
39
- def allocation_explain(arguments = {})
40
- headers = arguments.delete(:headers) || {}
41
-
42
- arguments = arguments.clone
43
-
44
- method = if arguments[:body]
45
- OpenSearch::API::HTTP_POST
46
- else
47
- OpenSearch::API::HTTP_GET
48
- end
49
-
50
- path = '_cluster/allocation/explain'
51
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
18
+ # @option args [Boolean] :include_disk_info If `true`, returns information about disk usage and shard sizes.
19
+ # @option args [Boolean] :include_yes_decisions If `true`, returns YES decisions in explanation.
20
+ # @option args [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
21
+ def allocation_explain(args = {})
22
+ args = Utils.clone_and_normalize_arguments(args)
23
+ headers = args.delete('headers') || {}
24
+ body = args.delete('body')
25
+ method = body ? 'POST' : 'GET'
26
+ url = '_cluster/allocation/explain'
52
27
 
53
- body = arguments[:body]
54
- perform_request(method, path, params, body, headers).body
28
+ Utils.validate_query_params! args, ALLOCATION_EXPLAIN_QUERY_PARAMS
29
+ transport.perform_request(method, url, args, body, headers).body
55
30
  end
56
31
 
57
- # Register this action with its valid params when the module is loaded.
58
- #
59
- # @since 6.2.0
60
- ParamsRegistry.register(:allocation_explain, %i[
61
- include_yes_decisions
32
+ ALLOCATION_EXPLAIN_QUERY_PARAMS = Set.new(%w[
62
33
  include_disk_info
63
- ].freeze)
34
+ include_yes_decisions
35
+ ]).freeze
64
36
  end
65
37
  end
66
38
  end