elasticsearch-api 7.13.0 → 7.17.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (198) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +5 -5
  3. data/README.md +18 -39
  4. data/Rakefile +2 -16
  5. data/elasticsearch-api.gemspec +14 -8
  6. data/lib/elasticsearch/api/actions/bulk.rb +2 -2
  7. data/lib/elasticsearch/api/actions/cat/aliases.rb +1 -1
  8. data/lib/elasticsearch/api/actions/cat/allocation.rb +1 -1
  9. data/lib/elasticsearch/api/actions/cat/count.rb +1 -1
  10. data/lib/elasticsearch/api/actions/cat/fielddata.rb +1 -1
  11. data/lib/elasticsearch/api/actions/cat/health.rb +1 -1
  12. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  13. data/lib/elasticsearch/api/actions/cat/indices.rb +1 -1
  14. data/lib/elasticsearch/api/actions/cat/master.rb +1 -1
  15. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +1 -1
  16. data/lib/elasticsearch/api/actions/cat/nodes.rb +1 -1
  17. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +1 -1
  18. data/lib/elasticsearch/api/actions/cat/plugins.rb +1 -1
  19. data/lib/elasticsearch/api/actions/cat/recovery.rb +1 -1
  20. data/lib/elasticsearch/api/actions/cat/repositories.rb +1 -1
  21. data/lib/elasticsearch/api/actions/cat/segments.rb +1 -1
  22. data/lib/elasticsearch/api/actions/cat/shards.rb +1 -1
  23. data/lib/elasticsearch/api/actions/cat/snapshots.rb +1 -1
  24. data/lib/elasticsearch/api/actions/cat/tasks.rb +1 -1
  25. data/lib/elasticsearch/api/actions/cat/templates.rb +1 -1
  26. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +1 -1
  27. data/lib/elasticsearch/api/actions/clear_scroll.rb +1 -1
  28. data/lib/elasticsearch/api/actions/close_point_in_time.rb +1 -1
  29. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +3 -3
  30. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +1 -1
  31. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +1 -1
  32. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +2 -1
  33. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +1 -1
  34. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +1 -1
  35. data/lib/elasticsearch/api/actions/cluster/health.rb +1 -1
  36. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +1 -1
  37. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +1 -1
  38. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +1 -1
  39. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +1 -1
  40. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +1 -1
  41. data/lib/elasticsearch/api/actions/cluster/reroute.rb +1 -1
  42. data/lib/elasticsearch/api/actions/cluster/state.rb +1 -1
  43. data/lib/elasticsearch/api/actions/cluster/stats.rb +1 -1
  44. data/lib/elasticsearch/api/actions/count.rb +7 -2
  45. data/lib/elasticsearch/api/actions/create.rb +1 -1
  46. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
  47. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
  48. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +1 -1
  49. data/lib/elasticsearch/api/actions/delete.rb +1 -1
  50. data/lib/elasticsearch/api/actions/delete_by_query.rb +1 -7
  51. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +1 -1
  52. data/lib/elasticsearch/api/actions/delete_script.rb +1 -1
  53. data/lib/elasticsearch/api/actions/exists.rb +2 -1
  54. data/lib/elasticsearch/api/actions/exists_source.rb +2 -1
  55. data/lib/elasticsearch/api/actions/explain.rb +6 -6
  56. data/lib/elasticsearch/api/actions/features/get_features.rb +1 -1
  57. data/lib/elasticsearch/api/actions/features/reset_features.rb +1 -1
  58. data/lib/elasticsearch/api/actions/field_caps.rb +6 -6
  59. data/lib/elasticsearch/api/actions/get.rb +1 -1
  60. data/lib/elasticsearch/api/actions/get_script.rb +1 -1
  61. data/lib/elasticsearch/api/actions/get_script_context.rb +1 -5
  62. data/lib/elasticsearch/api/actions/get_script_languages.rb +1 -5
  63. data/lib/elasticsearch/api/actions/get_source.rb +1 -1
  64. data/lib/elasticsearch/api/actions/index.rb +1 -1
  65. data/lib/elasticsearch/api/actions/indices/add_block.rb +1 -1
  66. data/lib/elasticsearch/api/actions/indices/analyze.rb +6 -6
  67. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +1 -1
  68. data/lib/elasticsearch/api/actions/indices/clone.rb +1 -1
  69. data/lib/elasticsearch/api/actions/indices/close.rb +1 -1
  70. data/lib/elasticsearch/api/actions/indices/create.rb +1 -1
  71. data/lib/elasticsearch/api/actions/indices/delete.rb +2 -2
  72. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +1 -1
  73. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +6 -2
  74. data/lib/elasticsearch/api/actions/indices/delete_template.rb +1 -1
  75. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +68 -0
  76. data/lib/elasticsearch/api/actions/indices/exists.rb +2 -1
  77. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +2 -1
  78. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +6 -2
  79. data/lib/elasticsearch/api/actions/indices/exists_template.rb +2 -1
  80. data/lib/elasticsearch/api/actions/indices/exists_type.rb +2 -1
  81. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +66 -0
  82. data/lib/elasticsearch/api/actions/indices/flush.rb +1 -1
  83. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +1 -1
  84. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +1 -1
  85. data/lib/elasticsearch/api/actions/indices/get.rb +1 -1
  86. data/lib/elasticsearch/api/actions/indices/get_alias.rb +1 -1
  87. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +1 -1
  88. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +2 -2
  89. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +1 -1
  90. data/lib/elasticsearch/api/actions/indices/get_settings.rb +1 -1
  91. data/lib/elasticsearch/api/actions/indices/get_template.rb +1 -1
  92. data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +1 -1
  93. data/lib/elasticsearch/api/actions/indices/open.rb +1 -1
  94. data/lib/elasticsearch/api/actions/indices/put_alias.rb +1 -1
  95. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  96. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +1 -1
  97. data/lib/elasticsearch/api/actions/indices/put_settings.rb +1 -1
  98. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  99. data/lib/elasticsearch/api/actions/indices/recovery.rb +1 -1
  100. data/lib/elasticsearch/api/actions/indices/refresh.rb +1 -1
  101. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +1 -5
  102. data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
  103. data/lib/elasticsearch/api/actions/indices/segments.rb +1 -1
  104. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +1 -1
  105. data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -1
  106. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +1 -1
  107. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
  108. data/lib/elasticsearch/api/actions/indices/split.rb +1 -1
  109. data/lib/elasticsearch/api/actions/indices/stats.rb +1 -1
  110. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +1 -1
  111. data/lib/elasticsearch/api/actions/indices/upgrade.rb +1 -1
  112. data/lib/elasticsearch/api/actions/indices/validate_query.rb +8 -8
  113. data/lib/elasticsearch/api/actions/info.rb +1 -1
  114. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  115. data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +1 -1
  116. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
  117. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +1 -1
  118. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +3 -1
  119. data/lib/elasticsearch/api/actions/ingest/simulate.rb +1 -1
  120. data/lib/elasticsearch/api/actions/mget.rb +1 -1
  121. data/lib/elasticsearch/api/actions/msearch.rb +3 -3
  122. data/lib/elasticsearch/api/actions/msearch_template.rb +3 -3
  123. data/lib/elasticsearch/api/actions/mtermvectors.rb +8 -8
  124. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +56 -0
  125. data/lib/elasticsearch/api/actions/{snapshot/get_features.rb → nodes/get_repositories_metering_info.rb} +15 -14
  126. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +4 -2
  127. data/lib/elasticsearch/api/actions/nodes/info.rb +2 -2
  128. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +1 -1
  129. data/lib/elasticsearch/api/actions/nodes/stats.rb +2 -2
  130. data/lib/elasticsearch/api/actions/nodes/usage.rb +1 -1
  131. data/lib/elasticsearch/api/actions/open_point_in_time.rb +5 -7
  132. data/lib/elasticsearch/api/actions/ping.rb +3 -3
  133. data/lib/elasticsearch/api/actions/put_script.rb +1 -1
  134. data/lib/elasticsearch/api/actions/rank_eval.rb +1 -5
  135. data/lib/elasticsearch/api/actions/reindex.rb +1 -1
  136. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +1 -1
  137. data/lib/elasticsearch/api/actions/render_search_template.rb +6 -6
  138. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +2 -2
  139. data/lib/elasticsearch/api/actions/scroll.rb +6 -6
  140. data/lib/elasticsearch/api/actions/search.rb +8 -8
  141. data/lib/elasticsearch/api/actions/search_mvt.rb +85 -0
  142. data/lib/elasticsearch/api/actions/search_shards.rb +1 -1
  143. data/lib/elasticsearch/api/actions/search_template.rb +2 -2
  144. data/lib/elasticsearch/api/actions/shutdown/delete_node.rb +1 -5
  145. data/lib/elasticsearch/api/actions/shutdown/get_node.rb +1 -5
  146. data/lib/elasticsearch/api/actions/shutdown/put_node.rb +1 -5
  147. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +1 -1
  148. data/lib/elasticsearch/api/actions/snapshot/clone.rb +1 -1
  149. data/lib/elasticsearch/api/actions/snapshot/create.rb +1 -1
  150. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +1 -1
  151. data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
  152. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -1
  153. data/lib/elasticsearch/api/actions/snapshot/get.rb +17 -1
  154. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
  155. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +76 -0
  156. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  157. data/lib/elasticsearch/api/actions/snapshot/status.rb +1 -1
  158. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -1
  159. data/lib/elasticsearch/api/actions/tasks/cancel.rb +1 -1
  160. data/lib/elasticsearch/api/actions/tasks/get.rb +1 -1
  161. data/lib/elasticsearch/api/actions/tasks/list.rb +1 -1
  162. data/lib/elasticsearch/api/actions/termvectors.rb +11 -10
  163. data/lib/elasticsearch/api/actions/update.rb +1 -1
  164. data/lib/elasticsearch/api/actions/update_by_query.rb +1 -7
  165. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +1 -1
  166. data/lib/elasticsearch/api/{actions/remote/info.rb → namespace/security.rb} +12 -13
  167. data/lib/elasticsearch/api/utils.rb +7 -3
  168. data/lib/elasticsearch/api/version.rb +1 -1
  169. data/spec/elasticsearch/api/actions/count_spec.rb +2 -5
  170. data/spec/elasticsearch/api/actions/indices/clear_cache_spec.rb +16 -3
  171. data/spec/elasticsearch/api/actions/{abort_benchmark_spec.rb → indices/disk_usage_spec.rb} +19 -5
  172. data/spec/elasticsearch/api/actions/{benchmark_spec.rb → indices/field_usage_stats_spec.rb} +18 -6
  173. data/spec/elasticsearch/api/actions/nodes/clear_repositories_metering_archive_spec.rb +51 -0
  174. data/spec/elasticsearch/api/actions/{remote/info_spec.rb → nodes/get_repositories_metering_info_spec.rb} +17 -8
  175. data/spec/elasticsearch/api/actions/open_point_in_time_spec.rb +2 -12
  176. data/spec/elasticsearch/api/actions/search_mvt_spec.rb +52 -0
  177. data/spec/elasticsearch/api/actions/snapshot/{get_features_spec.rb → repository_analize_spec.rb} +15 -5
  178. data/spec/elasticsearch/api/rest_api_yaml_spec.rb +18 -6
  179. data/spec/elasticsearch/api/utils_spec.rb +9 -21
  180. data/spec/rest_yaml_tests_helper.rb +64 -10
  181. data/spec/spec_helper.rb +13 -2
  182. data/utils/README.md +6 -1
  183. data/utils/thor/.rubocop.yml +2 -0
  184. data/utils/thor/generate_source.rb +17 -11
  185. data/utils/thor/generator/endpoint_specifics.rb +3 -1
  186. data/utils/thor/generator/files_helper.rb +1 -1
  187. data/utils/thor/templates/_documentation_top.erb +19 -0
  188. data/utils/thor/templates/_method_setup.erb +18 -0
  189. data/utils/thor/templates/_params_registry.erb +19 -0
  190. data/utils/thor/templates/_perform_request.erb +19 -1
  191. data/utils/thor/templates/test.erb +16 -3
  192. data/utils/thor/templates/test_helper.rb +0 -4
  193. metadata +38 -41
  194. data/lib/elasticsearch/api/actions/abort_benchmark.rb +0 -41
  195. data/lib/elasticsearch/api/actions/benchmark.rb +0 -81
  196. data/lib/elasticsearch/api/actions/delete_by_rethrottle.rb +0 -47
  197. data/lib/elasticsearch/api/actions/nodes/shutdown.rb +0 -56
  198. data/spec/elasticsearch/api/actions/nodes/shutdown_spec.rb +0 -76
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-types-exists.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-types-exists.html
33
33
  #
34
34
  def exists_type(arguments = {})
35
35
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -55,6 +55,7 @@ module Elasticsearch
55
55
  end
56
56
 
57
57
  alias_method :exists_type?, :exists_type
58
+
58
59
  # Register this action with its valid params when the module is loaded.
59
60
  #
60
61
  # @since 6.2.0
@@ -0,0 +1,66 @@
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
+ # Returns the field usage stats for each field of an index
23
+ # This functionality is Experimental and may be changed or removed
24
+ # completely in a future release. Elastic will take a best effort approach
25
+ # to fix any issues, but experimental features are not subject to the
26
+ # support SLA of official GA features.
27
+ #
28
+ # @option arguments [String] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
29
+ # @option arguments [List] :fields A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards)
30
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
31
+ # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
32
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
33
+ # @option arguments [Hash] :headers Custom HTTP headers
34
+ #
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/field-usage-stats.html
36
+ #
37
+ def field_usage_stats(arguments = {})
38
+ raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
39
+
40
+ headers = arguments.delete(:headers) || {}
41
+
42
+ arguments = arguments.clone
43
+
44
+ _index = arguments.delete(:index)
45
+
46
+ method = Elasticsearch::API::HTTP_GET
47
+ path = "#{Utils.__listify(_index)}/_field_usage_stats"
48
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
49
+
50
+ body = nil
51
+ perform_request(method, path, params, body, headers).body
52
+ end
53
+
54
+ # Register this action with its valid params when the module is loaded.
55
+ #
56
+ # @since 6.2.0
57
+ ParamsRegistry.register(:field_usage_stats, [
58
+ :fields,
59
+ :ignore_unavailable,
60
+ :allow_no_indices,
61
+ :expand_wildcards
62
+ ].freeze)
63
+ end
64
+ end
65
+ end
66
+ end
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-flush.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-flush.html
33
33
  #
34
34
  def flush(arguments = {})
35
35
  headers = arguments.delete(:headers) || {}
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # Deprecated since version 7.6.0
33
33
  #
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-synced-flush-api.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-synced-flush-api.html
36
36
  #
37
37
  def flush_synced(arguments = {})
38
38
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-forcemerge.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-forcemerge.html
34
34
  #
35
35
  def forcemerge(arguments = {})
36
36
  headers = arguments.delete(:headers) || {}
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
33
33
  # @option arguments [Hash] :headers Custom HTTP headers
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-get-index.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-get-index.html
36
36
  #
37
37
  def get(arguments = {})
38
38
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-aliases.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-aliases.html
33
33
  #
34
34
  def get_alias(arguments = {})
35
35
  headers = arguments.delete(:headers) || {}
@@ -37,7 +37,7 @@ module Elasticsearch
37
37
  # Deprecated since version 7.0.0
38
38
  #
39
39
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-get-field-mapping.html
40
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-get-field-mapping.html
41
41
  #
42
42
  def get_field_mapping(arguments = {})
43
43
  _fields = arguments.delete(:field) || arguments.delete(:fields)
@@ -21,13 +21,13 @@ module Elasticsearch
21
21
  module Actions
22
22
  # Returns an index template.
23
23
  #
24
- # @option arguments [List] :name The comma separated names of the index templates
24
+ # @option arguments [String] :name A pattern that returned template names must match
25
25
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
26
26
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
27
27
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
31
31
  #
32
32
  def get_index_template(arguments = {})
33
33
  headers = arguments.delete(:headers) || {}
@@ -36,7 +36,7 @@ module Elasticsearch
36
36
  # Deprecated since version 7.0.0
37
37
  #
38
38
  #
39
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-get-mapping.html
39
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-get-mapping.html
40
40
  #
41
41
  def get_mapping(arguments = {})
42
42
  headers = arguments.delete(:headers) || {}
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
33
33
  # @option arguments [Hash] :headers Custom HTTP headers
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-get-settings.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-get-settings.html
36
36
  #
37
37
  def get_settings(arguments = {})
38
38
  headers = arguments.delete(:headers) || {}
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
32
32
  #
33
33
  def get_template(arguments = {})
34
34
  headers = arguments.delete(:headers) || {}
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # Deprecated since version 8.0.0
33
33
  #
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-upgrade.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-upgrade.html
36
36
  #
37
37
  def get_upgrade(arguments = {})
38
38
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-open-close.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-open-close.html
34
34
  #
35
35
  def open(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-aliases.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-aliases.html
32
32
  #
33
33
  def put_alias(arguments = {})
34
34
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  # @option arguments [Hash] :body The template definition (*Required*)
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
32
32
  #
33
33
  def put_index_template(arguments = {})
34
34
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -38,7 +38,7 @@ module Elasticsearch
38
38
  # Deprecated since version 7.0.0
39
39
  #
40
40
  #
41
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-put-mapping.html
41
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-put-mapping.html
42
42
  #
43
43
  def put_mapping(arguments = {})
44
44
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # @option arguments [Hash] :headers Custom HTTP headers
33
33
  # @option arguments [Hash] :body The index settings to be updated (*Required*)
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-update-settings.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-update-settings.html
36
36
  #
37
37
  def put_settings(arguments = {})
38
38
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  # @option arguments [Hash] :body The template definition (*Required*)
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
33
33
  #
34
34
  def put_template(arguments = {})
35
35
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-recovery.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-recovery.html
30
30
  #
31
31
  def recovery(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-refresh.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-refresh.html
31
31
  #
32
32
  def refresh(arguments = {})
33
33
  headers = arguments.delete(:headers) || {}
@@ -20,16 +20,12 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Returns information about any matching indices, aliases, and data streams
23
- # This functionality is Experimental and may be changed or removed
24
- # completely in a future release. Elastic will take a best effort approach
25
- # to fix any issues, but experimental features are not subject to the
26
- # support SLA of official GA features.
27
23
  #
28
24
  # @option arguments [List] :name A comma-separated list of names or wildcard expressions
29
25
  # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
30
26
  # @option arguments [Hash] :headers Custom HTTP headers
31
27
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-resolve-index-api.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-resolve-index-api.html
33
29
  #
34
30
  def resolve_index(arguments = {})
35
31
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # @option arguments [Hash] :headers Custom HTTP headers
33
33
  # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-rollover-index.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-rollover-index.html
36
36
  #
37
37
  def rollover(arguments = {})
38
38
  raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene.
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-segments.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-segments.html
32
32
  #
33
33
  def segments(arguments = {})
34
34
  headers = arguments.delete(:headers) || {}
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-shards-stores.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-shards-stores.html
32
32
  #
33
33
  def shard_stores(arguments = {})
34
34
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-shrink-index.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-shrink-index.html
34
34
  #
35
35
  def shrink(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  # @option arguments [Hash] :body New index template definition, which will be included in the simulation, as if it already exists in the system
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
32
32
  #
33
33
  def simulate_index_template(arguments = {})
34
34
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  # @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
32
32
  #
33
33
  def simulate_template(arguments = {})
34
34
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-split-index.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-split-index.html
34
34
  #
35
35
  def split(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -35,7 +35,7 @@ module Elasticsearch
35
35
  # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
36
36
  # @option arguments [Hash] :headers Custom HTTP headers
37
37
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-stats.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-stats.html
39
39
  #
40
40
  def stats(arguments = {})
41
41
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-aliases.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-aliases.html
30
30
  #
31
31
  def update_aliases(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -34,7 +34,7 @@ module Elasticsearch
34
34
  # Deprecated since version 8.0.0
35
35
  #
36
36
  #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-upgrade.html
37
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-upgrade.html
38
38
  #
39
39
  def upgrade(arguments = {})
40
40
  headers = arguments.delete(:headers) || {}
@@ -43,7 +43,7 @@ module Elasticsearch
43
43
  # Deprecated since version 7.0.0
44
44
  #
45
45
  #
46
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-validate.html
46
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-validate.html
47
47
  #
48
48
  def validate_query(arguments = {})
49
49
  headers = arguments.delete(:headers) || {}
@@ -60,13 +60,13 @@ module Elasticsearch
60
60
  Elasticsearch::API::HTTP_GET
61
61
  end
62
62
 
63
- path = if _index && _type
64
- "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_validate/query"
65
- elsif _index
66
- "#{Utils.__listify(_index)}/_validate/query"
67
- else
68
- "_validate/query"
69
- end
63
+ path = if _index && _type
64
+ "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_validate/query"
65
+ elsif _index
66
+ "#{Utils.__listify(_index)}/_validate/query"
67
+ else
68
+ "_validate/query"
69
+ end
70
70
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
71
71
 
72
72
  body = arguments[:body]
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [Hash] :headers Custom HTTP headers
24
24
  #
25
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/index.html
25
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/index.html
26
26
  #
27
27
  def info(arguments = {})
28
28
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :timeout Explicit operation timeout
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/delete-pipeline-api.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/delete-pipeline-api.html
30
30
  #
31
31
  def delete_pipeline(arguments = {})
32
32
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -23,7 +23,7 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [Hash] :headers Custom HTTP headers
25
25
  #
26
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/geoip-stats-api.html
26
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/geoip-stats-api.html
27
27
  #
28
28
  def geo_ip_stats(arguments = {})
29
29
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/get-pipeline-api.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/get-pipeline-api.html
30
30
  #
31
31
  def get_pipeline(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -23,7 +23,7 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [Hash] :headers Custom HTTP headers
25
25
  #
26
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/grok-processor.html#grok-processor-rest-get
26
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/grok-processor.html#grok-processor-rest-get
27
27
  #
28
28
  def processor_grok(arguments = {})
29
29
  headers = arguments.delete(:headers) || {}
@@ -22,12 +22,13 @@ module Elasticsearch
22
22
  # Creates or updates a pipeline.
23
23
  #
24
24
  # @option arguments [String] :id Pipeline ID
25
+ # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates
25
26
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
26
27
  # @option arguments [Time] :timeout Explicit operation timeout
27
28
  # @option arguments [Hash] :headers Custom HTTP headers
28
29
  # @option arguments [Hash] :body The ingest definition (*Required*)
29
30
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/put-pipeline-api.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/put-pipeline-api.html
31
32
  #
32
33
  def put_pipeline(arguments = {})
33
34
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -51,6 +52,7 @@ module Elasticsearch
51
52
  #
52
53
  # @since 6.2.0
53
54
  ParamsRegistry.register(:put_pipeline, [
55
+ :if_version,
54
56
  :master_timeout,
55
57
  :timeout
56
58
  ].freeze)
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The simulate definition (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/simulate-pipeline-api.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/simulate-pipeline-api.html
30
30
  #
31
31
  def simulate(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -38,7 +38,7 @@ module Elasticsearch
38
38
  # Deprecated since version 7.0.0
39
39
  #
40
40
  #
41
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-multi-get.html
41
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-multi-get.html
42
42
  #
43
43
  def mget(arguments = {})
44
44
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [List] :index A comma-separated list of index names to use as default
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
25
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
26
26
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
27
27
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
28
28
  # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
@@ -37,7 +37,7 @@ module Elasticsearch
37
37
  # Deprecated since version 7.0.0
38
38
  #
39
39
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-multi-search.html
40
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-multi-search.html
41
41
  #
42
42
  def msearch(arguments = {})
43
43
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -83,7 +83,7 @@ module Elasticsearch
83
83
  payload = body
84
84
  end
85
85
 
86
- headers.merge!("Content-Type" => "application/x-ndjson")
86
+ headers = Utils.ndjson_headers(headers)
87
87
  perform_request(method, path, params, payload, headers).body
88
88
  end
89
89
 
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [List] :index A comma-separated list of index names to use as default
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
25
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
26
26
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
27
27
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
28
28
  # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
@@ -35,7 +35,7 @@ module Elasticsearch
35
35
  # Deprecated since version 7.0.0
36
36
  #
37
37
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-multi-search.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-multi-search.html
39
39
  #
40
40
  def msearch_template(arguments = {})
41
41
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -69,7 +69,7 @@ module Elasticsearch
69
69
  payload = body
70
70
  end
71
71
 
72
- headers.merge!("Content-Type" => "application/x-ndjson")
72
+ headers = Utils.ndjson_headers(headers)
73
73
  perform_request(method, path, params, payload, headers).body
74
74
  end
75
75