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 Indices
@@ -6,44 +23,41 @@ module Elasticsearch
6
23
  # Retrieve information about one or more indices
7
24
  #
8
25
  # @option arguments [List] :index A comma-separated list of index names (*Required*)
9
- # @option arguments [List] :feature A comma-separated list of features
10
- # (options: _settings, _mappings, _aliases]
11
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
12
- # (default: false)
26
+ # @option arguments [Boolean] :include_type_name Whether to add the type name to the response (default: false)
27
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
13
28
  # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
14
- # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete
15
- # indices (default: false)
16
- # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded
17
- # to open or closed indices (default: open)
29
+ # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
30
+ # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, none, all)
18
31
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
19
- # @option arguments [Boolean] :human Whether to return version and creation date values in
20
- # human-readable format (default: false)
21
- # @option arguments [Boolean] :include_defaults Whether to return all default setting
22
- # for each of the indices (default:false)
32
+ # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
33
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
23
34
  #
24
35
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-index.html
25
36
  #
26
37
  def get(arguments={})
27
38
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
28
-
29
- valid_params = [
30
- :local,
31
- :ignore_unavailable,
32
- :allow_no_indices,
33
- :expand_wildcards,
34
- :flat_settings,
35
- :human,
36
- :include_defaults ]
37
-
38
39
  method = HTTP_GET
39
40
 
40
41
  path = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__listify(arguments.delete(:feature))
41
42
 
42
- params = Utils.__validate_and_extract_params arguments, valid_params
43
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
43
44
  body = nil
44
45
 
45
46
  perform_request(method, path, params, body).body
46
47
  end
48
+
49
+ # Register this action with its valid params when the module is loaded.
50
+ #
51
+ # @since 6.1.1
52
+ ParamsRegistry.register(:get, [
53
+ :include_type_name,
54
+ :local,
55
+ :ignore_unavailable,
56
+ :allow_no_indices,
57
+ :expand_wildcards,
58
+ :flat_settings,
59
+ :include_defaults,
60
+ :master_timeout ].freeze)
47
61
  end
48
62
  end
49
63
  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 Indices
@@ -15,37 +32,31 @@ module Elasticsearch
15
32
  #
16
33
  # @option arguments [List] :index A comma-separated list of index names to filter aliases
17
34
  # @option arguments [List] :name A comma-separated list of alias names to return
18
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
19
- # no concrete indices. (This includes `_all` string or when no
20
- # indices have been specified)
21
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
22
- # are open, closed or both. (options: open, closed)
23
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
24
- # `missing` ones (options: none, missing) @until 1.0
25
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
26
- # unavailable (missing, closed, etc)
27
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
28
- # (default: false)
35
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
36
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
37
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
38
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
29
39
  #
30
40
  # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
31
41
  #
32
42
  def get_alias(arguments={})
33
- valid_params = [
34
- :ignore_indices,
35
- :ignore_unavailable,
36
- :allow_no_indices,
37
- :expand_wildcards,
38
- :local
39
- ]
40
-
41
43
  method = HTTP_GET
42
44
  path = Utils.__pathify Utils.__listify(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
43
45
 
44
- params = Utils.__validate_and_extract_params arguments, valid_params
46
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
45
47
  body = nil
46
48
 
47
49
  perform_request(method, path, params, body).body
48
50
  end
51
+
52
+ # Register this action with its valid params when the module is loaded.
53
+ #
54
+ # @since 6.1.1
55
+ ParamsRegistry.register(:get_alias, [
56
+ :ignore_unavailable,
57
+ :allow_no_indices,
58
+ :expand_wildcards,
59
+ :local ].freeze)
49
60
  end
50
61
  end
51
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 Indices
@@ -18,35 +35,21 @@ module Elasticsearch
18
35
  # client.indices.get_field_mapping index: 'foo', field: ['bar', 'bam']
19
36
  #
20
37
  # @option arguments [List] :index A comma-separated list of index names
21
- # @option arguments [List] :type A comma-separated list of document types
22
- # @option arguments [List] :field A comma-separated list of fields (*Required*)
23
- # @option arguments [Boolean] :include_defaults Whether default mapping values should be returned as well
24
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
25
- # no concrete indices. (This includes `_all` string or when no
26
- # indices have been specified)
27
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
28
- # are open, closed or both. (options: open, closed)
29
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
30
- # `missing` ones (options: none, missing) @until 1.0
31
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
32
- # unavailable (missing, closed, etc)
38
+ # @option arguments [List] :type A comma-separated list of document types
39
+ # @option arguments [List] :fields A comma-separated list of fields (*Required*)
40
+ # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
41
+ # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well
42
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
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 [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
33
46
  #
34
47
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
35
48
  #
36
49
  def get_field_mapping(arguments={})
37
50
  arguments = arguments.clone
38
-
39
51
  fields = arguments.delete(:field) || arguments.delete(:fields)
40
52
  raise ArgumentError, "Required argument 'field' missing" unless fields
41
-
42
- valid_params = [
43
- :include_defaults,
44
- :ignore_indices,
45
- :ignore_unavailable,
46
- :allow_no_indices,
47
- :expand_wildcards
48
- ]
49
-
50
53
  method = HTTP_GET
51
54
  path = Utils.__pathify(
52
55
  Utils.__listify(arguments[:index]),
@@ -55,11 +58,22 @@ module Elasticsearch
55
58
  'field',
56
59
  Utils.__listify(fields)
57
60
  )
58
- params = Utils.__validate_and_extract_params arguments, valid_params
61
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
59
62
  body = nil
60
63
 
61
64
  perform_request(method, path, params, body).body
62
65
  end
66
+
67
+ # Register this action with its valid params when the module is loaded.
68
+ #
69
+ # @since 6.1.1
70
+ ParamsRegistry.register(:get_field_mapping, [
71
+ :include_type_name,
72
+ :include_defaults,
73
+ :ignore_unavailable,
74
+ :allow_no_indices,
75
+ :expand_wildcards,
76
+ :local ].freeze)
63
77
  end
64
78
  end
65
79
  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 Indices
@@ -17,40 +34,38 @@ module Elasticsearch
17
34
  #
18
35
  # client.indices.get_mapping index: 'foo', type: 'baz'
19
36
  #
20
- # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
37
+ # @option arguments [List] :index A comma-separated list of index names
21
38
  # @option arguments [List] :type A comma-separated list of document types
22
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
23
- # no concrete indices. (This includes `_all` string or when no
24
- # indices have been specified)
25
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
26
- # are open, closed or both. (options: open, closed)
27
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
28
- # `missing` ones (options: none, missing) @until 1.0
29
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
30
- # unavailable (missing, closed, etc)
31
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
32
- # (default: false)
39
+ # @option arguments [Boolean] :include_type_name Whether to add the type name to the response (default: false)
40
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
41
+ # @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)
42
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
43
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
44
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
33
45
  #
34
46
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html
35
47
  #
36
48
  def get_mapping(arguments={})
37
- valid_params = [
38
- :ignore_indices,
39
- :ignore_unavailable,
40
- :allow_no_indices,
41
- :expand_wildcards,
42
- :local
43
- ]
44
-
45
49
  method = HTTP_GET
46
50
  path = Utils.__pathify Utils.__listify(arguments[:index]),
47
51
  '_mapping',
48
52
  Utils.__listify(arguments[:type])
49
- params = Utils.__validate_and_extract_params arguments, valid_params
53
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
50
54
  body = nil
51
55
 
52
56
  perform_request(method, path, params, body).body
53
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(:get_mapping, [
63
+ :include_type_name,
64
+ :ignore_unavailable,
65
+ :allow_no_indices,
66
+ :expand_wildcards,
67
+ :master_timeout,
68
+ :local ].freeze)
54
69
  end
55
70
  end
56
71
  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 Indices
@@ -21,49 +38,42 @@ module Elasticsearch
21
38
  #
22
39
  # client.indices.get_settings index: 'myindex'
23
40
  #
24
- # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
25
- # to perform the operation on all indices
26
- # @option arguments [List] :name The name of the settings that should be included in the response
27
- # @option arguments [String] :prefix The prefix all settings must have in order to be included
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 that
32
- # are open, closed or both. (options: open, closed)
33
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
34
- # `missing` ones (options: none, missing) @until 1.0
35
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
36
- # unavailable (missing, closed, etc)
37
- # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
41
+ # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
42
+ # @option arguments [List] :name The name of the settings that should be included
43
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
44
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
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)
46
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
38
47
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
39
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
40
- # (default: false)
48
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
49
+ # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
41
50
  #
42
51
  # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/
43
52
  #
44
53
  def get_settings(arguments={})
45
- valid_params = [
46
- :prefix,
47
- :ignore_indices,
48
- :ignore_unavailable,
49
- :include_defaults,
50
- :allow_no_indices,
51
- :expand_wildcards,
52
- :flat_settings,
53
- :local
54
- ]
55
-
56
54
  method = HTTP_GET
57
55
  path = Utils.__pathify Utils.__listify(arguments[:index]),
58
56
  Utils.__listify(arguments[:type]),
59
57
  arguments.delete(:prefix),
60
58
  '_settings',
61
59
  Utils.__escape(arguments[:name])
62
- params = Utils.__validate_and_extract_params arguments, valid_params
60
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
63
61
  body = nil
64
62
 
65
63
  perform_request(method, path, params, body).body
66
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(:get_settings, [
70
+ :master_timeout,
71
+ :ignore_unavailable,
72
+ :allow_no_indices,
73
+ :expand_wildcards,
74
+ :flat_settings,
75
+ :local,
76
+ :include_defaults ].freeze)
67
77
  end
68
78
  end
69
79
  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 Indices
@@ -15,25 +32,32 @@ module Elasticsearch
15
32
  #
16
33
  # @note Use the {Cluster::Actions#state} API to get a list of all templates.
17
34
  #
18
- # @option arguments [String] :name The name of the template (supports wildcards)
35
+ # @option arguments [List] :name The comma separated names of the index templates
36
+ # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
19
37
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
20
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
21
- # (default: false)
22
38
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
39
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
23
40
  #
24
41
  # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
25
42
  #
26
43
  def get_template(arguments={})
27
- valid_params = [ :flat_settings, :local, :master_timeout ]
28
-
29
44
  method = HTTP_GET
30
45
  path = Utils.__pathify '_template', Utils.__escape(arguments[:name])
31
46
 
32
- params = Utils.__validate_and_extract_params arguments, valid_params
47
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
33
48
  body = arguments[:body]
34
49
 
35
50
  perform_request(method, path, params, body).body
36
51
  end
52
+
53
+ # Register this action with its valid params when the module is loaded.
54
+ #
55
+ # @since 6.1.1
56
+ ParamsRegistry.register(:get_template, [
57
+ :include_type_name,
58
+ :flat_settings,
59
+ :master_timeout,
60
+ :local ].freeze)
37
61
  end
38
62
  end
39
63
  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 Indices
@@ -9,40 +26,37 @@ module Elasticsearch
9
26
  #
10
27
  # client.indices.open index: 'myindex'
11
28
  #
12
- # @option arguments [List] :index A comma separated list of indices to perform the operation on
13
- # (*Required*)
14
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
15
- # no concrete indices. (This includes `_all` string or when no
16
- # indices have been specified)
17
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
18
- # are open, closed or both. (options: open, closed)
19
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
20
- # `missing` ones (options: none, missing) @until 1.0
21
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
22
- # unavailable (missing, closed, etc)
29
+ # @option arguments [List] :index A comma separated list of indices to open (*Required*)
23
30
  # @option arguments [Time] :timeout Explicit operation timeout
31
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
32
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
33
+ # @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)
34
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
35
+ # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
24
36
  #
25
37
  # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
26
38
  #
27
39
  def open(arguments={})
28
40
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
29
-
30
- valid_params = [
31
- :ignore_indices,
32
- :ignore_unavailable,
33
- :allow_no_indices,
34
- :expand_wildcards,
35
- :timeout
36
- ]
37
-
38
41
  method = HTTP_POST
39
42
  path = Utils.__pathify Utils.__escape(arguments[:index]), '_open'
40
43
 
41
- params = Utils.__validate_and_extract_params arguments, valid_params
44
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
42
45
  body = nil
43
46
 
44
47
  perform_request(method, path, params, body).body
45
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(:open, [
54
+ :timeout,
55
+ :master_timeout,
56
+ :ignore_unavailable,
57
+ :allow_no_indices,
58
+ :expand_wildcards,
59
+ :wait_for_active_shards ].freeze)
46
60
  end
47
61
  end
48
62
  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 Indices
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