elasticsearch-api 7.14.1 → 7.15.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 (167) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/bulk.rb +1 -1
  3. data/lib/elasticsearch/api/actions/cat/aliases.rb +1 -1
  4. data/lib/elasticsearch/api/actions/cat/allocation.rb +1 -1
  5. data/lib/elasticsearch/api/actions/cat/count.rb +1 -1
  6. data/lib/elasticsearch/api/actions/cat/fielddata.rb +1 -1
  7. data/lib/elasticsearch/api/actions/cat/health.rb +1 -1
  8. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  9. data/lib/elasticsearch/api/actions/cat/indices.rb +1 -1
  10. data/lib/elasticsearch/api/actions/cat/master.rb +1 -1
  11. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +1 -1
  12. data/lib/elasticsearch/api/actions/cat/nodes.rb +1 -1
  13. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +1 -1
  14. data/lib/elasticsearch/api/actions/cat/plugins.rb +1 -1
  15. data/lib/elasticsearch/api/actions/cat/recovery.rb +1 -1
  16. data/lib/elasticsearch/api/actions/cat/repositories.rb +1 -1
  17. data/lib/elasticsearch/api/actions/cat/segments.rb +1 -1
  18. data/lib/elasticsearch/api/actions/cat/shards.rb +1 -1
  19. data/lib/elasticsearch/api/actions/cat/snapshots.rb +1 -1
  20. data/lib/elasticsearch/api/actions/cat/tasks.rb +1 -1
  21. data/lib/elasticsearch/api/actions/cat/templates.rb +1 -1
  22. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +1 -1
  23. data/lib/elasticsearch/api/actions/clear_scroll.rb +1 -1
  24. data/lib/elasticsearch/api/actions/close_point_in_time.rb +1 -1
  25. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +3 -3
  26. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +1 -1
  27. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +1 -1
  28. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +1 -1
  29. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +1 -1
  30. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +1 -1
  31. data/lib/elasticsearch/api/actions/cluster/health.rb +1 -1
  32. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +1 -1
  33. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +1 -1
  34. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +1 -1
  35. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +1 -1
  36. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +1 -1
  37. data/lib/elasticsearch/api/actions/cluster/reroute.rb +1 -1
  38. data/lib/elasticsearch/api/actions/cluster/state.rb +1 -1
  39. data/lib/elasticsearch/api/actions/cluster/stats.rb +1 -1
  40. data/lib/elasticsearch/api/actions/count.rb +1 -1
  41. data/lib/elasticsearch/api/actions/create.rb +1 -1
  42. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
  43. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
  44. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +1 -1
  45. data/lib/elasticsearch/api/actions/delete.rb +1 -1
  46. data/lib/elasticsearch/api/actions/delete_by_query.rb +1 -1
  47. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +1 -1
  48. data/lib/elasticsearch/api/actions/delete_script.rb +1 -1
  49. data/lib/elasticsearch/api/actions/exists.rb +1 -1
  50. data/lib/elasticsearch/api/actions/exists_source.rb +1 -1
  51. data/lib/elasticsearch/api/actions/explain.rb +1 -1
  52. data/lib/elasticsearch/api/actions/features/get_features.rb +1 -1
  53. data/lib/elasticsearch/api/actions/features/reset_features.rb +1 -1
  54. data/lib/elasticsearch/api/actions/field_caps.rb +1 -1
  55. data/lib/elasticsearch/api/actions/get.rb +1 -1
  56. data/lib/elasticsearch/api/actions/get_script.rb +1 -1
  57. data/lib/elasticsearch/api/actions/get_script_context.rb +1 -1
  58. data/lib/elasticsearch/api/actions/get_script_languages.rb +1 -1
  59. data/lib/elasticsearch/api/actions/get_source.rb +1 -1
  60. data/lib/elasticsearch/api/actions/index.rb +1 -1
  61. data/lib/elasticsearch/api/actions/indices/add_block.rb +1 -1
  62. data/lib/elasticsearch/api/actions/indices/analyze.rb +1 -1
  63. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +1 -1
  64. data/lib/elasticsearch/api/actions/indices/clone.rb +1 -1
  65. data/lib/elasticsearch/api/actions/indices/close.rb +1 -1
  66. data/lib/elasticsearch/api/actions/indices/create.rb +1 -1
  67. data/lib/elasticsearch/api/actions/indices/delete.rb +2 -2
  68. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +1 -1
  69. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +1 -1
  70. data/lib/elasticsearch/api/actions/indices/delete_template.rb +1 -1
  71. data/lib/elasticsearch/api/actions/indices/disk_usage.rb +68 -0
  72. data/lib/elasticsearch/api/actions/indices/exists.rb +1 -1
  73. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +1 -1
  74. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +1 -1
  75. data/lib/elasticsearch/api/actions/indices/exists_template.rb +1 -1
  76. data/lib/elasticsearch/api/actions/indices/exists_type.rb +1 -1
  77. data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +66 -0
  78. data/lib/elasticsearch/api/actions/indices/flush.rb +1 -1
  79. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +1 -1
  80. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +1 -1
  81. data/lib/elasticsearch/api/actions/indices/get.rb +1 -1
  82. data/lib/elasticsearch/api/actions/indices/get_alias.rb +1 -1
  83. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +1 -1
  84. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
  85. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +1 -1
  86. data/lib/elasticsearch/api/actions/indices/get_settings.rb +1 -1
  87. data/lib/elasticsearch/api/actions/indices/get_template.rb +1 -1
  88. data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +1 -1
  89. data/lib/elasticsearch/api/actions/indices/open.rb +1 -1
  90. data/lib/elasticsearch/api/actions/indices/put_alias.rb +1 -1
  91. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  92. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +1 -1
  93. data/lib/elasticsearch/api/actions/indices/put_settings.rb +1 -1
  94. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  95. data/lib/elasticsearch/api/actions/indices/recovery.rb +1 -1
  96. data/lib/elasticsearch/api/actions/indices/refresh.rb +1 -1
  97. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +1 -1
  98. data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
  99. data/lib/elasticsearch/api/actions/indices/segments.rb +1 -1
  100. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +1 -1
  101. data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -1
  102. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +1 -1
  103. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
  104. data/lib/elasticsearch/api/actions/indices/split.rb +1 -1
  105. data/lib/elasticsearch/api/actions/indices/stats.rb +1 -1
  106. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +1 -1
  107. data/lib/elasticsearch/api/actions/indices/upgrade.rb +1 -1
  108. data/lib/elasticsearch/api/actions/indices/validate_query.rb +1 -1
  109. data/lib/elasticsearch/api/actions/info.rb +1 -1
  110. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  111. data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +1 -1
  112. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
  113. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +1 -1
  114. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
  115. data/lib/elasticsearch/api/actions/ingest/simulate.rb +1 -1
  116. data/lib/elasticsearch/api/actions/mget.rb +1 -1
  117. data/lib/elasticsearch/api/actions/msearch.rb +1 -1
  118. data/lib/elasticsearch/api/actions/msearch_template.rb +1 -1
  119. data/lib/elasticsearch/api/actions/mtermvectors.rb +1 -1
  120. data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +58 -0
  121. data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +52 -0
  122. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +1 -1
  123. data/lib/elasticsearch/api/actions/nodes/info.rb +1 -1
  124. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +1 -1
  125. data/lib/elasticsearch/api/actions/nodes/stats.rb +2 -2
  126. data/lib/elasticsearch/api/actions/nodes/usage.rb +1 -1
  127. data/lib/elasticsearch/api/actions/open_point_in_time.rb +4 -6
  128. data/lib/elasticsearch/api/actions/ping.rb +1 -1
  129. data/lib/elasticsearch/api/actions/put_script.rb +1 -1
  130. data/lib/elasticsearch/api/actions/rank_eval.rb +1 -1
  131. data/lib/elasticsearch/api/actions/reindex.rb +1 -1
  132. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +1 -1
  133. data/lib/elasticsearch/api/actions/render_search_template.rb +1 -1
  134. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +1 -1
  135. data/lib/elasticsearch/api/actions/scroll.rb +1 -1
  136. data/lib/elasticsearch/api/actions/search.rb +1 -1
  137. data/lib/elasticsearch/api/actions/search_mvt.rb +83 -0
  138. data/lib/elasticsearch/api/actions/search_shards.rb +1 -1
  139. data/lib/elasticsearch/api/actions/search_template.rb +1 -1
  140. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +1 -1
  141. data/lib/elasticsearch/api/actions/snapshot/clone.rb +1 -1
  142. data/lib/elasticsearch/api/actions/snapshot/create.rb +1 -1
  143. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +1 -1
  144. data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
  145. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -1
  146. data/lib/elasticsearch/api/actions/snapshot/get.rb +1 -1
  147. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
  148. data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +1 -1
  149. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  150. data/lib/elasticsearch/api/actions/snapshot/status.rb +1 -1
  151. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -1
  152. data/lib/elasticsearch/api/actions/tasks/cancel.rb +1 -1
  153. data/lib/elasticsearch/api/actions/tasks/get.rb +1 -1
  154. data/lib/elasticsearch/api/actions/tasks/list.rb +1 -1
  155. data/lib/elasticsearch/api/actions/termvectors.rb +1 -1
  156. data/lib/elasticsearch/api/actions/update.rb +1 -1
  157. data/lib/elasticsearch/api/actions/update_by_query.rb +1 -1
  158. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +1 -1
  159. data/lib/elasticsearch/api/version.rb +1 -1
  160. data/spec/elasticsearch/api/actions/indices/disk_usage_spec.rb +48 -0
  161. data/spec/elasticsearch/api/actions/indices/field_usage_stats_spec.rb +46 -0
  162. data/spec/elasticsearch/api/actions/nodes/clear_repositories_metering_archive_spec.rb +51 -0
  163. data/spec/elasticsearch/api/actions/nodes/get_repositories_metering_info_spec.rb +44 -0
  164. data/spec/elasticsearch/api/actions/open_point_in_time_spec.rb +2 -12
  165. data/spec/elasticsearch/api/actions/search_mvt_spec.rb +53 -0
  166. data/utils/thor/generate_source.rb +1 -0
  167. metadata +17 -2
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  #
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-scripting.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/modules-scripting.html
30
30
  #
31
31
  def get_script_languages(arguments = {})
32
32
  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.14/docs-get.html
42
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/docs-index_.html
45
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/index-modules-blocks.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-analyze.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-analyze.html
29
29
  #
30
30
  def analyze(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -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.14/indices-clearcache.html
34
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-clone-index.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-open-close.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-create-index.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-delete-index.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-aliases.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-templates.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-templates.html
30
30
  #
31
31
  def delete_index_template(arguments = {})
32
32
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -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.14/indices-templates.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.15/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.14/indices-exists.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-exists.html
34
34
  #
35
35
  def exists(arguments = {})
36
36
  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.14/indices-aliases.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-aliases.html
33
33
  #
34
34
  def exists_alias(arguments = {})
35
35
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -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.14/indices-templates.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-templates.html
31
31
  #
32
32
  def exists_index_template(arguments = {})
33
33
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -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.14/indices-templates.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-templates.html
31
31
  #
32
32
  def exists_template(arguments = {})
33
33
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -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.14/indices-types-exists.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-types-exists.html
33
33
  #
34
34
  def exists_type(arguments = {})
35
35
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -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.15/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.14/indices-flush.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-synced-flush-api.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-forcemerge.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-get-index.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-aliases.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-get-field-mapping.html
40
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-get-field-mapping.html
41
41
  #
42
42
  def get_field_mapping(arguments = {})
43
43
  _fields = arguments.delete(:field) || arguments.delete(:fields)
@@ -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.14/indices-templates.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-get-mapping.html
39
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-get-settings.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-upgrade.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-open-close.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-aliases.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-put-mapping.html
41
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-update-settings.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-templates.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-recovery.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-refresh.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-refresh.html
31
31
  #
32
32
  def refresh(arguments = {})
33
33
  headers = arguments.delete(:headers) || {}
@@ -29,7 +29,7 @@ module Elasticsearch
29
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)
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/indices-resolve-index-api.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-resolve-index-api.html
33
33
  #
34
34
  def resolve_index(arguments = {})
35
35
  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.14/indices-rollover-index.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-segments.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-shards-stores.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-shrink-index.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/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.14/indices-split-index.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-split-index.html
34
34
  #
35
35
  def split(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]