elasticsearch-api 6.0.1 → 7.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (454) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +23 -0
  3. data/LICENSE.txt +199 -10
  4. data/README.md +3 -3
  5. data/Rakefile +31 -2
  6. data/elasticsearch-api.gemspec +21 -4
  7. data/lib/elasticsearch/api/actions/abort_benchmark.rb +17 -0
  8. data/lib/elasticsearch/api/actions/benchmark.rb +23 -3
  9. data/lib/elasticsearch/api/actions/bulk.rb +38 -18
  10. data/lib/elasticsearch/api/actions/cat/aliases.rb +30 -14
  11. data/lib/elasticsearch/api/actions/cat/allocation.rb +31 -15
  12. data/lib/elasticsearch/api/actions/cat/count.rb +30 -9
  13. data/lib/elasticsearch/api/actions/cat/fielddata.rb +32 -11
  14. data/lib/elasticsearch/api/actions/cat/health.rb +31 -10
  15. data/lib/elasticsearch/api/actions/cat/help.rb +25 -3
  16. data/lib/elasticsearch/api/actions/cat/indices.rb +33 -13
  17. data/lib/elasticsearch/api/actions/cat/master.rb +30 -9
  18. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +30 -8
  19. data/lib/elasticsearch/api/actions/cat/nodes.rb +31 -10
  20. data/lib/elasticsearch/api/actions/cat/params_registry.rb +61 -0
  21. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +30 -9
  22. data/lib/elasticsearch/api/actions/cat/plugins.rb +30 -8
  23. data/lib/elasticsearch/api/actions/cat/recovery.rb +30 -10
  24. data/lib/elasticsearch/api/actions/cat/repositories.rb +30 -8
  25. data/lib/elasticsearch/api/actions/cat/segments.rb +30 -8
  26. data/lib/elasticsearch/api/actions/cat/shards.rb +31 -12
  27. data/lib/elasticsearch/api/actions/cat/snapshots.rb +30 -10
  28. data/lib/elasticsearch/api/actions/cat/tasks.rb +31 -11
  29. data/lib/elasticsearch/api/actions/cat/templates.rb +31 -10
  30. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +32 -12
  31. data/lib/elasticsearch/api/actions/clear_scroll.rb +21 -6
  32. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +25 -4
  33. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +27 -6
  34. data/lib/elasticsearch/api/actions/cluster/health.rb +35 -13
  35. data/lib/elasticsearch/api/actions/cluster/params_registry.rb +61 -0
  36. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +25 -4
  37. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +26 -3
  38. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +17 -0
  39. data/lib/elasticsearch/api/actions/cluster/reroute.rb +29 -3
  40. data/lib/elasticsearch/api/actions/cluster/state.rb +31 -14
  41. data/lib/elasticsearch/api/actions/cluster/stats.rb +25 -5
  42. data/lib/elasticsearch/api/actions/count.rb +44 -34
  43. data/lib/elasticsearch/api/actions/create.rb +17 -0
  44. data/lib/elasticsearch/api/actions/delete.rb +38 -18
  45. data/lib/elasticsearch/api/actions/delete_by_query.rb +40 -21
  46. data/lib/elasticsearch/api/actions/delete_by_rethrottle.rb +46 -0
  47. data/lib/elasticsearch/api/actions/delete_script.rb +28 -11
  48. data/lib/elasticsearch/api/actions/exists.rb +37 -19
  49. data/lib/elasticsearch/api/actions/exists_source.rb +68 -0
  50. data/lib/elasticsearch/api/actions/explain.rb +54 -40
  51. data/lib/elasticsearch/api/actions/field_caps.rb +28 -10
  52. data/lib/elasticsearch/api/actions/get.rb +45 -29
  53. data/lib/elasticsearch/api/actions/get_script.rb +28 -5
  54. data/lib/elasticsearch/api/actions/get_source.rb +53 -27
  55. data/lib/elasticsearch/api/actions/index.rb +37 -15
  56. data/lib/elasticsearch/api/actions/indices/analyze.rb +30 -24
  57. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +31 -14
  58. data/lib/elasticsearch/api/actions/indices/close.rb +29 -10
  59. data/lib/elasticsearch/api/actions/indices/create.rb +38 -20
  60. data/lib/elasticsearch/api/actions/indices/delete.rb +28 -9
  61. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +25 -3
  62. data/lib/elasticsearch/api/actions/indices/delete_template.rb +25 -3
  63. data/lib/elasticsearch/api/actions/indices/exists.rb +29 -11
  64. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +27 -10
  65. data/lib/elasticsearch/api/actions/indices/exists_template.rb +26 -4
  66. data/lib/elasticsearch/api/actions/indices/exists_type.rb +27 -10
  67. data/lib/elasticsearch/api/actions/indices/flush.rb +28 -8
  68. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +26 -7
  69. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +36 -15
  70. data/lib/elasticsearch/api/actions/indices/freeze.rb +40 -0
  71. data/lib/elasticsearch/api/actions/indices/get.rb +37 -23
  72. data/lib/elasticsearch/api/actions/indices/get_alias.rb +31 -20
  73. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +37 -23
  74. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +36 -21
  75. data/lib/elasticsearch/api/actions/indices/get_settings.rb +38 -28
  76. data/lib/elasticsearch/api/actions/indices/get_template.rb +30 -6
  77. data/lib/elasticsearch/api/actions/indices/open.rb +35 -21
  78. data/lib/elasticsearch/api/actions/indices/params_registry.rb +61 -0
  79. data/lib/elasticsearch/api/actions/indices/put_alias.rb +27 -4
  80. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +37 -32
  81. data/lib/elasticsearch/api/actions/indices/put_settings.rb +36 -28
  82. data/lib/elasticsearch/api/actions/indices/put_template.rb +32 -6
  83. data/lib/elasticsearch/api/actions/indices/recovery.rb +25 -6
  84. data/lib/elasticsearch/api/actions/indices/refresh.rb +30 -19
  85. data/lib/elasticsearch/api/actions/indices/rollover.rb +31 -12
  86. data/lib/elasticsearch/api/actions/indices/segments.rb +32 -21
  87. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +27 -8
  88. data/lib/elasticsearch/api/actions/indices/shrink.rb +27 -13
  89. data/lib/elasticsearch/api/actions/indices/split.rb +59 -0
  90. data/lib/elasticsearch/api/actions/indices/stats.rb +51 -29
  91. data/lib/elasticsearch/api/actions/indices/unfreeze.rb +39 -0
  92. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +28 -5
  93. data/lib/elasticsearch/api/actions/indices/upgrade.rb +34 -17
  94. data/lib/elasticsearch/api/actions/indices/validate_query.rb +45 -36
  95. data/lib/elasticsearch/api/actions/info.rb +17 -0
  96. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +25 -4
  97. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +23 -3
  98. data/lib/elasticsearch/api/actions/ingest/params_registry.rb +61 -0
  99. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +29 -0
  100. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +25 -4
  101. data/lib/elasticsearch/api/actions/ingest/simulate.rb +23 -3
  102. data/lib/elasticsearch/api/actions/mget.rb +37 -25
  103. data/lib/elasticsearch/api/actions/msearch.rb +36 -9
  104. data/lib/elasticsearch/api/actions/msearch_template.rb +33 -4
  105. data/lib/elasticsearch/api/actions/mtermvectors.rb +52 -33
  106. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +31 -11
  107. data/lib/elasticsearch/api/actions/nodes/info.rb +40 -19
  108. data/lib/elasticsearch/api/actions/nodes/params_registry.rb +61 -0
  109. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +54 -0
  110. data/lib/elasticsearch/api/actions/nodes/shutdown.rb +25 -5
  111. data/lib/elasticsearch/api/actions/nodes/stats.rb +39 -39
  112. data/lib/elasticsearch/api/actions/nodes/usage.rb +31 -0
  113. data/lib/elasticsearch/api/actions/params_registry.rb +59 -0
  114. data/lib/elasticsearch/api/actions/ping.rb +17 -0
  115. data/lib/elasticsearch/api/actions/put_script.rb +32 -14
  116. data/lib/elasticsearch/api/actions/rank_eval.rb +53 -0
  117. data/lib/elasticsearch/api/actions/reindex.rb +38 -18
  118. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +46 -0
  119. data/lib/elasticsearch/api/actions/remote/info.rb +17 -0
  120. data/lib/elasticsearch/api/actions/render_search_template.rb +24 -4
  121. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +38 -0
  122. data/lib/elasticsearch/api/actions/scroll.rb +30 -8
  123. data/lib/elasticsearch/api/actions/search.rb +46 -20
  124. data/lib/elasticsearch/api/actions/search_shards.rb +29 -8
  125. data/lib/elasticsearch/api/actions/search_template.rb +51 -27
  126. data/lib/elasticsearch/api/actions/snapshot/create.rb +25 -5
  127. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +27 -6
  128. data/lib/elasticsearch/api/actions/snapshot/delete.rb +23 -5
  129. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +25 -6
  130. data/lib/elasticsearch/api/actions/snapshot/get.rb +28 -8
  131. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +25 -6
  132. data/lib/elasticsearch/api/actions/snapshot/params_registry.rb +61 -0
  133. data/lib/elasticsearch/api/actions/snapshot/restore.rb +25 -6
  134. data/lib/elasticsearch/api/actions/snapshot/status.rb +27 -6
  135. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +25 -7
  136. data/lib/elasticsearch/api/actions/tasks/cancel.rb +30 -17
  137. data/lib/elasticsearch/api/actions/tasks/get.rb +27 -6
  138. data/lib/elasticsearch/api/actions/tasks/list.rb +35 -22
  139. data/lib/elasticsearch/api/actions/tasks/params_registry.rb +61 -0
  140. data/lib/elasticsearch/api/actions/termvectors.rb +65 -43
  141. data/lib/elasticsearch/api/actions/update.rb +50 -21
  142. data/lib/elasticsearch/api/actions/update_by_query.rb +49 -46
  143. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +46 -0
  144. data/lib/elasticsearch/api/namespace/cat.rb +17 -0
  145. data/lib/elasticsearch/api/namespace/cluster.rb +17 -0
  146. data/lib/elasticsearch/api/namespace/common.rb +19 -2
  147. data/lib/elasticsearch/api/namespace/indices.rb +17 -0
  148. data/lib/elasticsearch/api/namespace/ingest.rb +17 -0
  149. data/lib/elasticsearch/api/namespace/nodes.rb +17 -0
  150. data/lib/elasticsearch/api/namespace/remote.rb +17 -0
  151. data/lib/elasticsearch/api/namespace/snapshot.rb +17 -0
  152. data/lib/elasticsearch/api/namespace/tasks.rb +17 -0
  153. data/lib/elasticsearch/api/utils.rb +17 -0
  154. data/lib/elasticsearch/api/version.rb +18 -1
  155. data/lib/elasticsearch/api.rb +20 -0
  156. data/lib/elasticsearch-api.rb +17 -0
  157. data/spec/elasticsearch/api/actions/abort_benchmark_spec.rb +34 -0
  158. data/spec/elasticsearch/api/actions/benchmark_spec.rb +34 -0
  159. data/spec/elasticsearch/api/actions/bulk_spec.rb +139 -0
  160. data/spec/elasticsearch/api/actions/cat/aliases_spec.rb +35 -0
  161. data/spec/elasticsearch/api/actions/cat/allocation_spec.rb +35 -0
  162. data/spec/elasticsearch/api/actions/cat/count_spec.rb +35 -0
  163. data/spec/elasticsearch/api/actions/cat/fielddata_spec.rb +52 -0
  164. data/spec/elasticsearch/api/actions/cat/health_spec.rb +35 -0
  165. data/spec/elasticsearch/api/actions/cat/help_spec.rb +35 -0
  166. data/spec/elasticsearch/api/actions/cat/indices_spec.rb +35 -0
  167. data/spec/elasticsearch/api/actions/cat/master_spec.rb +35 -0
  168. data/spec/elasticsearch/api/actions/cat/nodeattrs_spec.rb +35 -0
  169. data/spec/elasticsearch/api/actions/cat/nodes_spec.rb +35 -0
  170. data/spec/elasticsearch/api/actions/cat/pending_tasks_spec.rb +35 -0
  171. data/spec/elasticsearch/api/actions/cat/plugins_spec.rb +35 -0
  172. data/spec/elasticsearch/api/actions/cat/recovery_spec.rb +35 -0
  173. data/spec/elasticsearch/api/actions/cat/repositories_spec.rb +35 -0
  174. data/spec/elasticsearch/api/actions/cat/segments_spec.rb +51 -0
  175. data/spec/elasticsearch/api/actions/cat/shards_spec.rb +35 -0
  176. data/spec/elasticsearch/api/actions/cat/snapshot_spec.rb +35 -0
  177. data/spec/elasticsearch/api/actions/cat/tasks_spec.rb +35 -0
  178. data/spec/elasticsearch/api/actions/cat/templates_spec.rb +35 -0
  179. data/spec/elasticsearch/api/actions/cat/thread_pool_spec.rb +35 -0
  180. data/spec/elasticsearch/api/actions/clear_scroll_spec.rb +50 -0
  181. data/spec/elasticsearch/api/actions/cluster/allocation_explain_spec.rb +35 -0
  182. data/spec/elasticsearch/api/actions/cluster/get_settings_spec.rb +35 -0
  183. data/spec/elasticsearch/api/actions/cluster/health_spec.rb +69 -0
  184. data/spec/elasticsearch/api/actions/cluster/pending_tasks_spec.rb +35 -0
  185. data/spec/elasticsearch/api/actions/cluster/put_settings_spec.rb +35 -0
  186. data/spec/elasticsearch/api/actions/cluster/remote_info_spec.rb +35 -0
  187. data/spec/elasticsearch/api/actions/cluster/reroute_spec.rb +52 -0
  188. data/spec/elasticsearch/api/actions/cluster/state_spec.rb +52 -0
  189. data/spec/elasticsearch/api/actions/cluster/stats_spec.rb +35 -0
  190. data/spec/elasticsearch/api/actions/count_spec.rb +66 -0
  191. data/spec/elasticsearch/api/actions/create_document_spec.rb +82 -0
  192. data/spec/elasticsearch/api/actions/delete_by_query_spec.rb +72 -0
  193. data/spec/elasticsearch/api/actions/delete_document_spec.rb +110 -0
  194. data/spec/elasticsearch/api/actions/delete_script_spec.rb +50 -0
  195. data/spec/elasticsearch/api/actions/exists_document_spec.rb +126 -0
  196. data/spec/elasticsearch/api/actions/explain_document_spec.rb +99 -0
  197. data/spec/elasticsearch/api/actions/field_caps_spec.rb +34 -0
  198. data/spec/elasticsearch/api/actions/get_document_source_spec.rb +98 -0
  199. data/spec/elasticsearch/api/actions/get_document_spec.rb +123 -0
  200. data/spec/elasticsearch/api/actions/get_script_spec.rb +49 -0
  201. data/{test/unit/hashie_test.rb → spec/elasticsearch/api/actions/hashie_spec.rb} +28 -17
  202. data/spec/elasticsearch/api/actions/index_document_spec.rb +145 -0
  203. data/spec/elasticsearch/api/actions/indices/analyze_spec.rb +73 -0
  204. data/spec/elasticsearch/api/actions/indices/clear_cache_spec.rb +84 -0
  205. data/spec/elasticsearch/api/actions/indices/close_spec.rb +85 -0
  206. data/spec/elasticsearch/api/actions/indices/create_spec.rb +85 -0
  207. data/spec/elasticsearch/api/actions/indices/delete_alias_spec.rb +83 -0
  208. data/spec/elasticsearch/api/actions/indices/delete_spec.rb +108 -0
  209. data/spec/elasticsearch/api/actions/indices/delete_template_spec.rb +86 -0
  210. data/spec/elasticsearch/api/actions/indices/exists_alias_spec.rb +108 -0
  211. data/spec/elasticsearch/api/actions/indices/exists_spec.rb +108 -0
  212. data/spec/elasticsearch/api/actions/indices/exists_template_spec.rb +93 -0
  213. data/spec/elasticsearch/api/actions/indices/exists_type_spec.rb +108 -0
  214. data/spec/elasticsearch/api/actions/indices/flush_spec.rb +91 -0
  215. data/spec/elasticsearch/api/actions/indices/flush_synced_spec.rb +90 -0
  216. data/spec/elasticsearch/api/actions/indices/forcemerge_spec.rb +35 -0
  217. data/spec/elasticsearch/api/actions/indices/freeze_spec.rb +68 -0
  218. data/spec/elasticsearch/api/actions/indices/get_alias_spec.rb +61 -0
  219. data/spec/elasticsearch/api/actions/indices/get_field_mapping_spec.rb +61 -0
  220. data/spec/elasticsearch/api/actions/indices/get_mapping_spec.rb +83 -0
  221. data/spec/elasticsearch/api/actions/indices/get_settings_spec.rb +72 -0
  222. data/spec/elasticsearch/api/actions/indices/get_spec.rb +65 -0
  223. data/spec/elasticsearch/api/actions/indices/open_spec.rb +65 -0
  224. data/spec/elasticsearch/api/actions/indices/put_alias_spec.rb +89 -0
  225. data/spec/elasticsearch/api/actions/indices/put_mapping_spec.rb +102 -0
  226. data/spec/elasticsearch/api/actions/indices/put_settings_spec.rb +108 -0
  227. data/spec/elasticsearch/api/actions/indices/put_template_spec.rb +107 -0
  228. data/spec/elasticsearch/api/actions/indices/recovery_spec.rb +35 -0
  229. data/spec/elasticsearch/api/actions/indices/refresh_spec.rb +91 -0
  230. data/spec/elasticsearch/api/actions/indices/rollover_spec.rb +58 -0
  231. data/spec/elasticsearch/api/actions/indices/segments_spec.rb +91 -0
  232. data/spec/elasticsearch/api/actions/indices/shard_stores_spec.rb +35 -0
  233. data/spec/elasticsearch/api/actions/indices/shrink_spec.rb +42 -0
  234. data/spec/elasticsearch/api/actions/indices/split_spec.rb +35 -0
  235. data/spec/elasticsearch/api/actions/indices/stats_spec.rb +125 -0
  236. data/spec/elasticsearch/api/actions/indices/unfreeze_spec.rb +68 -0
  237. data/spec/elasticsearch/api/actions/indices/update_aliases_spec.rb +67 -0
  238. data/spec/elasticsearch/api/actions/indices/upgrade_spec.rb +35 -0
  239. data/spec/elasticsearch/api/actions/indices/validate_query_spec.rb +128 -0
  240. data/spec/elasticsearch/api/actions/info_spec.rb +34 -0
  241. data/spec/elasticsearch/api/actions/ingest/delete_pipeline_spec.rb +60 -0
  242. data/spec/elasticsearch/api/actions/ingest/get_pipeline_spec.rb +50 -0
  243. data/spec/elasticsearch/api/actions/ingest/put_pipeline_spec.rb +60 -0
  244. data/spec/elasticsearch/api/actions/ingest/simulate_spec.rb +50 -0
  245. data/spec/elasticsearch/api/actions/json_builders_spec.rb +85 -0
  246. data/spec/elasticsearch/api/actions/mget_spec.rb +102 -0
  247. data/spec/elasticsearch/api/actions/msearch_spec.rb +169 -0
  248. data/spec/elasticsearch/api/actions/msearch_template_spec.rb +94 -0
  249. data/spec/elasticsearch/api/actions/mtermvectors_spec.rb +45 -0
  250. data/spec/elasticsearch/api/actions/nodes/hot_threads_spec.rb +61 -0
  251. data/spec/elasticsearch/api/actions/nodes/info_spec.rb +102 -0
  252. data/spec/elasticsearch/api/actions/nodes/reload_secure_settings_spec.rb +87 -0
  253. data/spec/elasticsearch/api/actions/nodes/shutdown_spec.rb +76 -0
  254. data/spec/elasticsearch/api/actions/nodes/stats_spec.rb +76 -0
  255. data/spec/elasticsearch/api/actions/ping_spec.rb +75 -0
  256. data/spec/elasticsearch/api/actions/put_script_spec.rb +49 -0
  257. data/spec/elasticsearch/api/actions/reindex_spec.rb +34 -0
  258. data/spec/elasticsearch/api/actions/remote/info_spec.rb +35 -0
  259. data/spec/elasticsearch/api/actions/render_search_template_spec.rb +34 -0
  260. data/spec/elasticsearch/api/actions/scoll_spec.rb +34 -0
  261. data/spec/elasticsearch/api/actions/search_shards_spec.rb +34 -0
  262. data/spec/elasticsearch/api/actions/search_spec.rb +148 -0
  263. data/spec/elasticsearch/api/actions/search_template_spec.rb +34 -0
  264. data/spec/elasticsearch/api/actions/snapshot/create_repository_spec.rb +51 -0
  265. data/spec/elasticsearch/api/actions/snapshot/create_spec.rb +51 -0
  266. data/spec/elasticsearch/api/actions/snapshot/delete_repository_spec.rb +50 -0
  267. data/spec/elasticsearch/api/actions/snapshot/delete_spec.rb +51 -0
  268. data/spec/elasticsearch/api/actions/snapshot/get_repository_spec.rb +35 -0
  269. data/spec/elasticsearch/api/actions/snapshot/get_spec.rb +51 -0
  270. data/spec/elasticsearch/api/actions/snapshot/restore_spec.rb +51 -0
  271. data/spec/elasticsearch/api/actions/snapshot/status_spec.rb +50 -0
  272. data/spec/elasticsearch/api/actions/snapshot/verify_repository_spec.rb +35 -0
  273. data/spec/elasticsearch/api/actions/tasks/cancel_spec.rb +50 -0
  274. data/spec/elasticsearch/api/actions/tasks/get_spec.rb +35 -0
  275. data/spec/elasticsearch/api/actions/tasks/list_spec.rb +50 -0
  276. data/spec/elasticsearch/api/actions/termvectors_spec.rb +67 -0
  277. data/spec/elasticsearch/api/actions/update_by_query_spec.rb +34 -0
  278. data/spec/elasticsearch/api/actions/update_document_spec.rb +125 -0
  279. data/spec/elasticsearch/api/api_spec.rb +43 -0
  280. data/spec/elasticsearch/api/client_spec.rb +46 -0
  281. data/spec/elasticsearch/api/utils_spec.rb +430 -0
  282. data/spec/spec_helper.rb +79 -0
  283. data/test/integration/yaml_test_runner.rb +91 -44
  284. data/test/test_helper.rb +62 -13
  285. data/utils/Gemfile +17 -0
  286. data/utils/Thorfile +17 -0
  287. data/utils/thor/generate_api.rb +17 -0
  288. data/utils/thor/generate_source.rb +23 -2
  289. data/utils/thor/lister.rb +17 -0
  290. data/utils/thor/templates/ruby/method.erb +17 -0
  291. data/utils/thor/templates/ruby/test.erb +17 -0
  292. data/utils/thor/templates/ruby/test_helper.rb +17 -1
  293. metadata +290 -323
  294. data/lib/elasticsearch/api/actions/count_percolate.rb +0 -78
  295. data/lib/elasticsearch/api/actions/delete_template.rb +0 -21
  296. data/lib/elasticsearch/api/actions/field_stats.rb +0 -32
  297. data/lib/elasticsearch/api/actions/get_template.rb +0 -27
  298. data/lib/elasticsearch/api/actions/indices/delete_mapping.rb +0 -26
  299. data/lib/elasticsearch/api/actions/indices/delete_warmer.rb +0 -32
  300. data/lib/elasticsearch/api/actions/indices/get_aliases.rb +0 -34
  301. data/lib/elasticsearch/api/actions/indices/get_warmer.rb +0 -60
  302. data/lib/elasticsearch/api/actions/indices/optimize.rb +0 -74
  303. data/lib/elasticsearch/api/actions/indices/put_warmer.rb +0 -64
  304. data/lib/elasticsearch/api/actions/indices/seal.rb +0 -24
  305. data/lib/elasticsearch/api/actions/indices/snapshot_index.rb +0 -43
  306. data/lib/elasticsearch/api/actions/indices/status.rb +0 -60
  307. data/lib/elasticsearch/api/actions/list_benchmarks.rb +0 -27
  308. data/lib/elasticsearch/api/actions/mlt.rb +0 -128
  309. data/lib/elasticsearch/api/actions/mpercolate.rb +0 -59
  310. data/lib/elasticsearch/api/actions/percolate.rb +0 -71
  311. data/lib/elasticsearch/api/actions/put_template.rb +0 -25
  312. data/lib/elasticsearch/api/actions/search_exists.rb +0 -59
  313. data/lib/elasticsearch/api/actions/suggest.rb +0 -46
  314. data/test/unit/abort_benchmark_test.rb +0 -26
  315. data/test/unit/api_test.rb +0 -28
  316. data/test/unit/benchmark_test.rb +0 -26
  317. data/test/unit/bulk_test.rb +0 -133
  318. data/test/unit/cat/aliases_test.rb +0 -26
  319. data/test/unit/cat/allocation_test.rb +0 -26
  320. data/test/unit/cat/count_test.rb +0 -26
  321. data/test/unit/cat/fielddata_test.rb +0 -38
  322. data/test/unit/cat/health_test.rb +0 -26
  323. data/test/unit/cat/help_test.rb +0 -26
  324. data/test/unit/cat/indices_test.rb +0 -26
  325. data/test/unit/cat/master_test.rb +0 -26
  326. data/test/unit/cat/nodeattrs_test.rb +0 -26
  327. data/test/unit/cat/nodes_test.rb +0 -26
  328. data/test/unit/cat/pending_tasks_test.rb +0 -26
  329. data/test/unit/cat/plugins_test.rb +0 -26
  330. data/test/unit/cat/recovery_test.rb +0 -26
  331. data/test/unit/cat/repositories_test.rb +0 -26
  332. data/test/unit/cat/segments_test.rb +0 -26
  333. data/test/unit/cat/shards_test.rb +0 -26
  334. data/test/unit/cat/snapshots_test.rb +0 -26
  335. data/test/unit/cat/tasks_test.rb +0 -26
  336. data/test/unit/cat/templates_test.rb +0 -26
  337. data/test/unit/cat/thread_pool_test.rb +0 -26
  338. data/test/unit/clear_scroll_test.rb +0 -38
  339. data/test/unit/client_test.rb +0 -31
  340. data/test/unit/cluster/allocation_explain_test.rb +0 -26
  341. data/test/unit/cluster/get_settings_test.rb +0 -26
  342. data/test/unit/cluster/health_test.rb +0 -47
  343. data/test/unit/cluster/pending_tasks_test.rb +0 -26
  344. data/test/unit/cluster/put_settings_test.rb +0 -26
  345. data/test/unit/cluster/remote_info_test.rb +0 -26
  346. data/test/unit/cluster/reroute_test.rb +0 -38
  347. data/test/unit/cluster/state_test.rb +0 -46
  348. data/test/unit/cluster/stats_test.rb +0 -26
  349. data/test/unit/count_percolate_test.rb +0 -26
  350. data/test/unit/count_test.rb +0 -46
  351. data/test/unit/create_document_test.rb +0 -56
  352. data/test/unit/delete_by_query_test.rb +0 -51
  353. data/test/unit/delete_document_test.rb +0 -85
  354. data/test/unit/delete_script_test.rb +0 -26
  355. data/test/unit/delete_template_test.rb +0 -26
  356. data/test/unit/exists_document_test.rb +0 -90
  357. data/test/unit/explain_document_test.rb +0 -73
  358. data/test/unit/field_caps_test.rb +0 -26
  359. data/test/unit/field_stats_test.rb +0 -26
  360. data/test/unit/get_document_source_test.rb +0 -71
  361. data/test/unit/get_document_test.rb +0 -85
  362. data/test/unit/get_script_test.rb +0 -26
  363. data/test/unit/get_template_test.rb +0 -41
  364. data/test/unit/index_document_test.rb +0 -92
  365. data/test/unit/indices/analyze_test.rb +0 -76
  366. data/test/unit/indices/clear_cache_test.rb +0 -54
  367. data/test/unit/indices/close_test.rb +0 -51
  368. data/test/unit/indices/create_test.rb +0 -51
  369. data/test/unit/indices/delete_alias_test.rb +0 -47
  370. data/test/unit/indices/delete_mapping_test.rb +0 -56
  371. data/test/unit/indices/delete_template_test.rb +0 -51
  372. data/test/unit/indices/delete_test.rb +0 -69
  373. data/test/unit/indices/delete_warmer_test.rb +0 -68
  374. data/test/unit/indices/exists_alias_test.rb +0 -73
  375. data/test/unit/indices/exists_template_test.rb +0 -59
  376. data/test/unit/indices/exists_test.rb +0 -71
  377. data/test/unit/indices/exists_type_test.rb +0 -73
  378. data/test/unit/indices/flush_synced_test.rb +0 -41
  379. data/test/unit/indices/flush_test.rb +0 -54
  380. data/test/unit/indices/forcemerge_test.rb +0 -26
  381. data/test/unit/indices/get_alias_test.rb +0 -44
  382. data/test/unit/indices/get_aliases_test.rb +0 -54
  383. data/test/unit/indices/get_field_mapping_test.rb +0 -44
  384. data/test/unit/indices/get_mapping_test.rb +0 -62
  385. data/test/unit/indices/get_settings_test.rb +0 -54
  386. data/test/unit/indices/get_template_test.rb +0 -43
  387. data/test/unit/indices/get_test.rb +0 -45
  388. data/test/unit/indices/get_warmer_test.rb +0 -44
  389. data/test/unit/indices/open_test.rb +0 -51
  390. data/test/unit/indices/optimize_test.rb +0 -54
  391. data/test/unit/indices/put_alias_test.rb +0 -59
  392. data/test/unit/indices/put_mapping_test.rb +0 -60
  393. data/test/unit/indices/put_settings_test.rb +0 -68
  394. data/test/unit/indices/put_template_test.rb +0 -57
  395. data/test/unit/indices/put_warmer_test.rb +0 -65
  396. data/test/unit/indices/recovery_test.rb +0 -26
  397. data/test/unit/indices/refresh_test.rb +0 -64
  398. data/test/unit/indices/rollover_test.rb +0 -38
  399. data/test/unit/indices/seal_test.rb +0 -25
  400. data/test/unit/indices/segments_test.rb +0 -64
  401. data/test/unit/indices/shard_stores_test.rb +0 -26
  402. data/test/unit/indices/shrink_test.rb +0 -33
  403. data/test/unit/indices/snapshot_index_test.rb +0 -64
  404. data/test/unit/indices/stats_test.rb +0 -76
  405. data/test/unit/indices/status_test.rb +0 -72
  406. data/test/unit/indices/update_aliases_test.rb +0 -42
  407. data/test/unit/indices/upgrade_test.rb +0 -26
  408. data/test/unit/indices/validate_query_test.rb +0 -84
  409. data/test/unit/info_test.rb +0 -26
  410. data/test/unit/ingest/delete_pipeline_test.rb +0 -41
  411. data/test/unit/ingest/get_pipeline_test.rb +0 -35
  412. data/test/unit/ingest/put_pipeline_test.rb +0 -46
  413. data/test/unit/ingest/simulate_test.rb +0 -35
  414. data/test/unit/json_builders_test.rb +0 -64
  415. data/test/unit/list_benchmarks_test.rb +0 -26
  416. data/test/unit/mget_test.rb +0 -79
  417. data/test/unit/mlt_test.rb +0 -89
  418. data/test/unit/mpercolate_test.rb +0 -51
  419. data/test/unit/msearch_template_test.rb +0 -60
  420. data/test/unit/msearch_test.rb +0 -129
  421. data/test/unit/mtermvectors_test.rb +0 -38
  422. data/test/unit/nodes/hot_threads_test.rb +0 -44
  423. data/test/unit/nodes/info_test.rb +0 -75
  424. data/test/unit/nodes/shutdown_test.rb +0 -45
  425. data/test/unit/nodes/stats_test.rb +0 -65
  426. data/test/unit/percolate_test.rb +0 -56
  427. data/test/unit/ping_test.rb +0 -53
  428. data/test/unit/put_script_test.rb +0 -26
  429. data/test/unit/put_template_test.rb +0 -26
  430. data/test/unit/reindex_test.rb +0 -26
  431. data/test/unit/remote/info_test.rb +0 -26
  432. data/test/unit/render_search_template_test.rb +0 -25
  433. data/test/unit/scroll_test.rb +0 -26
  434. data/test/unit/search_exists_test.rb +0 -26
  435. data/test/unit/search_shards_test.rb +0 -26
  436. data/test/unit/search_template_test.rb +0 -26
  437. data/test/unit/search_test.rb +0 -116
  438. data/test/unit/snapshot/create_repository_test.rb +0 -38
  439. data/test/unit/snapshot/create_test.rb +0 -38
  440. data/test/unit/snapshot/delete_repository_test.rb +0 -35
  441. data/test/unit/snapshot/delete_test.rb +0 -38
  442. data/test/unit/snapshot/get_repository_test.rb +0 -26
  443. data/test/unit/snapshot/get_test.rb +0 -38
  444. data/test/unit/snapshot/restore_test.rb +0 -38
  445. data/test/unit/snapshot/status_test.rb +0 -38
  446. data/test/unit/snapshot/verify_repository_test.rb +0 -26
  447. data/test/unit/suggest_test.rb +0 -64
  448. data/test/unit/tasks/cancel_test.rb +0 -38
  449. data/test/unit/tasks/get_test.rb +0 -26
  450. data/test/unit/tasks/list_test.rb +0 -38
  451. data/test/unit/termvectors_test.rb +0 -47
  452. data/test/unit/update_by_query_test.rb +0 -26
  453. data/test/unit/update_document_test.rb +0 -85
  454. data/test/unit/utils_test.rb +0 -310
@@ -1,3 +1,20 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
1
18
  module Elasticsearch
2
19
  module API
3
20
  module Tasks
@@ -5,43 +22,39 @@ module Elasticsearch
5
22
 
6
23
  # Return the list of tasks
7
24
  #
8
- # @option arguments [Number] :task_id Return the task with specified id
9
- # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned
10
- # information; use `_local` to return information from the node
11
- # you're connecting to, leave empty to get information from all nodes
12
- # @option arguments [List] :actions A comma-separated list of actions that should be returned.
13
- # Leave empty to return all.
25
+ # @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
26
+ # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
14
27
  # @option arguments [Boolean] :detailed Return detailed task information (default: false)
15
- # @option arguments [String] :parent_node Return tasks with specified parent node.
16
- # @option arguments [Number] :parent_task Return tasks with specified parent task id.
17
- # Set to -1 to return all.
18
- # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships
19
- # Options: nodes, parents
28
+ # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
20
29
  # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
30
+ # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none)
31
+ # @option arguments [Time] :timeout Explicit operation timeout
21
32
  #
22
33
  # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-list.html
23
34
  #
24
35
  def list(arguments={})
25
- valid_params = [
26
- :node_id,
27
- :actions,
28
- :detailed,
29
- :parent_node,
30
- :parent_task,
31
- :group_by,
32
- :wait_for_completion ]
33
-
34
36
  arguments = arguments.clone
35
-
36
37
  task_id = arguments.delete(:task_id)
37
38
 
38
39
  method = 'GET'
39
40
  path = Utils.__pathify( '_tasks', Utils.__escape(task_id) )
40
- params = Utils.__validate_and_extract_params arguments, valid_params
41
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
41
42
  body = nil
42
43
 
43
44
  perform_request(method, path, params, body).body
44
45
  end
46
+
47
+ # Register this action with its valid params when the module is loaded.
48
+ #
49
+ # @since 6.1.1
50
+ ParamsRegistry.register(:list, [
51
+ :nodes,
52
+ :actions,
53
+ :detailed,
54
+ :parent_task_id,
55
+ :wait_for_completion,
56
+ :group_by,
57
+ :timeout ].freeze)
45
58
  end
46
59
  end
47
60
  end
@@ -0,0 +1,61 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ module Elasticsearch
19
+ module API
20
+ module Tasks
21
+ module Actions
22
+ module ParamsRegistry
23
+
24
+ extend self
25
+
26
+ # A Mapping of all the actions to their list of valid params.
27
+ #
28
+ # @since 6.1.1
29
+ PARAMS = {}
30
+
31
+ # Register an action with its list of valid params.
32
+ #
33
+ # @example Register the action.
34
+ # ParamsRegistry.register(:benchmark, [ :verbose ])
35
+ #
36
+ # @param [ Symbol ] action The action to register.
37
+ # @param [ Array[Symbol] ] valid_params The list of valid params.
38
+ #
39
+ # @since 6.1.1
40
+ def register(action, valid_params)
41
+ PARAMS[action.to_sym] = valid_params
42
+ end
43
+
44
+ # Get the list of valid params for a given action.
45
+ #
46
+ # @example Get the list of valid params.
47
+ # ParamsRegistry.get(:benchmark)
48
+ #
49
+ # @param [ Symbol ] action The action.
50
+ #
51
+ # @return [ Array<Symbol> ] The list of valid params for the action.
52
+ #
53
+ # @since 6.1.1
54
+ def get(action)
55
+ PARAMS.fetch(action, [])
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
@@ -1,3 +1,20 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
1
18
  module Elasticsearch
2
19
  module API
3
20
  module Actions
@@ -9,12 +26,10 @@ module Elasticsearch
9
26
  # client.indices.create index: 'my_index',
10
27
  # body: {
11
28
  # mappings: {
12
- # my_type: {
13
- # properties: {
14
- # text: {
15
- # type: 'string',
16
- # term_vector: 'with_positions_offsets_payloads'
17
- # }
29
+ # properties: {
30
+ # text: {
31
+ # type: 'string',
32
+ # term_vector: 'with_positions_offsets_payloads'
18
33
  # }
19
34
  # }
20
35
  # }
@@ -36,52 +51,42 @@ module Elasticsearch
36
51
  # }
37
52
  # # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
38
53
  #
39
- # @option arguments [String] :index The name of the index (*Required*)
40
- # @option arguments [String] :type The type of the document (*Required*)
41
- # @option arguments [String] :id The document ID
42
- # @option arguments [Hash] :body The request definition
43
- # @option arguments [Boolean] :term_statistics Whether total term frequency and
44
- # document frequency should be returned
45
- # @option arguments [Boolean] :field_statistics Whether document count, sum of document frequencies
46
- # and sum of total term frequencies should be returned
47
- # @option arguments [List] :fields A comma-separated list of fields to return
48
- # @option arguments [Boolean] :offsets Whether term offsets should be returned
49
- # @option arguments [Boolean] :positions Whether term positions should be returned
50
- # @option arguments [Boolean] :payloads Whether term payloads should be returned
51
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on
52
- # (default: random)
53
- # @option arguments [String] :realtime Specifies if requests are real-time as opposed to near-real-time
54
- # (default: true)
55
- # @option arguments [String] :routing Specific routing value
56
- # @option arguments [String] :parent Parent ID of the documents
54
+ # @option arguments [String] :index The index in which the document resides. (*Required*)
55
+ # @option arguments [String] :type The type of the document.
56
+ # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
57
+ # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
58
+ # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
59
+ # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
60
+ # @option arguments [List] :fields A comma-separated list of fields to return.
61
+ # @option arguments [Boolean] :offsets Specifies if term offsets should be returned.
62
+ # @option arguments [Boolean] :positions Specifies if term positions should be returned.
63
+ # @option arguments [Boolean] :payloads Specifies if term payloads should be returned.
64
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random).
65
+ # @option arguments [String] :routing Specific routing value.
66
+ # @option arguments [String] :parent Parent id of documents.
67
+ # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true).
68
+ # @option arguments [Number] :version Explicit version number for concurrency control
69
+ # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
57
70
  #
58
71
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-termvectors.html
59
72
  #
60
73
  def termvectors(arguments={})
61
74
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
62
- raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
63
-
64
- valid_params = [
65
- :term_statistics,
66
- :field_statistics,
67
- :fields,
68
- :offsets,
69
- :positions,
70
- :payloads,
71
- :preference,
72
- :realtime,
73
- :routing,
74
- :parent ]
75
-
76
75
  method = HTTP_GET
77
76
  endpoint = arguments.delete(:endpoint) || '_termvectors'
78
77
 
79
- path = Utils.__pathify Utils.__escape(arguments[:index]),
80
- Utils.__escape(arguments[:type]),
81
- arguments[:id],
82
- endpoint
78
+ if arguments[:type]
79
+ path = Utils.__pathify Utils.__escape(arguments[:index]),
80
+ arguments[:type],
81
+ arguments[:id],
82
+ endpoint
83
+ else
84
+ path = Utils.__pathify Utils.__escape(arguments[:index]),
85
+ endpoint,
86
+ arguments[:id]
87
+ end
83
88
 
84
- params = Utils.__validate_and_extract_params arguments, valid_params
89
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
85
90
  body = arguments[:body]
86
91
 
87
92
  perform_request(method, path, params, body).body
@@ -92,6 +97,23 @@ module Elasticsearch
92
97
  def termvector(arguments={})
93
98
  termvectors(arguments.merge :endpoint => '_termvector')
94
99
  end
100
+
101
+ # Register this action with its valid params when the module is loaded.
102
+ #
103
+ # @since 6.1.1
104
+ ParamsRegistry.register(:termvectors, [
105
+ :term_statistics,
106
+ :field_statistics,
107
+ :fields,
108
+ :offsets,
109
+ :positions,
110
+ :payloads,
111
+ :preference,
112
+ :routing,
113
+ :parent,
114
+ :realtime,
115
+ :version,
116
+ :version_type ].freeze)
95
117
  end
96
118
  end
97
119
  end
@@ -1,3 +1,20 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
1
18
  module Elasticsearch
2
19
  module API
3
20
  module Actions
@@ -41,6 +58,7 @@ module Elasticsearch
41
58
  # @option arguments [String] :consistency Explicit write consistency setting for the operation
42
59
  # (options: one, quorum, all)
43
60
  # @option arguments [List] :fields A comma-separated list of fields to return in the response
61
+ # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
44
62
  # @option arguments [String] :lang The script language (default: mvel)
45
63
  # @option arguments [String] :parent ID of the parent document
46
64
  # @option arguments [String] :percolate Perform percolation during the operation;
@@ -67,12 +85,39 @@ module Elasticsearch
67
85
  #
68
86
  def update(arguments={})
69
87
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
70
- raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
71
88
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
89
+ arguments[:type] ||= DEFAULT_DOC
90
+ method = HTTP_POST
91
+
92
+ if arguments[:type]
93
+ path = Utils.__pathify Utils.__escape(arguments[:index]),
94
+ Utils.__escape(arguments[:type]),
95
+ Utils.__escape(arguments[:id]),
96
+ '_update'
97
+ else
98
+ path = Utils.__pathify Utils.__escape(arguments[:index]),
99
+ '_update',
100
+ Utils.__escape(arguments[:id])
101
+ end
102
+
103
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
104
+ body = arguments[:body]
105
+ params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
106
+
107
+ if Array(arguments[:ignore]).include?(404)
108
+ Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
109
+ else
110
+ perform_request(method, path, params, body).body
111
+ end
112
+ end
72
113
 
73
- valid_params = [
114
+ # Register this action with its valid params when the module is loaded.
115
+ #
116
+ # @since 6.1.1
117
+ ParamsRegistry.register(:update, [
74
118
  :consistency,
75
119
  :fields,
120
+ :include_type_name,
76
121
  :lang,
77
122
  :parent,
78
123
  :percolate,
@@ -88,25 +133,9 @@ module Elasticsearch
88
133
  :timestamp,
89
134
  :ttl,
90
135
  :version,
91
- :version_type ]
92
-
93
- method = HTTP_POST
94
- path = Utils.__pathify Utils.__escape(arguments[:index]),
95
- Utils.__escape(arguments[:type]),
96
- Utils.__escape(arguments[:id]),
97
- '_update'
98
-
99
- params = Utils.__validate_and_extract_params arguments, valid_params
100
- body = arguments[:body]
101
-
102
- params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
103
-
104
- if Array(arguments[:ignore]).include?(404)
105
- Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
106
- else
107
- perform_request(method, path, params, body).body
108
- end
109
- end
136
+ :version_type,
137
+ :if_seq_no,
138
+ :if_primary_term ].freeze)
110
139
  end
111
140
  end
112
141
  end
@@ -1,3 +1,20 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
1
18
  module Elasticsearch
2
19
  module API
3
20
  module Actions
@@ -23,65 +40,68 @@ module Elasticsearch
23
40
  # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
24
41
  # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
25
42
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
26
- # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
27
- # @option arguments [List] :fields A comma-separated list of fields to return as part of a hit
28
- # @option arguments [List] :fielddata_fields A comma-separated list of fields to return as the field data representation of a field for each hit
29
43
  # @option arguments [Number] :from Starting offset (default: 0)
30
44
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
31
45
  # @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)
32
- # @option arguments [String] :conflicts What to do when the reindex hits version conflicts? (options: abort, proceed)
46
+ # @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
33
47
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
34
48
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
35
- # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
36
49
  # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
37
50
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
38
51
  # @option arguments [String] :q Query in the Lucene query string syntax
39
52
  # @option arguments [List] :routing A comma-separated list of specific routing values
40
- # @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
53
+ # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
41
54
  # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
42
55
  # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
43
56
  # @option arguments [Number] :size Number of hits to return (default: 10)
44
57
  # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
45
58
  # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
46
- # @option arguments [List] :_source_exclude A list of fields to exclude from the returned _source field
47
- # @option arguments [List] :_source_include A list of fields to extract and return from the _source field
59
+ # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
60
+ # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
48
61
  # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
49
62
  # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
50
- # @option arguments [String] :suggest_field Specify which field to use for suggestions
51
- # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
52
- # @option arguments [Number] :suggest_size How many suggestions to return in response
53
- # @option arguments [Text] :suggest_text The source text for which the suggestions should be returned
54
- # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
55
- # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
56
63
  # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
57
64
  # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
58
65
  # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
59
66
  # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
60
- # @option arguments [String] :consistency Explicit write consistency setting for the operation (options: one, quorum, all)
61
- # @option arguments [Integer] :scroll_size Size on the scroll request powering the update_by_query
62
- # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
63
- # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. 0 means set no throttle.
67
+ # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
68
+ # @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)
69
+ # @option arguments [Number] :scroll_size Size on the scroll request powering the update by query
70
+ # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete.
71
+ # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
72
+ # @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
64
73
  #
65
74
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
66
75
  #
67
76
  def update_by_query(arguments={})
68
77
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
78
+ method = HTTP_POST
79
+
80
+ path = Utils.__pathify Utils.__listify(arguments[:index]),
81
+ Utils.__listify(arguments[:type]),
82
+ '/_update_by_query'
69
83
 
70
- valid_params = [
84
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
85
+
86
+ body = arguments[:body]
87
+
88
+ perform_request(method, path, params, body).body
89
+ end
90
+
91
+ # Register this action with its valid params when the module is loaded.
92
+ #
93
+ # @since 6.1.1
94
+ ParamsRegistry.register(:update_by_query, [
71
95
  :analyzer,
72
96
  :analyze_wildcard,
73
97
  :default_operator,
74
98
  :df,
75
- :explain,
76
- :fields,
77
- :fielddata_fields,
78
99
  :from,
79
100
  :ignore_unavailable,
80
101
  :allow_no_indices,
81
102
  :conflicts,
82
103
  :expand_wildcards,
83
104
  :lenient,
84
- :lowercase_expanded_terms,
85
105
  :pipeline,
86
106
  :preference,
87
107
  :q,
@@ -92,37 +112,20 @@ module Elasticsearch
92
112
  :size,
93
113
  :sort,
94
114
  :_source,
95
- :_source_exclude,
96
- :_source_include,
115
+ :_source_excludes,
116
+ :_source_includes,
97
117
  :terminate_after,
98
118
  :stats,
99
- :suggest_field,
100
- :suggest_mode,
101
- :suggest_size,
102
- :suggest_text,
103
- :timeout,
104
- :track_scores,
105
119
  :version,
106
120
  :version_type,
107
121
  :request_cache,
108
122
  :refresh,
109
- :consistency,
123
+ :timeout,
124
+ :wait_for_active_shards,
110
125
  :scroll_size,
111
126
  :wait_for_completion,
112
- :requests_per_second ]
113
-
114
- method = HTTP_POST
115
-
116
- path = Utils.__pathify Utils.__listify(arguments[:index]),
117
- Utils.__listify(arguments[:type]),
118
- '/_update_by_query'
119
-
120
- params = Utils.__validate_and_extract_params arguments, valid_params
121
-
122
- body = arguments[:body]
123
-
124
- perform_request(method, path, params, body).body
125
- end
127
+ :requests_per_second,
128
+ :slices ].freeze)
126
129
  end
127
130
  end
128
131
  end
@@ -0,0 +1,46 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ module Elasticsearch
19
+ module API
20
+ module Actions
21
+
22
+ # The value of requests_per_second can be changed on a running update by query using the _rethrottle API
23
+ #
24
+ # @option arguments [String] :task_id The task id to rethrottle (*Required*)
25
+ # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
26
+ #
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
28
+ #
29
+ def update_by_query_rethrottle(arguments={})
30
+ raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
31
+ method = Elasticsearch::API::HTTP_POST
32
+ path = "_update_by_query/#{arguments[:task_id]}/_rethrottle"
33
+ params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
34
+ body = nil
35
+
36
+ perform_request(method, path, params, body).body
37
+ end
38
+
39
+ # Register this action with its valid params when the module is loaded.
40
+ #
41
+ # @since 6.2.0
42
+ ParamsRegistry.register(:update_by_query_rethrottle, [
43
+ :requests_per_second ].freeze)
44
+ end
45
+ end
46
+ end
@@ -1,3 +1,20 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
1
18
  module Elasticsearch
2
19
  module API
3
20
  module Cat
@@ -1,3 +1,20 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
1
18
  module Elasticsearch
2
19
  module API
3
20
  module Cluster