elasticsearch-api 7.9.0.pre → 7.11.0.pre.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -2
  3. data/elasticsearch-api.gemspec +1 -1
  4. data/lib/elasticsearch/api/actions/bulk.rb +5 -6
  5. data/lib/elasticsearch/api/actions/cat/aliases.rb +2 -4
  6. data/lib/elasticsearch/api/actions/cat/allocation.rb +2 -4
  7. data/lib/elasticsearch/api/actions/cat/count.rb +1 -1
  8. data/lib/elasticsearch/api/actions/cat/fielddata.rb +2 -5
  9. data/lib/elasticsearch/api/actions/cat/health.rb +2 -4
  10. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  11. data/lib/elasticsearch/api/actions/cat/indices.rb +6 -14
  12. data/lib/elasticsearch/api/actions/cat/master.rb +1 -1
  13. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +1 -1
  14. data/lib/elasticsearch/api/actions/cat/nodes.rb +4 -8
  15. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +2 -4
  16. data/lib/elasticsearch/api/actions/cat/plugins.rb +1 -1
  17. data/lib/elasticsearch/api/actions/cat/recovery.rb +3 -8
  18. data/lib/elasticsearch/api/actions/cat/repositories.rb +1 -1
  19. data/lib/elasticsearch/api/actions/cat/segments.rb +2 -4
  20. data/lib/elasticsearch/api/actions/cat/shards.rb +4 -8
  21. data/lib/elasticsearch/api/actions/cat/snapshots.rb +2 -4
  22. data/lib/elasticsearch/api/actions/cat/tasks.rb +6 -8
  23. data/lib/elasticsearch/api/actions/cat/templates.rb +1 -1
  24. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +2 -4
  25. data/lib/elasticsearch/api/actions/clear_scroll.rb +2 -2
  26. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +1 -1
  27. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +1 -1
  28. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +1 -1
  29. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +1 -1
  30. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +1 -1
  31. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +1 -1
  32. data/lib/elasticsearch/api/actions/cluster/health.rb +5 -13
  33. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +1 -1
  34. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +1 -1
  35. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +1 -1
  36. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +1 -1
  37. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +1 -1
  38. data/lib/elasticsearch/api/actions/cluster/reroute.rb +2 -4
  39. data/lib/elasticsearch/api/actions/cluster/state.rb +3 -7
  40. data/lib/elasticsearch/api/actions/cluster/stats.rb +1 -1
  41. data/lib/elasticsearch/api/actions/count.rb +3 -7
  42. data/lib/elasticsearch/api/actions/create.rb +4 -8
  43. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
  44. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
  45. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +1 -1
  46. data/lib/elasticsearch/api/actions/delete.rb +4 -8
  47. data/lib/elasticsearch/api/actions/delete_by_query.rb +6 -14
  48. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +2 -2
  49. data/lib/elasticsearch/api/actions/delete_script.rb +1 -1
  50. data/lib/elasticsearch/api/actions/exists.rb +3 -5
  51. data/lib/elasticsearch/api/actions/exists_source.rb +3 -5
  52. data/lib/elasticsearch/api/actions/explain.rb +3 -5
  53. data/lib/elasticsearch/api/actions/field_caps.rb +2 -4
  54. data/lib/elasticsearch/api/actions/get.rb +3 -5
  55. data/lib/elasticsearch/api/actions/get_script.rb +1 -1
  56. data/lib/elasticsearch/api/actions/get_script_context.rb +5 -1
  57. data/lib/elasticsearch/api/actions/get_script_languages.rb +5 -1
  58. data/lib/elasticsearch/api/actions/get_source.rb +3 -5
  59. data/lib/elasticsearch/api/actions/index.rb +8 -12
  60. data/lib/elasticsearch/api/actions/indices/add_block.rb +2 -4
  61. data/lib/elasticsearch/api/actions/indices/analyze.rb +1 -2
  62. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +2 -5
  63. data/lib/elasticsearch/api/actions/indices/clone.rb +1 -1
  64. data/lib/elasticsearch/api/actions/indices/close.rb +2 -4
  65. data/lib/elasticsearch/api/actions/indices/create.rb +1 -1
  66. data/lib/elasticsearch/api/actions/indices/delete.rb +2 -4
  67. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +1 -1
  68. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +1 -1
  69. data/lib/elasticsearch/api/actions/indices/delete_template.rb +1 -1
  70. data/lib/elasticsearch/api/actions/indices/exists.rb +2 -4
  71. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +2 -4
  72. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +1 -1
  73. data/lib/elasticsearch/api/actions/indices/exists_template.rb +1 -1
  74. data/lib/elasticsearch/api/actions/indices/exists_type.rb +2 -4
  75. data/lib/elasticsearch/api/actions/indices/flush.rb +2 -4
  76. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +7 -4
  77. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +2 -4
  78. data/lib/elasticsearch/api/actions/indices/get.rb +2 -4
  79. data/lib/elasticsearch/api/actions/indices/get_alias.rb +2 -4
  80. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +3 -5
  81. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +1 -1
  82. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +4 -6
  83. data/lib/elasticsearch/api/actions/indices/get_settings.rb +2 -4
  84. data/lib/elasticsearch/api/actions/indices/get_template.rb +1 -1
  85. data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +8 -5
  86. data/lib/elasticsearch/api/actions/indices/open.rb +2 -4
  87. data/lib/elasticsearch/api/actions/indices/put_alias.rb +1 -1
  88. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
  89. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +3 -5
  90. data/lib/elasticsearch/api/actions/indices/put_settings.rb +2 -4
  91. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  92. data/lib/elasticsearch/api/actions/indices/recovery.rb +1 -1
  93. data/lib/elasticsearch/api/actions/indices/refresh.rb +2 -4
  94. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +6 -4
  95. data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
  96. data/lib/elasticsearch/api/actions/indices/segments.rb +2 -4
  97. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +3 -7
  98. data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -1
  99. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +1 -1
  100. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
  101. data/lib/elasticsearch/api/actions/indices/split.rb +1 -1
  102. data/lib/elasticsearch/api/actions/indices/stats.rb +4 -10
  103. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +1 -1
  104. data/lib/elasticsearch/api/actions/indices/upgrade.rb +8 -5
  105. data/lib/elasticsearch/api/actions/indices/validate_query.rb +4 -8
  106. data/lib/elasticsearch/api/actions/info.rb +1 -1
  107. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  108. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
  109. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +1 -1
  110. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
  111. data/lib/elasticsearch/api/actions/ingest/simulate.rb +1 -1
  112. data/lib/elasticsearch/api/actions/mget.rb +2 -2
  113. data/lib/elasticsearch/api/actions/msearch.rb +4 -8
  114. data/lib/elasticsearch/api/actions/msearch_template.rb +2 -4
  115. data/lib/elasticsearch/api/actions/mtermvectors.rb +2 -4
  116. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +2 -4
  117. data/lib/elasticsearch/api/actions/nodes/info.rb +2 -4
  118. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +1 -1
  119. data/lib/elasticsearch/api/actions/nodes/stats.rb +4 -10
  120. data/lib/elasticsearch/api/actions/nodes/usage.rb +2 -4
  121. data/lib/elasticsearch/api/actions/ping.rb +1 -1
  122. data/lib/elasticsearch/api/actions/put_script.rb +1 -2
  123. data/lib/elasticsearch/api/actions/rank_eval.rb +7 -7
  124. data/lib/elasticsearch/api/actions/reindex.rb +1 -1
  125. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +2 -2
  126. data/lib/elasticsearch/api/actions/render_search_template.rb +1 -1
  127. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +5 -1
  128. data/lib/elasticsearch/api/actions/scroll.rb +2 -3
  129. data/lib/elasticsearch/api/actions/search.rb +5 -13
  130. data/lib/elasticsearch/api/actions/search_shards.rb +2 -4
  131. data/lib/elasticsearch/api/actions/search_template.rb +3 -7
  132. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +1 -1
  133. data/lib/elasticsearch/api/actions/snapshot/clone.rb +66 -0
  134. data/lib/elasticsearch/api/actions/snapshot/create.rb +1 -1
  135. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +1 -1
  136. data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
  137. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -1
  138. data/lib/elasticsearch/api/actions/snapshot/get.rb +1 -1
  139. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
  140. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  141. data/lib/elasticsearch/api/actions/snapshot/status.rb +1 -1
  142. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -1
  143. data/lib/elasticsearch/api/actions/tasks/cancel.rb +5 -1
  144. data/lib/elasticsearch/api/actions/tasks/get.rb +5 -1
  145. data/lib/elasticsearch/api/actions/tasks/list.rb +6 -4
  146. data/lib/elasticsearch/api/actions/termvectors.rb +3 -5
  147. data/lib/elasticsearch/api/actions/update.rb +6 -6
  148. data/lib/elasticsearch/api/actions/update_by_query.rb +6 -14
  149. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +2 -2
  150. data/lib/elasticsearch/api/version.rb +1 -1
  151. data/spec/elasticsearch/api/actions/msearch_spec.rb +16 -33
  152. data/spec/elasticsearch/api/actions/snapshot/clone_spec.rb +67 -0
  153. data/spec/elasticsearch/api/rest_api_yaml_spec.rb +13 -6
  154. data/spec/rest_yaml_tests_helper.rb +13 -9
  155. data/utils/thor/generate_source.rb +32 -4
  156. data/utils/thor/generator/endpoint_specifics.rb +2 -2
  157. data/utils/thor/templates/_documentation_top.erb +2 -1
  158. metadata +8 -11
  159. data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +0 -49
  160. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +0 -62
  161. data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +0 -48
  162. data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +0 -50
  163. data/spec/elasticsearch/api/actions/indices/data_streams_stats_spec.rb +0 -72
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 98f0e5f1eb4c215d5737c3f399c889106edd43c3706e32475ca2bce1f9175cc4
4
- data.tar.gz: d4b05f1c0c9cc446924101c66e32b4e9af79e58dfa482f3b638a76c3cacb9461
3
+ metadata.gz: 4243574186bfd53046b99dd1e63a16388d66bec900d8adb919a823e4d1a2f4de
4
+ data.tar.gz: b4db7d9f8af098fae4e40015b2d7320ec1b450c6b26c432cc89a473ae6a539ef
5
5
  SHA512:
6
- metadata.gz: 1bebaaa45f3a81b07fef48eb3b04c2ca87214ede4cd19208d2e8f3a3dc817ead73bbfaacad3d576903ff374d6b0ae3e1670fecca0d4492ea55506361ffb86880
7
- data.tar.gz: ea53b48d7671779d23c7ca597a7f31470d990cdbedba83bf29aa315e1f16ad453971097bcbf89573638b3e3f3ef1454f648ccc6c845c7fd8d58d127603093049
6
+ metadata.gz: de51d8f5728ad33fc561b626a0bc41ba24adb10a3e7edb1b0cd05c428d7172c8d4a09310858118b5f904580a2c8f607495902f29ca1bcc9665f1f7fc6e22c442
7
+ data.tar.gz: 67a61875d8e9315d6f34f0d0a36e63e59d1d00ae8912deebcb18c8b1293e537aa39e19f07db3fffdb7d4c93381d2c9dff5db097a5b617d0c6aec3fd0fd6233b6
data/README.md CHANGED
@@ -75,12 +75,13 @@ When you want to mix the library into your own client, it must conform to a foll
75
75
  * It responds to a `perform_request(method, path, params, body, headers)` method,
76
76
  * the method returns an object with `status`, `body` and `headers` methods.
77
77
 
78
- A simple client could look like this:
78
+ A simple client could look like this (_with a dependency on `active_support` to parse the query params_):
79
79
 
80
80
  ```ruby
81
81
  require 'multi_json'
82
82
  require 'faraday'
83
83
  require 'elasticsearch/api'
84
+ require 'active_support'
84
85
 
85
86
  class MySimpleClient
86
87
  include Elasticsearch::API
@@ -92,10 +93,25 @@ class MySimpleClient
92
93
 
93
94
  CONNECTION.run_request \
94
95
  method.downcase.to_sym,
95
- path,
96
+ path_with_params(path, params),
96
97
  ( body ? MultiJson.dump(body): nil ),
97
98
  {'Content-Type' => 'application/json'}
98
99
  end
100
+
101
+ private
102
+
103
+ def path_with_params(path, params)
104
+ return path if params.blank?
105
+
106
+ case params
107
+ when String
108
+ "#{path}?#{params}"
109
+ when Hash
110
+ "#{path}?#{params.to_query}"
111
+ else
112
+ raise ArgumentError, "Cannot parse params: '#{params}'"
113
+ end
114
+ end
99
115
  end
100
116
 
101
117
  client = MySimpleClient.new
@@ -55,7 +55,7 @@ Gem::Specification.new do |s|
55
55
  s.add_development_dependency 'minitest-reporters'
56
56
  s.add_development_dependency 'mocha'
57
57
  s.add_development_dependency 'pry'
58
- s.add_development_dependency 'rake', '~> 11.1'
58
+ s.add_development_dependency 'rake', '~> 13'
59
59
  s.add_development_dependency 'shoulda-context'
60
60
  s.add_development_dependency 'yard'
61
61
 
@@ -23,21 +23,19 @@ module Elasticsearch
23
23
  # @option arguments [String] :index Default index for items which don't provide one
24
24
  # @option arguments [String] :type Default document type for items which don't provide one
25
25
  # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
26
- # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
27
- # (options: true,false,wait_for)
28
-
26
+ # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
29
27
  # @option arguments [String] :routing Specific routing value
30
28
  # @option arguments [Time] :timeout Explicit operation timeout
31
- # @option arguments [String] :type Default document type for items which don't provide one
32
29
  # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
33
30
  # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
34
31
  # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
35
32
  # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
33
+ # @option arguments [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false)
36
34
  # @option arguments [Hash] :headers Custom HTTP headers
37
35
  # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
38
36
  # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
39
37
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-bulk.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-bulk.html
41
39
  #
42
40
  def bulk(arguments = {})
43
41
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -83,7 +81,8 @@ module Elasticsearch
83
81
  :_source,
84
82
  :_source_excludes,
85
83
  :_source_includes,
86
- :pipeline
84
+ :pipeline,
85
+ :require_alias
87
86
  ].freeze)
88
87
  end
89
88
  end
@@ -28,12 +28,10 @@ module Elasticsearch
28
28
  # @option arguments [Boolean] :help Return help information
29
29
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
30
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
31
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
32
- # (options: open,closed,hidden,none,all)
33
-
31
+ # @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
32
  # @option arguments [Hash] :headers Custom HTTP headers
35
33
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-alias.html
34
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-alias.html
37
35
  #
38
36
  def aliases(arguments = {})
39
37
  headers = arguments.delete(:headers) || {}
@@ -23,9 +23,7 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
25
25
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26
- # @option arguments [String] :bytes The unit in which to display byte values
27
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
28
-
26
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
29
27
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
30
28
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
31
29
  # @option arguments [List] :h Comma-separated list of column names to display
@@ -34,7 +32,7 @@ module Elasticsearch
34
32
  # @option arguments [Boolean] :v Verbose mode. Display column headers
35
33
  # @option arguments [Hash] :headers Custom HTTP headers
36
34
  #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-allocation.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-allocation.html
38
36
  #
39
37
  def allocation(arguments = {})
40
38
  headers = arguments.delete(:headers) || {}
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Boolean] :v Verbose mode. Display column headers
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-count.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-count.html
33
33
  #
34
34
  def count(arguments = {})
35
35
  headers = arguments.delete(:headers) || {}
@@ -23,17 +23,14 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size
25
25
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26
- # @option arguments [String] :bytes The unit in which to display byte values
27
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
28
-
26
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
29
27
  # @option arguments [List] :h Comma-separated list of column names to display
30
28
  # @option arguments [Boolean] :help Return help information
31
29
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
32
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
33
- # @option arguments [List] :fields A comma-separated list of fields to return in the output
34
31
  # @option arguments [Hash] :headers Custom HTTP headers
35
32
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-fielddata.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-fielddata.html
37
34
  #
38
35
  def fielddata(arguments = {})
39
36
  headers = arguments.delete(:headers) || {}
@@ -25,14 +25,12 @@ module Elasticsearch
25
25
  # @option arguments [List] :h Comma-separated list of column names to display
26
26
  # @option arguments [Boolean] :help Return help information
27
27
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
28
- # @option arguments [String] :time The unit in which to display time values
29
- # (options: d,h,m,s,ms,micros,nanos)
30
-
28
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
31
29
  # @option arguments [Boolean] :ts Set to false to disable timestamping
32
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
33
31
  # @option arguments [Hash] :headers Custom HTTP headers
34
32
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-health.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-health.html
36
34
  #
37
35
  def health(arguments = {})
38
36
  headers = arguments.delete(:headers) || {}
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat.html
29
29
  #
30
30
  def help(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -23,29 +23,21 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names to limit the returned information
25
25
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26
- # @option arguments [String] :bytes The unit in which to display byte values
27
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
28
-
29
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
26
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
27
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
30
28
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
31
29
  # @option arguments [List] :h Comma-separated list of column names to display
32
- # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
33
- # (options: green,yellow,red)
34
-
30
+ # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
35
31
  # @option arguments [Boolean] :help Return help information
36
32
  # @option arguments [Boolean] :pri Set to true to return stats only for primary shards
37
33
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
38
- # @option arguments [String] :time The unit in which to display time values
39
- # (options: d,h,m,s,ms,micros,nanos)
40
-
34
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
41
35
  # @option arguments [Boolean] :v Verbose mode. Display column headers
42
36
  # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
43
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
44
- # (options: open,closed,hidden,none,all)
45
-
37
+ # @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)
46
38
  # @option arguments [Hash] :headers Custom HTTP headers
47
39
  #
48
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-indices.html
40
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-indices.html
49
41
  #
50
42
  def indices(arguments = {})
51
43
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-master.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-master.html
34
34
  #
35
35
  def master(arguments = {})
36
36
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-nodeattrs.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-nodeattrs.html
34
34
  #
35
35
  def nodeattrs(arguments = {})
36
36
  headers = arguments.delete(:headers) || {}
@@ -21,23 +21,19 @@ module Elasticsearch
21
21
  module Actions
22
22
  # Returns basic statistics about performance of cluster nodes.
23
23
  #
24
- # @option arguments [String] :bytes The unit in which to display byte values
25
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
26
-
24
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
27
25
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
28
26
  # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
29
- # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) *Deprecated*
27
+ # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) *Deprecated*
30
28
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
31
29
  # @option arguments [List] :h Comma-separated list of column names to display
32
30
  # @option arguments [Boolean] :help Return help information
33
31
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
34
- # @option arguments [String] :time The unit in which to display time values
35
- # (options: d,h,m,s,ms,micros,nanos)
36
-
32
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
37
33
  # @option arguments [Boolean] :v Verbose mode. Display column headers
38
34
  # @option arguments [Hash] :headers Custom HTTP headers
39
35
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-nodes.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-nodes.html
41
37
  #
42
38
  def nodes(arguments = {})
43
39
  headers = arguments.delete(:headers) || {}
@@ -27,13 +27,11 @@ module Elasticsearch
27
27
  # @option arguments [List] :h Comma-separated list of column names to display
28
28
  # @option arguments [Boolean] :help Return help information
29
29
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
30
- # @option arguments [String] :time The unit in which to display time values
31
- # (options: d,h,m,s,ms,micros,nanos)
32
-
30
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
33
31
  # @option arguments [Boolean] :v Verbose mode. Display column headers
34
32
  # @option arguments [Hash] :headers Custom HTTP headers
35
33
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-pending-tasks.html
34
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-pending-tasks.html
37
35
  #
38
36
  def pending_tasks(arguments = {})
39
37
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-plugins.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-plugins.html
34
34
  #
35
35
  def plugins(arguments = {})
36
36
  headers = arguments.delete(:headers) || {}
@@ -24,21 +24,16 @@ module Elasticsearch
24
24
  # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
25
25
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26
26
  # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries
27
- # @option arguments [String] :bytes The unit in which to display byte values
28
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
29
-
27
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
30
28
  # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries
31
29
  # @option arguments [List] :h Comma-separated list of column names to display
32
30
  # @option arguments [Boolean] :help Return help information
33
- # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
34
31
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
35
- # @option arguments [String] :time The unit in which to display time values
36
- # (options: d,h,m,s,ms,micros,nanos)
37
-
32
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
38
33
  # @option arguments [Boolean] :v Verbose mode. Display column headers
39
34
  # @option arguments [Hash] :headers Custom HTTP headers
40
35
  #
41
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-recovery.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-recovery.html
42
37
  #
43
38
  def recovery(arguments = {})
44
39
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
31
31
  # @option arguments [Hash] :headers Custom HTTP headers
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-repositories.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-repositories.html
34
34
  #
35
35
  def repositories(arguments = {})
36
36
  headers = arguments.delete(:headers) || {}
@@ -23,16 +23,14 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names to limit the returned information
25
25
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26
- # @option arguments [String] :bytes The unit in which to display byte values
27
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
28
-
26
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
29
27
  # @option arguments [List] :h Comma-separated list of column names to display
30
28
  # @option arguments [Boolean] :help Return help information
31
29
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
32
30
  # @option arguments [Boolean] :v Verbose mode. Display column headers
33
31
  # @option arguments [Hash] :headers Custom HTTP headers
34
32
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-segments.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-segments.html
36
34
  #
37
35
  def segments(arguments = {})
38
36
  headers = arguments.delete(:headers) || {}
@@ -23,21 +23,17 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names to limit the returned information
25
25
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26
- # @option arguments [String] :bytes The unit in which to display byte values
27
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
28
-
29
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
26
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
27
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
30
28
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
31
29
  # @option arguments [List] :h Comma-separated list of column names to display
32
30
  # @option arguments [Boolean] :help Return help information
33
31
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
34
- # @option arguments [String] :time The unit in which to display time values
35
- # (options: d,h,m,s,ms,micros,nanos)
36
-
32
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
37
33
  # @option arguments [Boolean] :v Verbose mode. Display column headers
38
34
  # @option arguments [Hash] :headers Custom HTTP headers
39
35
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-shards.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-shards.html
41
37
  #
42
38
  def shards(arguments = {})
43
39
  headers = arguments.delete(:headers) || {}
@@ -28,13 +28,11 @@ module Elasticsearch
28
28
  # @option arguments [List] :h Comma-separated list of column names to display
29
29
  # @option arguments [Boolean] :help Return help information
30
30
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
31
- # @option arguments [String] :time The unit in which to display time values
32
- # (options: d,h,m,s,ms,micros,nanos)
33
-
31
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
34
32
  # @option arguments [Boolean] :v Verbose mode. Display column headers
35
33
  # @option arguments [Hash] :headers Custom HTTP headers
36
34
  #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-snapshots.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-snapshots.html
38
36
  #
39
37
  def snapshots(arguments = {})
40
38
  headers = arguments.delete(:headers) || {}
@@ -22,20 +22,18 @@ module Elasticsearch
22
22
  # Returns information about the tasks currently executing on one or more nodes in the cluster.
23
23
  #
24
24
  # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
25
- # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
25
+ # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
26
26
  # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
27
27
  # @option arguments [Boolean] :detailed Return detailed task information (default: false)
28
- # @option arguments [Number] :parent_task Return tasks with specified parent task id. Set to -1 to return all.
28
+ # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
29
29
  # @option arguments [List] :h Comma-separated list of column names to display
30
30
  # @option arguments [Boolean] :help Return help information
31
31
  # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
32
- # @option arguments [String] :time The unit in which to display time values
33
- # (options: d,h,m,s,ms,micros,nanos)
34
-
32
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
35
33
  # @option arguments [Boolean] :v Verbose mode. Display column headers
36
34
  # @option arguments [Hash] :headers Custom HTTP headers
37
35
  #
38
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/tasks.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
39
37
  #
40
38
  def tasks(arguments = {})
41
39
  headers = arguments.delete(:headers) || {}
@@ -55,10 +53,10 @@ module Elasticsearch
55
53
  # @since 6.2.0
56
54
  ParamsRegistry.register(:tasks, [
57
55
  :format,
58
- :node_id,
56
+ :nodes,
59
57
  :actions,
60
58
  :detailed,
61
- :parent_task,
59
+ :parent_task_id,
62
60
  :h,
63
61
  :help,
64
62
  :s,
@@ -31,7 +31,7 @@ module Elasticsearch
31
31
  # @option arguments [Boolean] :v Verbose mode. Display column headers
32
32
  # @option arguments [Hash] :headers Custom HTTP headers
33
33
  #
34
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-templates.html
34
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/cat-templates.html
35
35
  #
36
36
  def templates(arguments = {})
37
37
  headers = arguments.delete(:headers) || {}