elasticsearch-api 7.13.3 → 7.17.11

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 (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
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-reroute.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-reroute.html
34
34
  #
35
35
  def reroute(arguments = {})
36
36
  headers = arguments.delete(:headers) || {}
@@ -33,7 +33,7 @@ module Elasticsearch
33
33
  # @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)
34
34
  # @option arguments [Hash] :headers Custom HTTP headers
35
35
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/cluster-state.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-state.html
37
37
  #
38
38
  def state(arguments = {})
39
39
  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/cluster-stats.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-stats.html
30
30
  #
31
31
  def stats(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -44,7 +44,7 @@ module Elasticsearch
44
44
  # Deprecated since version 7.0.0
45
45
  #
46
46
  #
47
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-count.html
47
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-count.html
48
48
  #
49
49
  def count(arguments = {})
50
50
  headers = arguments.delete(:headers) || {}
@@ -55,7 +55,12 @@ module Elasticsearch
55
55
 
56
56
  _type = arguments.delete(:type)
57
57
 
58
- method = Elasticsearch::API::HTTP_POST
58
+ method = if arguments[:body]
59
+ Elasticsearch::API::HTTP_POST
60
+ else
61
+ Elasticsearch::API::HTTP_GET
62
+ end
63
+
59
64
  path = if _index && _type
60
65
  "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_count"
61
66
  elsif _index
@@ -40,7 +40,7 @@ module Elasticsearch
40
40
  # Deprecated since version 7.0.0
41
41
  #
42
42
  #
43
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-index_.html
43
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-index_.html
44
44
  #
45
45
  def create(arguments = {})
46
46
  if arguments[:id]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-gateway-dangling-indices.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-gateway-dangling-indices.html
31
31
  #
32
32
  def delete_dangling_index(arguments = {})
33
33
  raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-gateway-dangling-indices.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-gateway-dangling-indices.html
31
31
  #
32
32
  def import_dangling_index(arguments = {})
33
33
  raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]
@@ -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/modules-gateway-dangling-indices.html
26
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-gateway-dangling-indices.html
27
27
  #
28
28
  def list_dangling_indices(arguments = {})
29
29
  headers = arguments.delete(:headers) || {}
@@ -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-delete.html
41
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-delete.html
42
42
  #
43
43
  def delete(arguments = {})
44
44
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -41,9 +41,6 @@ module Elasticsearch
41
41
  # @option arguments [Number] :size Deprecated, please use `max_docs` instead
42
42
  # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
43
43
  # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
44
- # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
45
- # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
46
- # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
47
44
  # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
48
45
  # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
49
46
  # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
@@ -63,7 +60,7 @@ module Elasticsearch
63
60
  # Deprecated since version 7.0.0
64
61
  #
65
62
  #
66
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-delete-by-query.html
63
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-delete-by-query.html
67
64
  #
68
65
  def delete_by_query(arguments = {})
69
66
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -112,9 +109,6 @@ module Elasticsearch
112
109
  :size,
113
110
  :max_docs,
114
111
  :sort,
115
- :_source,
116
- :_source_excludes,
117
- :_source_includes,
118
112
  :terminate_after,
119
113
  :stats,
120
114
  :version,
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-delete-by-query.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-delete-by-query.html
28
28
  #
29
29
  def delete_by_query_rethrottle(arguments = {})
30
30
  raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-scripting.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-scripting.html
29
29
  #
30
30
  def delete_script(arguments = {})
31
31
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -40,7 +40,7 @@ module Elasticsearch
40
40
  # Deprecated since version 7.0.0
41
41
  #
42
42
  #
43
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-get.html
43
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-get.html
44
44
  #
45
45
  def exists(arguments = {})
46
46
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -72,6 +72,7 @@ module Elasticsearch
72
72
  end
73
73
 
74
74
  alias_method :exists?, :exists
75
+
75
76
  # Register this action with its valid params when the module is loaded.
76
77
  #
77
78
  # @since 6.2.0
@@ -39,7 +39,7 @@ module Elasticsearch
39
39
  # Deprecated since version 7.0.0
40
40
  #
41
41
  #
42
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-get.html
42
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-get.html
43
43
  #
44
44
  def exists_source(arguments = {})
45
45
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -68,6 +68,7 @@ module Elasticsearch
68
68
  end
69
69
 
70
70
  alias_method :exists_source?, :exists_source
71
+
71
72
  # Register this action with its valid params when the module is loaded.
72
73
  #
73
74
  # @since 6.2.0
@@ -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-explain.html
46
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-explain.html
47
47
  #
48
48
  def explain(arguments = {})
49
49
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -65,11 +65,11 @@ module Elasticsearch
65
65
  Elasticsearch::API::HTTP_GET
66
66
  end
67
67
 
68
- path = if _index && _type && _id
69
- "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_explain"
70
- else
71
- "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
72
- end
68
+ path = if _index && _type && _id
69
+ "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_explain"
70
+ else
71
+ "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
72
+ end
73
73
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
74
74
 
75
75
  body = arguments[:body]
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/get-features-api.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/get-features-api.html
28
28
  #
29
29
  def get_features(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  #
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-snapshots.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
31
31
  #
32
32
  def reset_features(arguments = {})
33
33
  headers = arguments.delete(:headers) || {}
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  # @option arguments [Hash] :body An index filter specified with the Query DSL
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/search-field-caps.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-field-caps.html
33
33
  #
34
34
  def field_caps(arguments = {})
35
35
  headers = arguments.delete(:headers) || {}
@@ -44,11 +44,11 @@ module Elasticsearch
44
44
  Elasticsearch::API::HTTP_GET
45
45
  end
46
46
 
47
- path = if _index
48
- "#{Utils.__listify(_index)}/_field_caps"
49
- else
50
- "_field_caps"
51
- end
47
+ path = if _index
48
+ "#{Utils.__listify(_index)}/_field_caps"
49
+ else
50
+ "_field_caps"
51
+ end
52
52
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
53
53
 
54
54
  body = arguments[:body]
@@ -40,7 +40,7 @@ module Elasticsearch
40
40
  # Deprecated since version 7.0.0
41
41
  #
42
42
  #
43
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-get.html
43
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-get.html
44
44
  #
45
45
  def get(arguments = {})
46
46
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-scripting.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-scripting.html
28
28
  #
29
29
  def get_script(arguments = {})
30
30
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -19,14 +19,10 @@ module Elasticsearch
19
19
  module API
20
20
  module Actions
21
21
  # Returns all script contexts.
22
- # This functionality is Experimental and may be changed or removed
23
- # completely in a future release. Elastic will take a best effort approach
24
- # to fix any issues, but experimental features are not subject to the
25
- # support SLA of official GA features.
26
22
  #
27
23
  # @option arguments [Hash] :headers Custom HTTP headers
28
24
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.13/painless-contexts.html
25
+ # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.17/painless-contexts.html
30
26
  #
31
27
  def get_script_context(arguments = {})
32
28
  headers = arguments.delete(:headers) || {}
@@ -19,14 +19,10 @@ module Elasticsearch
19
19
  module API
20
20
  module Actions
21
21
  # Returns available script types, languages and contexts
22
- # This functionality is Experimental and may be changed or removed
23
- # completely in a future release. Elastic will take a best effort approach
24
- # to fix any issues, but experimental features are not subject to the
25
- # support SLA of official GA features.
26
22
  #
27
23
  # @option arguments [Hash] :headers Custom HTTP headers
28
24
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/modules-scripting.html
25
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-scripting.html
30
26
  #
31
27
  def get_script_languages(arguments = {})
32
28
  headers = arguments.delete(:headers) || {}
@@ -39,7 +39,7 @@ module Elasticsearch
39
39
  # Deprecated since version 7.0.0
40
40
  #
41
41
  #
42
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-get.html
42
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-get.html
43
43
  #
44
44
  def get_source(arguments = {})
45
45
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -42,7 +42,7 @@ module Elasticsearch
42
42
  # Deprecated since version 7.0.0
43
43
  #
44
44
  #
45
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/docs-index_.html
45
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-index_.html
46
46
  #
47
47
  def index(arguments = {})
48
48
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @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)
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/index-modules-blocks.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/index-modules-blocks.html
34
34
  #
35
35
  def add_block(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-analyze.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-analyze.html
29
29
  #
30
30
  def analyze(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -40,11 +40,11 @@ module Elasticsearch
40
40
  Elasticsearch::API::HTTP_GET
41
41
  end
42
42
 
43
- path = if _index
44
- "#{Utils.__listify(_index)}/_analyze"
45
- else
46
- "_analyze"
47
- end
43
+ path = if _index
44
+ "#{Utils.__listify(_index)}/_analyze"
45
+ else
46
+ "_analyze"
47
+ end
48
48
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
49
49
 
50
50
  body = arguments[:body]
@@ -31,7 +31,7 @@ module Elasticsearch
31
31
  # @option arguments [Boolean] :request Clear request cache
32
32
  # @option arguments [Hash] :headers Custom HTTP headers
33
33
  #
34
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-clearcache.html
34
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-clearcache.html
35
35
  #
36
36
  def clear_cache(arguments = {})
37
37
  headers = arguments.delete(:headers) || {}
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-clone-index.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-clone-index.html
33
33
  #
34
34
  def clone(arguments = {})
35
35
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -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. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`.
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 close(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  # @option arguments [Hash] :body The configuration for the index (`settings` and `mappings`)
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-create-index.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-create-index.html
33
33
  #
34
34
  def create(arguments = {})
35
35
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -26,10 +26,10 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
27
27
  # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
28
28
  # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
29
- # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
29
+ # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (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-delete-index.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-delete-index.html
33
33
  #
34
34
  def delete(arguments = {})
35
35
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-aliases.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-aliases.html
31
31
  #
32
32
  def delete_alias(arguments = {})
33
33
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
30
30
  #
31
31
  def delete_index_template(arguments = {})
32
32
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -42,7 +42,11 @@ module Elasticsearch
42
42
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
43
43
 
44
44
  body = nil
45
- perform_request(method, path, params, body, headers).body
45
+ if Array(arguments[:ignore]).include?(404)
46
+ Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
47
+ else
48
+ perform_request(method, path, params, body, headers).body
49
+ end
46
50
  end
47
51
 
48
52
  # Register this action with its valid params when the module is loaded.
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-templates.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
30
30
  #
31
31
  def delete_template(arguments = {})
32
32
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -0,0 +1,68 @@
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
+ # Analyzes the disk usage of each field of an index or data stream
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 Comma-separated list of indices or data streams to analyze the disk usage
29
+ # @option arguments [Boolean] :run_expensive_tasks Must be set to [true] in order for the task to be performed. Defaults to false.
30
+ # @option arguments [Boolean] :flush Whether flush or not before analyzing the index disk usage. Defaults to true
31
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
32
+ # @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)
33
+ # @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)
34
+ # @option arguments [Hash] :headers Custom HTTP headers
35
+ #
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-disk-usage.html
37
+ #
38
+ def disk_usage(arguments = {})
39
+ raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
40
+
41
+ headers = arguments.delete(:headers) || {}
42
+
43
+ arguments = arguments.clone
44
+
45
+ _index = arguments.delete(:index)
46
+
47
+ method = Elasticsearch::API::HTTP_POST
48
+ path = "#{Utils.__listify(_index)}/_disk_usage"
49
+ params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
50
+
51
+ body = nil
52
+ perform_request(method, path, params, body, headers).body
53
+ end
54
+
55
+ # Register this action with its valid params when the module is loaded.
56
+ #
57
+ # @since 6.2.0
58
+ ParamsRegistry.register(:disk_usage, [
59
+ :run_expensive_tasks,
60
+ :flush,
61
+ :ignore_unavailable,
62
+ :allow_no_indices,
63
+ :expand_wildcards
64
+ ].freeze)
65
+ end
66
+ end
67
+ end
68
+ end
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-exists.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-exists.html
34
34
  #
35
35
  def exists(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -53,6 +53,7 @@ module Elasticsearch
53
53
  end
54
54
 
55
55
  alias_method :exists?, :exists
56
+
56
57
  # Register this action with its valid params when the module is loaded.
57
58
  #
58
59
  # @since 6.2.0
@@ -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 exists_alias(arguments = {})
35
35
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -58,6 +58,7 @@ module Elasticsearch
58
58
  end
59
59
 
60
60
  alias_method :exists_alias?, :exists_alias
61
+
61
62
  # Register this action with its valid params when the module is loaded.
62
63
  #
63
64
  # @since 6.2.0
@@ -27,7 +27,7 @@ module Elasticsearch
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 exists_index_template(arguments = {})
33
33
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -43,10 +43,14 @@ module Elasticsearch
43
43
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
44
44
 
45
45
  body = nil
46
- perform_request(method, path, params, body, headers).body
46
+
47
+ Utils.__rescue_from_not_found do
48
+ perform_request(method, path, params, body, headers).status == 200 ? true : false
49
+ end
47
50
  end
48
51
 
49
52
  alias_method :exists_index_template?, :exists_index_template
53
+
50
54
  # Register this action with its valid params when the module is loaded.
51
55
  #
52
56
  # @since 6.2.0
@@ -27,7 +27,7 @@ module Elasticsearch
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 exists_template(arguments = {})
33
33
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -50,6 +50,7 @@ module Elasticsearch
50
50
  end
51
51
 
52
52
  alias_method :exists_template?, :exists_template
53
+
53
54
  # Register this action with its valid params when the module is loaded.
54
55
  #
55
56
  # @since 6.2.0