opensearch-ruby 3.4.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 (430) 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.rb +2 -2
  369. data/lib/opensearch/dsl.rb +3 -3
  370. data/lib/opensearch/transport/client.rb +26 -1
  371. data/lib/opensearch/transport/transport/http/faraday.rb +3 -1
  372. data/lib/opensearch/version.rb +1 -1
  373. data/lib/opensearch.rb +106 -68
  374. data/opensearch-ruby.gemspec +1 -1
  375. data/spec/spec_helper.rb +3 -18
  376. data.tar.gz.sig +0 -0
  377. metadata +181 -67
  378. metadata.gz.sig +0 -0
  379. data/lib/opensearch/api/actions/abort_benchmark.rb +0 -49
  380. data/lib/opensearch/api/actions/benchmark.rb +0 -88
  381. data/lib/opensearch/api/actions/cat/params_registry.rb +0 -69
  382. data/lib/opensearch/api/actions/cluster/params_registry.rb +0 -69
  383. data/lib/opensearch/api/actions/dangling_indices/params_registry.rb +0 -69
  384. data/lib/opensearch/api/actions/features/get_features.rb +0 -61
  385. data/lib/opensearch/api/actions/features/params_registry.rb +0 -69
  386. data/lib/opensearch/api/actions/features/reset_features.rb +0 -55
  387. data/lib/opensearch/api/actions/http/connect.rb +0 -28
  388. data/lib/opensearch/api/actions/http/delete.rb +0 -28
  389. data/lib/opensearch/api/actions/http/get.rb +0 -28
  390. data/lib/opensearch/api/actions/http/head.rb +0 -28
  391. data/lib/opensearch/api/actions/http/options.rb +0 -28
  392. data/lib/opensearch/api/actions/http/patch.rb +0 -28
  393. data/lib/opensearch/api/actions/http/post.rb +0 -28
  394. data/lib/opensearch/api/actions/http/put.rb +0 -28
  395. data/lib/opensearch/api/actions/http/request.rb +0 -27
  396. data/lib/opensearch/api/actions/http/trace.rb +0 -28
  397. data/lib/opensearch/api/actions/indices/disk_usage.rb +0 -76
  398. data/lib/opensearch/api/actions/indices/field_usage_stats.rb +0 -74
  399. data/lib/opensearch/api/actions/indices/params_registry.rb +0 -69
  400. data/lib/opensearch/api/actions/ingest/geo_ip_stats.rb +0 -51
  401. data/lib/opensearch/api/actions/ingest/params_registry.rb +0 -69
  402. data/lib/opensearch/api/actions/nodes/params_registry.rb +0 -69
  403. data/lib/opensearch/api/actions/nodes/shutdown.rb +0 -65
  404. data/lib/opensearch/api/actions/params_registry.rb +0 -67
  405. data/lib/opensearch/api/actions/remote/info.rb +0 -45
  406. data/lib/opensearch/api/actions/security/delete_distinguished_names.rb +0 -41
  407. data/lib/opensearch/api/actions/security/update_distinguished_names.rb +0 -42
  408. data/lib/opensearch/api/actions/shutdown/delete_node.rb +0 -60
  409. data/lib/opensearch/api/actions/shutdown/get_node.rb +0 -62
  410. data/lib/opensearch/api/actions/shutdown/params_registry.rb +0 -69
  411. data/lib/opensearch/api/actions/shutdown/put_node.rb +0 -62
  412. data/lib/opensearch/api/actions/snapshot/get_features.rb +0 -61
  413. data/lib/opensearch/api/actions/snapshot/params_registry.rb +0 -69
  414. data/lib/opensearch/api/actions/snapshot/repository_analyze.rb +0 -84
  415. data/lib/opensearch/api/actions/tasks/params_registry.rb +0 -69
  416. data/lib/opensearch/api/namespace/cat.rb +0 -47
  417. data/lib/opensearch/api/namespace/cluster.rb +0 -47
  418. data/lib/opensearch/api/namespace/common.rb +0 -72
  419. data/lib/opensearch/api/namespace/dangling_indices.rb +0 -47
  420. data/lib/opensearch/api/namespace/features.rb +0 -47
  421. data/lib/opensearch/api/namespace/http.rb +0 -30
  422. data/lib/opensearch/api/namespace/indices.rb +0 -47
  423. data/lib/opensearch/api/namespace/ingest.rb +0 -47
  424. data/lib/opensearch/api/namespace/nodes.rb +0 -47
  425. data/lib/opensearch/api/namespace/remote.rb +0 -47
  426. data/lib/opensearch/api/namespace/remote_store.rb +0 -30
  427. data/lib/opensearch/api/namespace/security.rb +0 -30
  428. data/lib/opensearch/api/namespace/shutdown.rb +0 -47
  429. data/lib/opensearch/api/namespace/snapshot.rb +0 -47
  430. data/lib/opensearch/api/namespace/tasks.rb +0 -47
@@ -0,0 +1,44 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ #
3
+ # The OpenSearch Contributors require contributions made to
4
+ # this file be licensed under the Apache-2.0 license or a
5
+ # compatible open source license.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
11
+
12
+ module OpenSearch
13
+ module API
14
+ module Transforms
15
+ module Actions
16
+ # Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided.
17
+ #
18
+ # @option args [String] :id *Required* Transform to create/update
19
+ # @option args [Float] :if_primary_term Only perform the operation if the document has this primary term.
20
+ # @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
21
+ # @option args [Hash] :body
22
+ def put(args = {})
23
+ args = Utils.clone_and_normalize_arguments(args)
24
+ raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
25
+
26
+ _id = args.delete('id')
27
+
28
+ headers = args.delete('headers') || {}
29
+ body = args.delete('body')
30
+ method = 'PUT'
31
+ url = Utils.build_url('_plugins/_transform', _id)
32
+
33
+ Utils.validate_query_params! args, PUT_QUERY_PARAMS
34
+ transport.perform_request(method, url, args, body, headers).body
35
+ end
36
+
37
+ PUT_QUERY_PARAMS = Set.new(%w[
38
+ if_primary_term
39
+ if_seq_no
40
+ ]).freeze
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,44 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ #
3
+ # The OpenSearch Contributors require contributions made to
4
+ # this file be licensed under the Apache-2.0 license or a
5
+ # compatible open source license.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
11
+
12
+ module OpenSearch
13
+ module API
14
+ module Transforms
15
+ module Actions
16
+ # Returns the details of all transform jobs.
17
+ #
18
+ # @option args [Float] :from The starting transform to return. Default is `0`.
19
+ # @option args [String] :search The search term to use to filter results.
20
+ # @option args [Float] :size Specifies the number of transforms to return. Default is `10`.
21
+ # @option args [String] :sortDirection Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`.
22
+ # @option args [String] :sortField The field to sort results with.
23
+ def search(args = {})
24
+ args = Utils.clone_and_normalize_arguments(args)
25
+ headers = args.delete('headers') || {}
26
+ body = args.delete('body')
27
+ method = 'GET'
28
+ url = '_plugins/_transform'
29
+
30
+ Utils.validate_query_params! args, SEARCH_QUERY_PARAMS
31
+ transport.perform_request(method, url, args, body, headers).body
32
+ end
33
+
34
+ SEARCH_QUERY_PARAMS = Set.new(%w[
35
+ from
36
+ search
37
+ size
38
+ sortDirection
39
+ sortField
40
+ ]).freeze
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,36 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ #
3
+ # The OpenSearch Contributors require contributions made to
4
+ # this file be licensed under the Apache-2.0 license or a
5
+ # compatible open source license.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
11
+
12
+ module OpenSearch
13
+ module API
14
+ module Transforms
15
+ module Actions
16
+ # Start transform.
17
+ #
18
+ # @option args [String] :id *Required* Transform to start
19
+ def start(args = {})
20
+ args = Utils.clone_and_normalize_arguments(args)
21
+ raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
22
+
23
+ _id = args.delete('id')
24
+
25
+ headers = args.delete('headers') || {}
26
+ body = args.delete('body')
27
+ method = 'POST'
28
+ url = Utils.build_url('_plugins/_transform', _id, '_start')
29
+
30
+ Utils.validate_query_params! args
31
+ transport.perform_request(method, url, args, body, headers).body
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,36 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ #
3
+ # The OpenSearch Contributors require contributions made to
4
+ # this file be licensed under the Apache-2.0 license or a
5
+ # compatible open source license.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
11
+
12
+ module OpenSearch
13
+ module API
14
+ module Transforms
15
+ module Actions
16
+ # Stop transform.
17
+ #
18
+ # @option args [String] :id *Required* Transform to stop
19
+ def stop(args = {})
20
+ args = Utils.clone_and_normalize_arguments(args)
21
+ raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
22
+
23
+ _id = args.delete('id')
24
+
25
+ headers = args.delete('headers') || {}
26
+ body = args.delete('body')
27
+ method = 'POST'
28
+ url = Utils.build_url('_plugins/_transform', _id, '_stop')
29
+
30
+ Utils.validate_query_params! args
31
+ transport.perform_request(method, url, args, body, headers).body
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -3,97 +3,66 @@
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
- # Updates a document with a script or partial document.
31
- #
32
- # @option arguments [String] :id Document ID
33
- # @option arguments [String] :index The name of the index
34
- # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
35
- # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
36
- # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
37
- # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
38
- # @option arguments [String] :lang The script language (default: painless)
39
- # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
40
- # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
41
- # @option arguments [String] :routing Specific routing value
42
- # @option arguments [Time] :timeout Explicit operation timeout
43
- # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
44
- # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
45
- # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
46
- # @option arguments [Hash] :headers Custom HTTP headers
47
- # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
48
- #
49
- # *Deprecation notice*:
50
- # Specifying types in urls has been deprecated
51
- # Deprecated since version 7.0.0
52
- #
53
- #
54
- #
55
- def update(arguments = {})
56
- raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
57
- raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
58
- raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
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.
59
9
 
60
- headers = arguments.delete(:headers) || {}
10
+ # frozen_string_literal: true
61
11
 
62
- arguments = arguments.clone
63
-
64
- _id = arguments.delete(:id)
12
+ module OpenSearch
13
+ module API
14
+ module Root
15
+ module Actions
16
+ # Updates a document with a script or partial document.
17
+ #
18
+ # @option args [String] :id *Required* Document ID
19
+ # @option args [String] :index *Required* The name of the index
20
+ # @option args [Boolean, Enumerable<String>, String] :_source Set to `false` to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.
21
+ # @option args [Enumerable<String>, String] :_source_excludes Specify the source fields you want to exclude.
22
+ # @option args [Enumerable<String>, String] :_source_includes Specify the source fields you want to retrieve.
23
+ # @option args [Integer] :if_primary_term Only perform the operation if the document has this primary term.
24
+ # @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
25
+ # @option args [String] :lang (default: painless) The script language.
26
+ # @option args [Boolean, String] :refresh If 'true', OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
27
+ # @option args [Boolean] :require_alias If `true`, the destination must be an index alias.
28
+ # @option args [Integer] :retry_on_conflict (default: 0) Specify how many times should the operation be retried when a conflict occurs.
29
+ # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
30
+ # @option args [String] :timeout Period to wait for dynamic mapping updates and active shards. This guarantees OpenSearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.
31
+ # @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard.
32
+ # @option args [Hash] :body *Required* The request definition requires either `script` or partial `doc`
33
+ def update(args = {})
34
+ args = Utils.clone_and_normalize_arguments(args)
35
+ raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
36
+ raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
37
+ raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
65
38
 
66
- _index = arguments.delete(:index)
39
+ _id = args.delete('id')
40
+ _index = args.delete('index')
67
41
 
68
- method = OpenSearch::API::HTTP_POST
69
- path = "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
70
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
42
+ headers = args.delete('headers') || {}
43
+ body = args.delete('body')
44
+ method = 'POST'
45
+ url = Utils.build_url(_index, '_update', _id)
71
46
 
72
- body = arguments[:body]
73
- if Array(arguments[:ignore]).include?(404)
74
- Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
75
- else
76
- perform_request(method, path, params, body, headers).body
47
+ Utils.validate_query_params! args, UPDATE_QUERY_PARAMS
48
+ transport.perform_request(method, url, args, body, headers).body
77
49
  end
78
- end
79
50
 
80
- # Register this action with its valid params when the module is loaded.
81
- #
82
- # @since 6.2.0
83
- ParamsRegistry.register(:update, %i[
84
- wait_for_active_shards
85
- _source
86
- _source_excludes
87
- _source_includes
88
- lang
89
- refresh
90
- retry_on_conflict
91
- routing
92
- timeout
93
- if_seq_no
94
- if_primary_term
95
- require_alias
96
- ].freeze)
51
+ UPDATE_QUERY_PARAMS = Set.new(%w[
52
+ _source
53
+ _source_excludes
54
+ _source_includes
55
+ if_primary_term
56
+ if_seq_no
57
+ lang
58
+ refresh
59
+ require_alias
60
+ retry_on_conflict
61
+ routing
62
+ timeout
63
+ wait_for_active_shards
64
+ ]).freeze
65
+ end
97
66
  end
98
67
  end
99
68
  end
@@ -3,135 +3,107 @@
3
3
  # The OpenSearch Contributors require contributions made to
4
4
  # this file be licensed under the Apache-2.0 license or a
5
5
  # compatible open source license.
6
- #
7
- # Modifications Copyright OpenSearch Contributors. See
8
- # GitHub history for details.
9
- #
10
- # Licensed to Elasticsearch B.V. under one or more contributor
11
- # license agreements. See the NOTICE file distributed with
12
- # this work for additional information regarding copyright
13
- # ownership. Elasticsearch B.V. licenses this file to you under
14
- # the Apache License, Version 2.0 (the "License"); you may
15
- # not use this file except in compliance with the License.
16
- # You may obtain a copy of the License at
17
- #
18
- # http://www.apache.org/licenses/LICENSE-2.0
19
- #
20
- # Unless required by applicable law or agreed to in writing,
21
- # software distributed under the License is distributed on an
22
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23
- # KIND, either express or implied. See the License for the
24
- # specific language governing permissions and limitations
25
- # under the License.
6
+
7
+ # This file is generated from the OpenSearch REST API spec.
8
+ # Do not modify it by hand. Instead, modify the generator or the spec.
9
+
10
+ # frozen_string_literal: true
26
11
 
27
12
  module OpenSearch
28
13
  module API
29
- module Actions
30
- # Performs an update on every document in the index without changing the source,
31
- # for example to pick up a mapping change.
32
- #
33
- # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (*Required*)
34
- # @option arguments [String] :analyzer The analyzer to use for the query string
35
- # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
36
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
37
- # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
38
- # @option arguments [Number] :from Starting offset (default: 0)
39
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
40
- # @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)
41
- # @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
42
- # @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)
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 [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
45
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
46
- # @option arguments [String] :q Query in the Lucene query string syntax
47
- # @option arguments [List] :routing A comma-separated list of specific routing values
48
- # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
49
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
50
- # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
51
- # @option arguments [Number] :size Deprecated, please use `max_docs` instead
52
- # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
53
- # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
54
- # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
55
- # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
56
- # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
57
- # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
58
- # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
59
- # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
60
- # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
61
- # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
62
- # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
63
- # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
64
- # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
65
- # @option arguments [Number] :scroll_size Size on the scroll request powering the update by query
66
- # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete.
67
- # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
68
- # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
69
- # @option arguments [Hash] :headers Custom HTTP headers
70
- # @option arguments [Hash] :body The search definition using the Query DSL
71
- #
72
- # *Deprecation notice*:
73
- # Specifying types in urls has been deprecated
74
- # Deprecated since version 7.0.0
75
- #
76
- #
77
- #
78
- def update_by_query(arguments = {})
79
- raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
14
+ module Root
15
+ module Actions
16
+ # Performs an update on every document in the index without changing the source,
17
+ # for example to pick up a mapping change.
18
+ #
19
+ # @option args [Enumerable<String>, String] :index *Required* 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`.
20
+ # @option args [Enumerable<String>] :_source Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
21
+ # @option args [Enumerable<String>] :_source_excludes List of fields to exclude from the returned `_source` field.
22
+ # @option args [Enumerable<String>] :_source_includes List of fields to extract and return from the `_source` field.
23
+ # @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. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
24
+ # @option args [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed.
25
+ # @option args [String] :analyzer Analyzer to use for the query string.
26
+ # @option args [String] :conflicts What to do if update by query hits version conflicts: `abort` or `proceed`.
27
+ # @option args [String] :default_operator The default operator for query string query: `AND` or `OR`.
28
+ # @option args [String] :df Field to use as default where no field prefix is given in the query string.
29
+ # @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`.
30
+ # @option args [Integer] :from (default: 0) Starting offset.
31
+ # @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
32
+ # @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.
33
+ # @option args [Integer] :max_docs Maximum number of documents to process. Defaults to all documents.
34
+ # @option args [String] :pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
35
+ # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
36
+ # @option args [String] :q Query in the Lucene query string syntax.
37
+ # @option args [Boolean, String] :refresh If `true`, OpenSearch refreshes affected shards to make the operation visible to search.
38
+ # @option args [Boolean] :request_cache If `true`, the request cache is used for this request.
39
+ # @option args [Float] :requests_per_second (default: 0) The throttle for this request in sub-requests per second.
40
+ # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
41
+ # @option args [String] :scroll Period to retain the search context for scrolling.
42
+ # @option args [Integer] :scroll_size (default: 100) Size of the scroll request that powers the operation.
43
+ # @option args [String] :search_timeout Explicit timeout for each search request.
44
+ # @option args [String] :search_type The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.
45
+ # @option args [Integer] :size Deprecated, use `max_docs` instead.
46
+ # @option args [Float, String] :slices The number of slices this task should be divided into.
47
+ # @option args [Enumerable<String>] :sort A comma-separated list of <field>:<direction> pairs.
48
+ # @option args [Enumerable<String>] :stats Specific `tag` of the request for logging and statistical purposes.
49
+ # @option args [Integer] :terminate_after Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers.
50
+ # @option args [String] :timeout Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.
51
+ # @option args [Boolean] :version If `true`, returns the document version as part of a hit.
52
+ # @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
53
+ # @option args [Boolean] :wait_for_completion (default: true) If `true`, the request blocks until the operation is complete.
54
+ # @option args [Hash] :body The search definition using the Query DSL
55
+ def update_by_query(args = {})
56
+ args = Utils.clone_and_normalize_arguments(args)
57
+ raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
80
58
 
81
- headers = arguments.delete(:headers) || {}
59
+ _index = args.delete('index')
82
60
 
83
- arguments = arguments.clone
61
+ headers = args.delete('headers') || {}
62
+ body = args.delete('body')
63
+ method = 'POST'
64
+ url = Utils.build_url(_index, '_update_by_query')
84
65
 
85
- _index = arguments.delete(:index)
66
+ Utils.validate_query_params! args, UPDATE_BY_QUERY_QUERY_PARAMS
67
+ transport.perform_request(method, url, args, body, headers).body
68
+ end
86
69
 
87
- method = OpenSearch::API::HTTP_POST
88
- path = "#{Utils.__listify(_index)}/_update_by_query"
89
- params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
90
-
91
- body = arguments[:body]
92
- perform_request(method, path, params, body, headers).body
70
+ UPDATE_BY_QUERY_QUERY_PARAMS = Set.new(%w[
71
+ _source
72
+ _source_excludes
73
+ _source_includes
74
+ allow_no_indices
75
+ analyze_wildcard
76
+ analyzer
77
+ conflicts
78
+ default_operator
79
+ df
80
+ expand_wildcards
81
+ from
82
+ ignore_unavailable
83
+ lenient
84
+ max_docs
85
+ pipeline
86
+ preference
87
+ q
88
+ refresh
89
+ request_cache
90
+ requests_per_second
91
+ routing
92
+ scroll
93
+ scroll_size
94
+ search_timeout
95
+ search_type
96
+ size
97
+ slices
98
+ sort
99
+ stats
100
+ terminate_after
101
+ timeout
102
+ version
103
+ wait_for_active_shards
104
+ wait_for_completion
105
+ ]).freeze
93
106
  end
94
-
95
- # Register this action with its valid params when the module is loaded.
96
- #
97
- # @since 6.2.0
98
- ParamsRegistry.register(:update_by_query, %i[
99
- analyzer
100
- analyze_wildcard
101
- default_operator
102
- df
103
- from
104
- ignore_unavailable
105
- allow_no_indices
106
- conflicts
107
- expand_wildcards
108
- lenient
109
- pipeline
110
- preference
111
- q
112
- routing
113
- scroll
114
- search_type
115
- search_timeout
116
- size
117
- max_docs
118
- sort
119
- _source
120
- _source_excludes
121
- _source_includes
122
- terminate_after
123
- stats
124
- version
125
- version_type
126
- request_cache
127
- refresh
128
- timeout
129
- wait_for_active_shards
130
- scroll_size
131
- wait_for_completion
132
- requests_per_second
133
- slices
134
- ].freeze)
135
107
  end
136
108
  end
137
109
  end