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 Actions
@@ -35,35 +52,38 @@ module Elasticsearch
35
52
  # }
36
53
  # }
37
54
  #
38
- # @option arguments [Hash] :body The definition of the operation (source index, target index, ...)
39
- # (*Required*)
40
- # @option arguments [Boolean] :refresh Whether the affected indexes should be refreshed
41
- # @option arguments [Time] :timeout Time each individual bulk request should wait for shards
42
- # that are unavailable. (Default: 1m)
43
- # @option arguments [String] :consistency Explicit write consistency setting for the operation
44
- # (Options: one, quorum, all)
45
- # @option arguments [Boolean] :wait_for_completion Whether the request should block and wait until
46
- # the operation has completed
47
- # @option arguments [Float] :requests_per_second The throttling for this request in sub-requests per second.
48
- # 0 means set no throttling (default)
55
+ # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
56
+ # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
57
+ # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
58
+ # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex 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)
59
+ # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
60
+ # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
61
+ # @option arguments [Time] :scroll Control how long to keep the search context alive
62
+ # @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.
49
63
  #
50
64
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
51
65
  #
52
66
  def reindex(arguments={})
53
67
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
54
- valid_params = [
55
- :refresh,
56
- :timeout,
57
- :consistency,
58
- :wait_for_completion,
59
- :requests_per_second ]
60
68
  method = 'POST'
61
69
  path = "_reindex"
62
- params = Utils.__validate_and_extract_params arguments, valid_params
70
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
63
71
  body = arguments[:body]
64
72
 
65
73
  perform_request(method, path, params, body).body
66
74
  end
75
+
76
+ # Register this action with its valid params when the module is loaded.
77
+ #
78
+ # @since 6.1.1
79
+ ParamsRegistry.register(:reindex, [
80
+ :refresh,
81
+ :timeout,
82
+ :wait_for_active_shards,
83
+ :wait_for_completion,
84
+ :requests_per_second,
85
+ :scroll,
86
+ :slices ].freeze)
67
87
  end
68
88
  end
69
89
  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 reindex using the _rethrottle
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-reindex.html
28
+ #
29
+ def reindex_rethrottle(arguments={})
30
+ raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
31
+ method = Elasticsearch::API::HTTP_POST
32
+ path = "_reindex/#{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(:reindex_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 Remote
@@ -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
@@ -10,16 +27,19 @@ module Elasticsearch
10
27
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
11
28
  #
12
29
  def render_search_template(arguments={})
13
- valid_params = [
14
- :id
15
- ]
16
30
  method = 'GET'
17
31
  path = "_render/template"
18
- params = Utils.__validate_and_extract_params arguments, valid_params
32
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
19
33
  body = arguments[:body]
20
34
 
21
35
  perform_request(method, path, params, body).body
22
36
  end
37
+
38
+ # Register this action with its valid params when the module is loaded.
39
+ #
40
+ # @since 6.1.1
41
+ ParamsRegistry.register(:render_search_template, [
42
+ :id ].freeze)
23
43
  end
24
44
  end
25
45
  end
@@ -0,0 +1,38 @@
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 Painless execute API allows an arbitrary script to be executed and a result to be returned.
23
+ #
24
+ # @option arguments [Hash] :body The script to execute
25
+ #
26
+ # @see https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html
27
+ #
28
+ def scripts_painless_execute(arguments={})
29
+ method = Elasticsearch::API::HTTP_GET
30
+ path = "_scripts/painless/_execute"
31
+ params = {}
32
+ body = arguments[:body]
33
+
34
+ perform_request(method, path, params, body).body
35
+ end
36
+ end
37
+ end
38
+ 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
@@ -16,7 +33,7 @@ module Elasticsearch
16
33
  # scroll: '5m',
17
34
  # body: { query: { match: { title: 'test' } }, sort: '_id' }
18
35
  #
19
- # result = client.scroll scroll: '5m', body: { scroll_id: result['_scroll_id'] }
36
+ # result = client.scroll body: { scroll_id: result['_scroll_id'], scroll: '5m' }
20
37
  #
21
38
  # @example Call the `scroll` API until all the documents are returned
22
39
  #
@@ -42,8 +59,9 @@ module Elasticsearch
42
59
  #
43
60
  # @option arguments [String] :scroll_id The scroll ID
44
61
  # @option arguments [Hash] :body The scroll ID if not passed by URL or query parameter.
45
- # @option arguments [Duration] :scroll Specify how long a consistent view of the index
46
- # should be maintained for scrolled search
62
+ # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
63
+ # @option arguments [String] :scroll_id The scroll ID for scrolled search
64
+ # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
47
65
  #
48
66
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/scan-scroll.html#scan-scroll
49
67
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
@@ -51,15 +69,19 @@ module Elasticsearch
51
69
  def scroll(arguments={})
52
70
  method = HTTP_GET
53
71
  path = "_search/scroll"
54
- valid_params = [
55
- :scroll,
56
- :scroll_id ]
57
-
58
- params = Utils.__validate_and_extract_params arguments, valid_params
72
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
59
73
  body = arguments[:body]
60
74
 
61
75
  perform_request(method, path, params, body).body
62
76
  end
77
+
78
+ # Register this action with its valid params when the module is loaded.
79
+ #
80
+ # @since 6.1.1
81
+ ParamsRegistry.register(:scroll, [
82
+ :scroll,
83
+ :scroll_id,
84
+ :rest_total_hits_as_int ].freeze)
63
85
  end
64
86
  end
65
87
  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
@@ -82,6 +99,7 @@ module Elasticsearch
82
99
  # representation of a field for each hit
83
100
  # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
84
101
  # @option arguments [Number] :from Starting offset (default: 0)
102
+ # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
85
103
  # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
86
104
  # (options: none, missing)
87
105
  # @option arguments [Boolean] :lenient Specify whether format-based query failures
@@ -126,14 +144,33 @@ module Elasticsearch
126
144
  #
127
145
  def search(arguments={})
128
146
  arguments[:index] = UNDERSCORE_ALL if ! arguments[:index] && arguments[:type]
147
+ method = HTTP_GET
148
+ path = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )
149
+
150
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
151
+
152
+ body = arguments[:body]
153
+
154
+ params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
155
+ params[:fielddata_fields] = Utils.__listify(params[:fielddata_fields], :escape => false) if params[:fielddata_fields]
156
+
157
+ # FIX: Unescape the `filter_path` parameter due to __listify default behavior. Investigate.
158
+ params[:filter_path] = defined?(EscapeUtils) ? EscapeUtils.unescape_url(params[:filter_path]) : CGI.unescape(params[:filter_path]) if params[:filter_path]
129
159
 
130
- valid_params = [
160
+ perform_request(method, path, params, body).body
161
+ end
162
+
163
+ # Register this action with its valid params when the module is loaded.
164
+ #
165
+ # @since 6.1.1
166
+ ParamsRegistry.register(:search, [
131
167
  :analyzer,
132
168
  :analyze_wildcard,
133
169
  :default_operator,
134
170
  :df,
135
171
  :explain,
136
172
  :fielddata_fields,
173
+ :include_type_name,
137
174
  :docvalue_fields,
138
175
  :stored_fields,
139
176
  :fields,
@@ -155,8 +192,8 @@ module Elasticsearch
155
192
  :sort,
156
193
  :source,
157
194
  :_source,
158
- :_source_include,
159
- :_source_exclude,
195
+ :_source_includes,
196
+ :_source_excludes,
160
197
  :stored_fields,
161
198
  :stats,
162
199
  :suggest_field,
@@ -169,23 +206,12 @@ module Elasticsearch
169
206
  :version,
170
207
  :batched_reduce_size,
171
208
  :max_concurrent_shard_requests,
172
- :pre_filter_shard_size ]
173
-
174
- method = HTTP_GET
175
- path = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )
176
-
177
- params = Utils.__validate_and_extract_params arguments, valid_params
178
-
179
- body = arguments[:body]
180
-
181
- params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
182
- params[:fielddata_fields] = Utils.__listify(params[:fielddata_fields], :escape => false) if params[:fielddata_fields]
183
-
184
- # FIX: Unescape the `filter_path` parameter due to __listify default behavior. Investigate.
185
- params[:filter_path] = defined?(EscapeUtils) ? EscapeUtils.unescape_url(params[:filter_path]) : CGI.unescape(params[:filter_path]) if params[:filter_path]
186
-
187
- perform_request(method, path, params, body).body
188
- end
209
+ :pre_filter_shard_size,
210
+ :allow_partial_search_results,
211
+ :rest_total_hits_as_int,
212
+ :track_total_hits,
213
+ :ignore_throttled,
214
+ :seq_no_primary_term ].freeze)
189
215
  end
190
216
  end
191
217
  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
@@ -22,20 +39,24 @@ module Elasticsearch
22
39
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html
23
40
  #
24
41
  def search_shards(arguments={})
25
- valid_params = [
26
- :preference,
27
- :routing,
28
- :local,
29
- :ignore_unavailable,
30
- :allow_no_indices,
31
- :expand_wildcards ]
32
42
  method = HTTP_GET
33
43
  path = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search_shards' )
34
- params = Utils.__validate_and_extract_params arguments, valid_params
44
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
35
45
  body = nil
36
46
 
37
47
  perform_request(method, path, params, body).body
38
48
  end
49
+
50
+ # Register this action with its valid params when the module is loaded.
51
+ #
52
+ # @since 6.1.1
53
+ ParamsRegistry.register(:search_shards, [
54
+ :preference,
55
+ :routing,
56
+ :local,
57
+ :ignore_unavailable,
58
+ :allow_no_indices,
59
+ :expand_wildcards ].freeze)
39
60
  end
40
61
  end
41
62
  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
@@ -18,44 +35,51 @@ module Elasticsearch
18
35
  # params: { start: "2014-02-01", end: "2014-03-01" }
19
36
  # }
20
37
  #
21
- # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty
22
- # string to perform the operation on all indices
23
- # @option arguments [List] :type A comma-separated list of document types to search;
24
- # leave empty to perform the operation on all types
25
- # @option arguments [Hash] :body The search definition template and its params
26
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored
27
- # when unavailable (missing or closed)
28
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
29
- # no concrete indices. (This includes `_all` string or when no
30
- # indices have been specified)
31
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
32
- # that are open, closed or both. (options: open, closed)
33
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on
34
- # (default: random)
38
+ # @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
39
+ # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
40
+ # @option arguments [Hash] :body The search definition template and its params (*Required*)
41
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
42
+ # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
43
+ # @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)
44
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
45
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
35
46
  # @option arguments [List] :routing A comma-separated list of specific routing values
36
- # @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained
37
- # for scrolled search
38
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch,
39
- # dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
47
+ # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
48
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
49
+ # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
50
+ # @option arguments [Boolean] :profile Specify whether to profile the query execution
51
+ # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
52
+ # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
53
+ # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
40
54
  #
41
55
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html
42
56
  #
43
57
  def search_template(arguments={})
44
- valid_params = [
45
- :ignore_unavailable,
46
- :allow_no_indices,
47
- :expand_wildcards,
48
- :preference,
49
- :routing,
50
- :scroll,
51
- :search_type ]
52
58
  method = HTTP_GET
53
59
  path = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search/template' )
54
- params = Utils.__validate_and_extract_params arguments, valid_params
60
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
55
61
  body = arguments[:body]
56
62
 
57
63
  perform_request(method, path, params, body).body
58
64
  end
65
+
66
+ # Register this action with its valid params when the module is loaded.
67
+ #
68
+ # @since 6.1.1
69
+ ParamsRegistry.register(:search_template, [
70
+ :ignore_unavailable,
71
+ :ignore_throttled,
72
+ :allow_no_indices,
73
+ :expand_wildcards,
74
+ :preference,
75
+ :routing,
76
+ :scroll,
77
+ :search_type,
78
+ :explain,
79
+ :profile,
80
+ :typed_keys,
81
+ :rest_total_hits_as_int,
82
+ :ccs_minimize_roundtrips ].freeze)
59
83
  end
60
84
  end
61
85
  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 Snapshot
@@ -27,21 +44,24 @@ module Elasticsearch
27
44
  def create(arguments={})
28
45
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
29
46
  raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
30
- valid_params = [
31
- :master_timeout,
32
- :wait_for_completion ]
33
-
34
47
  repository = arguments.delete(:repository)
35
48
  snapshot = arguments.delete(:snapshot)
36
49
 
37
50
  method = HTTP_PUT
38
51
  path = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot) )
39
52
 
40
- params = Utils.__validate_and_extract_params arguments, valid_params
53
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
41
54
  body = arguments[:body]
42
55
 
43
56
  perform_request(method, path, params, body).body
44
57
  end
58
+
59
+ # Register this action with its valid params when the module is loaded.
60
+ #
61
+ # @since 6.1.1
62
+ ParamsRegistry.register(:create, [
63
+ :master_timeout,
64
+ :wait_for_completion ].freeze)
45
65
  end
46
66
  end
47
67
  end