elasticsearch-api 6.2.0 → 6.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/abort_benchmark.rb +1 -1
  3. data/lib/elasticsearch/api/actions/benchmark.rb +1 -1
  4. data/lib/elasticsearch/api/actions/bulk.rb +4 -6
  5. data/lib/elasticsearch/api/actions/cat/aliases.rb +10 -10
  6. data/lib/elasticsearch/api/actions/cat/allocation.rb +11 -11
  7. data/lib/elasticsearch/api/actions/cat/count.rb +10 -10
  8. data/lib/elasticsearch/api/actions/cat/fielddata.rb +9 -7
  9. data/lib/elasticsearch/api/actions/cat/health.rb +11 -11
  10. data/lib/elasticsearch/api/actions/cat/help.rb +4 -2
  11. data/lib/elasticsearch/api/actions/cat/indices.rb +14 -15
  12. data/lib/elasticsearch/api/actions/cat/master.rb +10 -10
  13. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +6 -4
  14. data/lib/elasticsearch/api/actions/cat/nodes.rb +10 -10
  15. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +10 -10
  16. data/lib/elasticsearch/api/actions/cat/plugins.rb +7 -6
  17. data/lib/elasticsearch/api/actions/cat/recovery.rb +10 -12
  18. data/lib/elasticsearch/api/actions/cat/repositories.rb +7 -3
  19. data/lib/elasticsearch/api/actions/cat/segments.rb +9 -7
  20. data/lib/elasticsearch/api/actions/cat/shards.rb +12 -12
  21. data/lib/elasticsearch/api/actions/cat/snapshots.rb +8 -4
  22. data/lib/elasticsearch/api/actions/cat/tasks.rb +4 -6
  23. data/lib/elasticsearch/api/actions/cat/templates.rb +6 -6
  24. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +13 -17
  25. data/lib/elasticsearch/api/actions/clear_scroll.rb +7 -0
  26. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +2 -3
  27. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +5 -2
  28. data/lib/elasticsearch/api/actions/cluster/health.rb +11 -20
  29. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +2 -3
  30. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +8 -3
  31. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +7 -1
  32. data/lib/elasticsearch/api/actions/cluster/reroute.rb +7 -7
  33. data/lib/elasticsearch/api/actions/cluster/state.rb +18 -15
  34. data/lib/elasticsearch/api/actions/cluster/stats.rb +12 -5
  35. data/lib/elasticsearch/api/actions/count.rb +12 -23
  36. data/lib/elasticsearch/api/actions/count_percolate.rb +1 -1
  37. data/lib/elasticsearch/api/actions/delete.rb +16 -8
  38. data/lib/elasticsearch/api/actions/delete_by_query.rb +7 -9
  39. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +29 -0
  40. data/lib/elasticsearch/api/actions/delete_script.rb +5 -6
  41. data/lib/elasticsearch/api/actions/exists.rb +3 -4
  42. data/lib/elasticsearch/api/actions/exists_source.rb +51 -0
  43. data/lib/elasticsearch/api/actions/explain.rb +11 -25
  44. data/lib/elasticsearch/api/actions/field_caps.rb +2 -2
  45. data/lib/elasticsearch/api/actions/get.rb +13 -19
  46. data/lib/elasticsearch/api/actions/get_script.rb +9 -2
  47. data/lib/elasticsearch/api/actions/get_source.rb +10 -14
  48. data/lib/elasticsearch/api/actions/index.rb +10 -16
  49. data/lib/elasticsearch/api/actions/indices/analyze.rb +3 -27
  50. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +2 -4
  51. data/lib/elasticsearch/api/actions/indices/close.rb +9 -15
  52. data/lib/elasticsearch/api/actions/indices/create.rb +7 -7
  53. data/lib/elasticsearch/api/actions/indices/delete.rb +3 -4
  54. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +7 -4
  55. data/lib/elasticsearch/api/actions/indices/delete_template.rb +5 -2
  56. data/lib/elasticsearch/api/actions/indices/exists.rb +11 -17
  57. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +6 -14
  58. data/lib/elasticsearch/api/actions/indices/exists_template.rb +8 -4
  59. data/lib/elasticsearch/api/actions/indices/exists_type.rb +6 -15
  60. data/lib/elasticsearch/api/actions/indices/flush.rb +5 -9
  61. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +1 -1
  62. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +13 -11
  63. data/lib/elasticsearch/api/actions/indices/freeze.rb +0 -1
  64. data/lib/elasticsearch/api/actions/indices/get.rb +9 -15
  65. data/lib/elasticsearch/api/actions/indices/get_alias.rb +6 -14
  66. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +11 -15
  67. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +12 -16
  68. data/lib/elasticsearch/api/actions/indices/get_settings.rb +12 -21
  69. data/lib/elasticsearch/api/actions/indices/get_template.rb +8 -5
  70. data/lib/elasticsearch/api/actions/indices/open.rb +9 -15
  71. data/lib/elasticsearch/api/actions/indices/put_alias.rb +6 -3
  72. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +11 -23
  73. data/lib/elasticsearch/api/actions/indices/put_settings.rb +10 -20
  74. data/lib/elasticsearch/api/actions/indices/put_template.rb +10 -5
  75. data/lib/elasticsearch/api/actions/indices/recovery.rb +2 -4
  76. data/lib/elasticsearch/api/actions/indices/refresh.rb +6 -14
  77. data/lib/elasticsearch/api/actions/indices/rollover.rb +6 -5
  78. data/lib/elasticsearch/api/actions/indices/segments.rb +6 -14
  79. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +2 -4
  80. data/lib/elasticsearch/api/actions/indices/shrink.rb +6 -7
  81. data/lib/elasticsearch/api/actions/indices/split.rb +2 -1
  82. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +7 -4
  83. data/lib/elasticsearch/api/actions/indices/upgrade.rb +10 -13
  84. data/lib/elasticsearch/api/actions/indices/validate_query.rb +14 -25
  85. data/lib/elasticsearch/api/actions/info.rb +6 -0
  86. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  87. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +4 -3
  88. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +29 -0
  89. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
  90. data/lib/elasticsearch/api/actions/ingest/simulate.rb +5 -5
  91. data/lib/elasticsearch/api/actions/mget.rb +8 -17
  92. data/lib/elasticsearch/api/actions/msearch.rb +7 -2
  93. data/lib/elasticsearch/api/actions/msearch_template.rb +8 -1
  94. data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -22
  95. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +4 -6
  96. data/lib/elasticsearch/api/actions/nodes/info.rb +6 -26
  97. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +10 -4
  98. data/lib/elasticsearch/api/actions/nodes/stats.rb +11 -30
  99. data/lib/elasticsearch/api/actions/nodes/usage.rb +31 -0
  100. data/lib/elasticsearch/api/actions/ping.rb +6 -0
  101. data/lib/elasticsearch/api/actions/put_script.rb +10 -9
  102. data/lib/elasticsearch/api/actions/rank_eval.rb +36 -0
  103. data/lib/elasticsearch/api/actions/reindex.rb +9 -14
  104. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +29 -0
  105. data/lib/elasticsearch/api/actions/render_search_template.rb +1 -1
  106. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +27 -0
  107. data/lib/elasticsearch/api/actions/scroll.rb +3 -2
  108. data/lib/elasticsearch/api/actions/search.rb +36 -53
  109. data/lib/elasticsearch/api/actions/search_shards.rb +7 -14
  110. data/lib/elasticsearch/api/actions/search_template.rb +20 -19
  111. data/lib/elasticsearch/api/actions/snapshot/create.rb +2 -3
  112. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +4 -3
  113. data/lib/elasticsearch/api/actions/snapshot/delete.rb +3 -3
  114. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -2
  115. data/lib/elasticsearch/api/actions/snapshot/get.rb +3 -3
  116. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +3 -6
  117. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  118. data/lib/elasticsearch/api/actions/snapshot/status.rb +4 -5
  119. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -2
  120. data/lib/elasticsearch/api/actions/tasks/cancel.rb +7 -13
  121. data/lib/elasticsearch/api/actions/tasks/get.rb +6 -3
  122. data/lib/elasticsearch/api/actions/tasks/list.rb +10 -16
  123. data/lib/elasticsearch/api/actions/termvectors.rb +22 -21
  124. data/lib/elasticsearch/api/actions/update.rb +19 -33
  125. data/lib/elasticsearch/api/actions/update_by_query.rb +13 -33
  126. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +29 -0
  127. data/lib/elasticsearch/api/version.rb +1 -1
  128. data/spec/elasticsearch/api/actions/cluster/state_spec.rb +0 -17
  129. data/spec/elasticsearch/api/actions/cluster/stats_spec.rb +17 -0
  130. data/spec/elasticsearch/api/actions/indices/analyze_spec.rb +0 -37
  131. data/spec/elasticsearch/api/actions/indices/put_settings_spec.rb +0 -15
  132. data/spec/elasticsearch/api/actions/indices/refresh_spec.rb +0 -15
  133. data/spec/elasticsearch/api/actions/indices/segments_spec.rb +0 -15
  134. data/spec/elasticsearch/api/actions/mget_spec.rb +0 -15
  135. data/spec/elasticsearch/api/actions/search_spec.rb +0 -15
  136. data/test/integration/yaml_test_runner.rb +2 -4
  137. data/utils/thor/generate_source.rb +1 -0
  138. data/utils/thor/templates/ruby/method.erb +7 -5
  139. metadata +12 -73
  140. data/lib/elasticsearch/api/actions/delete_template.rb +0 -21
  141. data/lib/elasticsearch/api/actions/field_stats.rb +0 -36
  142. data/lib/elasticsearch/api/actions/get_template.rb +0 -27
  143. data/lib/elasticsearch/api/actions/indices/delete_mapping.rb +0 -26
  144. data/lib/elasticsearch/api/actions/indices/delete_warmer.rb +0 -32
  145. data/lib/elasticsearch/api/actions/indices/get_aliases.rb +0 -37
  146. data/lib/elasticsearch/api/actions/indices/get_warmer.rb +0 -62
  147. data/lib/elasticsearch/api/actions/indices/optimize.rb +0 -77
  148. data/lib/elasticsearch/api/actions/indices/put_warmer.rb +0 -65
  149. data/lib/elasticsearch/api/actions/indices/seal.rb +0 -24
  150. data/lib/elasticsearch/api/actions/indices/snapshot_index.rb +0 -44
  151. data/lib/elasticsearch/api/actions/indices/status.rb +0 -63
  152. data/lib/elasticsearch/api/actions/list_benchmarks.rb +0 -27
  153. data/lib/elasticsearch/api/actions/mlt.rb +0 -130
  154. data/lib/elasticsearch/api/actions/mpercolate.rb +0 -62
  155. data/lib/elasticsearch/api/actions/nodes/shutdown.rb +0 -39
  156. data/lib/elasticsearch/api/actions/percolate.rb +0 -73
  157. data/lib/elasticsearch/api/actions/put_template.rb +0 -25
  158. data/lib/elasticsearch/api/actions/remote/info.rb +0 -21
  159. data/lib/elasticsearch/api/actions/search_exists.rb +0 -63
  160. data/lib/elasticsearch/api/actions/suggest.rb +0 -49
  161. data/spec/elasticsearch/api/actions/delete_template_spec.rb +0 -17
  162. data/spec/elasticsearch/api/actions/field_stats_spec.rb +0 -17
  163. data/spec/elasticsearch/api/actions/get_template_spec.rb +0 -52
  164. data/spec/elasticsearch/api/actions/indices/delete_mapping_spec.rb +0 -77
  165. data/spec/elasticsearch/api/actions/indices/delete_warmer_spec.rb +0 -86
  166. data/spec/elasticsearch/api/actions/indices/freeze_spec.rb +0 -68
  167. data/spec/elasticsearch/api/actions/indices/get_aliases_spec.rb +0 -55
  168. data/spec/elasticsearch/api/actions/indices/get_warmer_spec.rb +0 -48
  169. data/spec/elasticsearch/api/actions/indices/optimize_spec.rb +0 -63
  170. data/spec/elasticsearch/api/actions/indices/put_warmer_spec.rb +0 -101
  171. data/spec/elasticsearch/api/actions/indices/seal_spec.rb +0 -18
  172. data/spec/elasticsearch/api/actions/indices/snapshot_index_spec.rb +0 -89
  173. data/spec/elasticsearch/api/actions/indices/stats_spec.rb +0 -108
  174. data/spec/elasticsearch/api/actions/indices/status_spec.rb +0 -92
  175. data/spec/elasticsearch/api/actions/indices/unfreeze_spec.rb +0 -68
  176. data/spec/elasticsearch/api/actions/list_benchmarks_spec.rb +0 -17
  177. data/spec/elasticsearch/api/actions/mlt_spec.rb +0 -117
  178. data/spec/elasticsearch/api/actions/mpercolate_spec.rb +0 -49
  179. data/spec/elasticsearch/api/actions/nodes/shutdown_spec.rb +0 -59
  180. data/spec/elasticsearch/api/actions/percolate_spec.rb +0 -67
  181. data/spec/elasticsearch/api/actions/put_template_spec.rb +0 -17
  182. data/spec/elasticsearch/api/actions/remote/info_spec.rb +0 -18
  183. data/spec/elasticsearch/api/actions/search_exists_spec.rb +0 -17
  184. data/spec/elasticsearch/api/actions/suggest_spec.rb +0 -77
@@ -21,25 +21,17 @@ module Elasticsearch
21
21
  #
22
22
  # client.indices.get_settings index: 'myindex'
23
23
  #
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
24
+ # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
25
+ # @option arguments [List] :name The name of the settings that should be included
26
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
27
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
28
+ # @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)
29
+ # @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
30
  # @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)
31
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
32
+ # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
41
33
  #
42
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/
34
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
43
35
  #
44
36
  def get_settings(arguments={})
45
37
  method = HTTP_GET
@@ -58,14 +50,13 @@ module Elasticsearch
58
50
  #
59
51
  # @since 6.2.0
60
52
  ParamsRegistry.register(:get_settings, [
61
- :prefix,
62
- :ignore_indices,
53
+ :master_timeout,
63
54
  :ignore_unavailable,
64
- :include_defaults,
65
55
  :allow_no_indices,
66
56
  :expand_wildcards,
67
57
  :flat_settings,
68
- :local ].freeze)
58
+ :local,
59
+ :include_defaults ].freeze)
69
60
  end
70
61
  end
71
62
  end
@@ -15,13 +15,12 @@ module Elasticsearch
15
15
  #
16
16
  # @note Use the {Cluster::Actions#state} API to get a list of all templates.
17
17
  #
18
- # @option arguments [String] :name The name of the template (supports wildcards)
18
+ # @option arguments [List] :name The comma separated names of the index templates
19
19
  # @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
20
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
21
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
23
22
  #
24
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
23
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
25
24
  #
26
25
  def get_template(arguments={})
27
26
  method = HTTP_GET
@@ -36,7 +35,11 @@ module Elasticsearch
36
35
  # Register this action with its valid params when the module is loaded.
37
36
  #
38
37
  # @since 6.2.0
39
- ParamsRegistry.register(:get_template, [ :flat_settings, :local, :master_timeout ].freeze)
38
+ ParamsRegistry.register(:get_template, [
39
+ :flat_settings,
40
+ :master_timeout,
41
+ :local,
42
+ :include_type_name ].freeze)
40
43
  end
41
44
  end
42
45
  end
@@ -9,21 +9,15 @@ module Elasticsearch
9
9
  #
10
10
  # client.indices.open index: 'myindex'
11
11
  #
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)
12
+ # @option arguments [List] :index A comma separated list of indices to open (*Required*)
23
13
  # @option arguments [Time] :timeout Explicit operation timeout
24
- # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
14
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
15
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
16
+ # @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)
17
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
18
+ # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
25
19
  #
26
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
20
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
27
21
  #
28
22
  def open(arguments={})
29
23
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -40,11 +34,11 @@ module Elasticsearch
40
34
  #
41
35
  # @since 6.2.0
42
36
  ParamsRegistry.register(:open, [
43
- :ignore_indices,
37
+ :timeout,
38
+ :master_timeout,
44
39
  :ignore_unavailable,
45
40
  :allow_no_indices,
46
41
  :expand_wildcards,
47
- :timeout,
48
42
  :wait_for_active_shards ].freeze)
49
43
  end
50
44
  end
@@ -16,12 +16,13 @@ module Elasticsearch
16
16
  #
17
17
  # See the {Indices::Actions#update_aliases} for performing operations with index aliases in bulk.
18
18
  #
19
- # @option arguments [String] :index The name of the index with an alias (*Required*)
19
+ # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. (*Required*)
20
20
  # @option arguments [String] :name The name of the alias to be created or updated (*Required*)
21
21
  # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
22
22
  # @option arguments [Time] :timeout Explicit timestamp for the document
23
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
23
24
  #
24
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
25
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
25
26
  #
26
27
  def put_alias(arguments={})
27
28
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -38,7 +39,9 @@ module Elasticsearch
38
39
  # Register this action with its valid params when the module is loaded.
39
40
  #
40
41
  # @since 6.2.0
41
- ParamsRegistry.register(:put_alias, [ :timeout ].freeze)
42
+ ParamsRegistry.register(:put_alias, [
43
+ :timeout,
44
+ :master_timeout ].freeze)
42
45
  end
43
46
  end
44
47
  end
@@ -25,30 +25,19 @@ module Elasticsearch
25
25
  # }
26
26
  # }
27
27
  #
28
- # @option arguments [Hash] :body The mapping definition (*Required*)
29
- # @option arguments [List] :index A comma-separated list of index names; use `_all` or omit to
30
- # update the mapping for all indices
28
+ # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
31
29
  # @option arguments [String] :type The name of the document type (*Required*)
32
- # @option arguments [Boolean] :ignore_conflicts Specify whether to ignore conflicts while updating the mapping
33
- # (default: false)
34
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
35
- # no concrete indices. (This includes `_all` string or when no
36
- # indices have been specified)
37
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
38
- # are open, closed or both. (options: open, closed)
39
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
40
- # `missing` ones (options: none, missing) @until 1.0
41
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
42
- # unavailable (missing, closed, etc)
43
- # @option arguments [Boolean] :update_all_types Whether to update the mapping for all fields
44
- # with the same name across all types
30
+ # @option arguments [Hash] :body The mapping definition (*Required*)
45
31
  # @option arguments [Time] :timeout Explicit operation timeout
46
- # @option arguments [Boolean] :master_timeout Timeout for connection to master
32
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
33
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
34
+ # @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)
35
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
36
+ # @option arguments [Boolean] :update_all_types Whether to update the mapping for all fields with the same name across all types or not
47
37
  #
48
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/
38
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html
49
39
  #
50
40
  def put_mapping(arguments={})
51
- raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
52
41
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
53
42
  method = HTTP_PUT
54
43
  path = Utils.__pathify Utils.__listify(arguments[:index]), '_mapping', Utils.__escape(arguments[:type])
@@ -63,14 +52,13 @@ module Elasticsearch
63
52
  #
64
53
  # @since 6.2.0
65
54
  ParamsRegistry.register(:put_mapping, [
66
- :ignore_conflicts,
67
- :ignore_indices,
55
+ :timeout,
56
+ :master_timeout,
68
57
  :ignore_unavailable,
69
58
  :allow_no_indices,
70
59
  :expand_wildcards,
71
60
  :update_all_types,
72
- :master_timeout,
73
- :timeout ].freeze)
61
+ :include_type_name ].freeze)
74
62
  end
75
63
  end
76
64
  end
@@ -24,26 +24,17 @@ module Elasticsearch
24
24
  # client.indices.put_settings index: 'my-big-index',
25
25
  # body: { 'index.routing.allocation.require.tag' => 'bigbox' }
26
26
  #
27
+ # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
27
28
  # @option arguments [Hash] :body The index settings to be updated (*Required*)
28
- # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
29
- # to perform the operation on all indices
30
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
31
- # no concrete indices. (This includes `_all` string or when no
32
- # indices have been specified)
33
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
34
- # are open, closed or both. (options: open, closed)
35
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
36
- # `missing` ones (options: none, missing) @until 1.0
37
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
38
- # unavailable (missing, closed, etc)
39
- # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
40
- # @option arguments [Boolean] :preserve_existing Whether to update existing settings.
41
- # If set to `true` existing settings on an index remain
42
- # unchanged, the default is `false`
43
29
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
30
+ # @option arguments [Time] :timeout Explicit operation timeout
31
+ # @option arguments [Boolean] :preserve_existing Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
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)
44
35
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
45
36
  #
46
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
37
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
47
38
  #
48
39
  def put_settings(arguments={})
49
40
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -59,13 +50,12 @@ module Elasticsearch
59
50
  #
60
51
  # @since 6.2.0
61
52
  ParamsRegistry.register(:put_settings, [
62
- :ignore_indices,
53
+ :master_timeout,
54
+ :timeout,
55
+ :preserve_existing,
63
56
  :ignore_unavailable,
64
- :include_defaults,
65
57
  :allow_no_indices,
66
58
  :expand_wildcards,
67
- :preserve_existing,
68
- :master_timeout,
69
59
  :flat_settings ].freeze)
70
60
  end
71
61
  end
@@ -12,14 +12,13 @@ module Elasticsearch
12
12
  #
13
13
  # @option arguments [String] :name The name of the template (*Required*)
14
14
  # @option arguments [Hash] :body The template definition (*Required*)
15
- # @option arguments [Boolean] :create Whether the index template should only be added for a new one, # or can also replace an existing one (default: false)
16
- # @option arguments [Number] :order The order for this template when merging multiple matching ones
17
- # (higher numbers are merged later, overriding the lower numbers)
15
+ # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
16
+ # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
18
17
  # @option arguments [Time] :timeout Explicit operation timeout
19
18
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
20
19
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
21
20
  #
22
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
21
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
23
22
  #
24
23
  def put_template(arguments={})
25
24
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -36,7 +35,13 @@ module Elasticsearch
36
35
  # Register this action with its valid params when the module is loaded.
37
36
  #
38
37
  # @since 6.2.0
39
- ParamsRegistry.register(:put_template, [ :create, :order, :timeout ].freeze)
38
+ ParamsRegistry.register(:put_template, [
39
+ :order,
40
+ :create,
41
+ :timeout,
42
+ :master_timeout,
43
+ :flat_settings,
44
+ :include_type_name ].freeze)
40
45
  end
41
46
  end
42
47
  end
@@ -20,9 +20,8 @@ module Elasticsearch
20
20
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
21
21
  # @option arguments [Boolean] :detailed Whether to display detailed information about shard recovery
22
22
  # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
23
- # @option arguments [Boolean] :human Whether to return time and byte values in human readable format
24
23
  #
25
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html
24
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html
26
25
  #
27
26
  def recovery(arguments={})
28
27
  method = HTTP_GET
@@ -38,8 +37,7 @@ module Elasticsearch
38
37
  # @since 6.2.0
39
38
  ParamsRegistry.register(:recovery, [
40
39
  :detailed,
41
- :active_only,
42
- :human ].freeze)
40
+ :active_only ].freeze)
43
41
  end
44
42
  end
45
43
  end
@@ -18,19 +18,12 @@ module Elasticsearch
18
18
  #
19
19
  # @note The refresh operation can adversely affect indexing throughput when used too frequently.
20
20
  #
21
- # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
22
- # to perform the operation on all indices
23
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
24
- # no concrete indices. (This includes `_all` string or when no
25
- # indices have been specified)
26
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
27
- # are open, closed or both. (options: open, closed)
28
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
29
- # `missing` ones (options: none, missing) @until 1.0
30
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
31
- # unavailable (missing, closed, etc)
32
- #
33
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh/
21
+ # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
22
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
23
+ # @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)
24
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
25
+ #
26
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
34
27
  #
35
28
  def refresh(arguments={})
36
29
  method = HTTP_POST
@@ -46,7 +39,6 @@ module Elasticsearch
46
39
  #
47
40
  # @since 6.2.0
48
41
  ParamsRegistry.register(:refresh, [
49
- :ignore_indices,
50
42
  :ignore_unavailable,
51
43
  :allow_no_indices,
52
44
  :expand_wildcards ].freeze)
@@ -9,12 +9,12 @@ module Elasticsearch
9
9
  # @option arguments [String] :alias The name of the alias to rollover (*Required*)
10
10
  # @option arguments [String] :new_index The name of the rollover index
11
11
  # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
12
- # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
13
12
  # @option arguments [Time] :timeout Explicit operation timeout
14
- # @option arguments [Time] :master_timeout Specify timeout for connection to master
15
13
  # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
14
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
15
+ # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
16
16
  #
17
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html
17
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html
18
18
  #
19
19
  def rollover(arguments={})
20
20
  raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
@@ -33,10 +33,11 @@ module Elasticsearch
33
33
  #
34
34
  # @since 6.2.0
35
35
  ParamsRegistry.register(:rollover, [
36
- :wait_for_active_shards,
37
36
  :timeout,
37
+ :dry_run,
38
38
  :master_timeout,
39
- :dry_run ].freeze)
39
+ :wait_for_active_shards,
40
+ :include_type_name ].freeze)
40
41
  end
41
42
  end
42
43
  end
@@ -8,20 +8,13 @@ module Elasticsearch
8
8
  # The response contains information about segment size, number of documents, deleted documents, etc.
9
9
  # See also {Indices::Actions#optimize}.
10
10
  #
11
- # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
12
- # to perform the operation on all indices
13
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression
14
- # resolves into no concrete indices. (This includes `_all`
15
- # string or when no indices have been specified)
16
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
17
- # that are open, closed or both. (options: open, closed)
18
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
19
- # `missing` ones (options: none, missing) @until 1.0
20
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
21
- # unavailable (missing, closed, etc)
22
- # @option arguments [Boolean] :verbose Whether to include detailed memory usage by Lucene (default: false)
11
+ # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
12
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
13
+ # @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)
14
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
15
+ # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene.
23
16
  #
24
- # @see http://elasticsearch.org/guide/reference/api/admin-indices-segments/
17
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html
25
18
  #
26
19
  def segments(arguments={})
27
20
  method = HTTP_GET
@@ -37,7 +30,6 @@ module Elasticsearch
37
30
  #
38
31
  # @since 6.2.0
39
32
  ParamsRegistry.register(:segments, [
40
- :ignore_indices,
41
33
  :ignore_unavailable,
42
34
  :allow_no_indices,
43
35
  :expand_wildcards,
@@ -10,9 +10,8 @@ module Elasticsearch
10
10
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
11
11
  # @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)
12
12
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
13
- # @option arguments [String] :operation_threading
14
13
  #
15
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html
14
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html
16
15
  #
17
16
  def shard_stores(arguments={})
18
17
  method = 'GET'
@@ -30,8 +29,7 @@ module Elasticsearch
30
29
  :status,
31
30
  :ignore_unavailable,
32
31
  :allow_no_indices,
33
- :expand_wildcards,
34
- :operation_threading ].freeze)
32
+ :expand_wildcards ].freeze)
35
33
  end
36
34
  end
37
35
  end
@@ -8,13 +8,12 @@ module Elasticsearch
8
8
  # @option arguments [String] :index The name of the source index to shrink (*Required*)
9
9
  # @option arguments [String] :target The name of the target index to shrink into (*Required*)
10
10
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
11
- # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
12
- # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating
13
- # shards in the cluster
11
+ # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
14
12
  # @option arguments [Time] :timeout Explicit operation timeout
15
13
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
14
+ # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
16
15
  #
17
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html
16
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shrink-index.html
18
17
  #
19
18
  def shrink(arguments={})
20
19
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -35,10 +34,10 @@ module Elasticsearch
35
34
  #
36
35
  # @since 6.2.0
37
36
  ParamsRegistry.register(:shrink, [
38
- :wait_for_active_shards,
39
- :wait_for_no_relocating_shards,
37
+ :copy_settings,
40
38
  :timeout,
41
- :master_timeout ].freeze)
39
+ :master_timeout,
40
+ :wait_for_active_shards ].freeze)
42
41
  end
43
42
  end
44
43
  end