elasticsearch-api 6.2.0 → 6.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (184) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/abort_benchmark.rb +1 -1
  3. data/lib/elasticsearch/api/actions/benchmark.rb +1 -1
  4. data/lib/elasticsearch/api/actions/bulk.rb +4 -6
  5. data/lib/elasticsearch/api/actions/cat/aliases.rb +10 -10
  6. data/lib/elasticsearch/api/actions/cat/allocation.rb +11 -11
  7. data/lib/elasticsearch/api/actions/cat/count.rb +10 -10
  8. data/lib/elasticsearch/api/actions/cat/fielddata.rb +9 -7
  9. data/lib/elasticsearch/api/actions/cat/health.rb +11 -11
  10. data/lib/elasticsearch/api/actions/cat/help.rb +4 -2
  11. data/lib/elasticsearch/api/actions/cat/indices.rb +14 -15
  12. data/lib/elasticsearch/api/actions/cat/master.rb +10 -10
  13. data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +6 -4
  14. data/lib/elasticsearch/api/actions/cat/nodes.rb +10 -10
  15. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +10 -10
  16. data/lib/elasticsearch/api/actions/cat/plugins.rb +7 -6
  17. data/lib/elasticsearch/api/actions/cat/recovery.rb +10 -12
  18. data/lib/elasticsearch/api/actions/cat/repositories.rb +7 -3
  19. data/lib/elasticsearch/api/actions/cat/segments.rb +9 -7
  20. data/lib/elasticsearch/api/actions/cat/shards.rb +12 -12
  21. data/lib/elasticsearch/api/actions/cat/snapshots.rb +8 -4
  22. data/lib/elasticsearch/api/actions/cat/tasks.rb +4 -6
  23. data/lib/elasticsearch/api/actions/cat/templates.rb +6 -6
  24. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +13 -17
  25. data/lib/elasticsearch/api/actions/clear_scroll.rb +7 -0
  26. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +2 -3
  27. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +5 -2
  28. data/lib/elasticsearch/api/actions/cluster/health.rb +11 -20
  29. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +2 -3
  30. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +8 -3
  31. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +7 -1
  32. data/lib/elasticsearch/api/actions/cluster/reroute.rb +7 -7
  33. data/lib/elasticsearch/api/actions/cluster/state.rb +18 -15
  34. data/lib/elasticsearch/api/actions/cluster/stats.rb +12 -5
  35. data/lib/elasticsearch/api/actions/count.rb +12 -23
  36. data/lib/elasticsearch/api/actions/count_percolate.rb +1 -1
  37. data/lib/elasticsearch/api/actions/delete.rb +16 -8
  38. data/lib/elasticsearch/api/actions/delete_by_query.rb +7 -9
  39. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +29 -0
  40. data/lib/elasticsearch/api/actions/delete_script.rb +5 -6
  41. data/lib/elasticsearch/api/actions/exists.rb +3 -4
  42. data/lib/elasticsearch/api/actions/exists_source.rb +51 -0
  43. data/lib/elasticsearch/api/actions/explain.rb +11 -25
  44. data/lib/elasticsearch/api/actions/field_caps.rb +2 -2
  45. data/lib/elasticsearch/api/actions/get.rb +13 -19
  46. data/lib/elasticsearch/api/actions/get_script.rb +9 -2
  47. data/lib/elasticsearch/api/actions/get_source.rb +10 -14
  48. data/lib/elasticsearch/api/actions/index.rb +10 -16
  49. data/lib/elasticsearch/api/actions/indices/analyze.rb +3 -27
  50. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +2 -4
  51. data/lib/elasticsearch/api/actions/indices/close.rb +9 -15
  52. data/lib/elasticsearch/api/actions/indices/create.rb +7 -7
  53. data/lib/elasticsearch/api/actions/indices/delete.rb +3 -4
  54. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +7 -4
  55. data/lib/elasticsearch/api/actions/indices/delete_template.rb +5 -2
  56. data/lib/elasticsearch/api/actions/indices/exists.rb +11 -17
  57. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +6 -14
  58. data/lib/elasticsearch/api/actions/indices/exists_template.rb +8 -4
  59. data/lib/elasticsearch/api/actions/indices/exists_type.rb +6 -15
  60. data/lib/elasticsearch/api/actions/indices/flush.rb +5 -9
  61. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +1 -1
  62. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +13 -11
  63. data/lib/elasticsearch/api/actions/indices/freeze.rb +0 -1
  64. data/lib/elasticsearch/api/actions/indices/get.rb +9 -15
  65. data/lib/elasticsearch/api/actions/indices/get_alias.rb +6 -14
  66. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +11 -15
  67. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +12 -16
  68. data/lib/elasticsearch/api/actions/indices/get_settings.rb +12 -21
  69. data/lib/elasticsearch/api/actions/indices/get_template.rb +8 -5
  70. data/lib/elasticsearch/api/actions/indices/open.rb +9 -15
  71. data/lib/elasticsearch/api/actions/indices/put_alias.rb +6 -3
  72. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +11 -23
  73. data/lib/elasticsearch/api/actions/indices/put_settings.rb +10 -20
  74. data/lib/elasticsearch/api/actions/indices/put_template.rb +10 -5
  75. data/lib/elasticsearch/api/actions/indices/recovery.rb +2 -4
  76. data/lib/elasticsearch/api/actions/indices/refresh.rb +6 -14
  77. data/lib/elasticsearch/api/actions/indices/rollover.rb +6 -5
  78. data/lib/elasticsearch/api/actions/indices/segments.rb +6 -14
  79. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +2 -4
  80. data/lib/elasticsearch/api/actions/indices/shrink.rb +6 -7
  81. data/lib/elasticsearch/api/actions/indices/split.rb +2 -1
  82. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +7 -4
  83. data/lib/elasticsearch/api/actions/indices/upgrade.rb +10 -13
  84. data/lib/elasticsearch/api/actions/indices/validate_query.rb +14 -25
  85. data/lib/elasticsearch/api/actions/info.rb +6 -0
  86. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  87. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +4 -3
  88. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +29 -0
  89. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
  90. data/lib/elasticsearch/api/actions/ingest/simulate.rb +5 -5
  91. data/lib/elasticsearch/api/actions/mget.rb +8 -17
  92. data/lib/elasticsearch/api/actions/msearch.rb +7 -2
  93. data/lib/elasticsearch/api/actions/msearch_template.rb +8 -1
  94. data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -22
  95. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +4 -6
  96. data/lib/elasticsearch/api/actions/nodes/info.rb +6 -26
  97. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +10 -4
  98. data/lib/elasticsearch/api/actions/nodes/stats.rb +11 -30
  99. data/lib/elasticsearch/api/actions/nodes/usage.rb +31 -0
  100. data/lib/elasticsearch/api/actions/ping.rb +6 -0
  101. data/lib/elasticsearch/api/actions/put_script.rb +10 -9
  102. data/lib/elasticsearch/api/actions/rank_eval.rb +36 -0
  103. data/lib/elasticsearch/api/actions/reindex.rb +9 -14
  104. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +29 -0
  105. data/lib/elasticsearch/api/actions/render_search_template.rb +1 -1
  106. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +27 -0
  107. data/lib/elasticsearch/api/actions/scroll.rb +3 -2
  108. data/lib/elasticsearch/api/actions/search.rb +36 -53
  109. data/lib/elasticsearch/api/actions/search_shards.rb +7 -14
  110. data/lib/elasticsearch/api/actions/search_template.rb +20 -19
  111. data/lib/elasticsearch/api/actions/snapshot/create.rb +2 -3
  112. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +4 -3
  113. data/lib/elasticsearch/api/actions/snapshot/delete.rb +3 -3
  114. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -2
  115. data/lib/elasticsearch/api/actions/snapshot/get.rb +3 -3
  116. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +3 -6
  117. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  118. data/lib/elasticsearch/api/actions/snapshot/status.rb +4 -5
  119. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -2
  120. data/lib/elasticsearch/api/actions/tasks/cancel.rb +7 -13
  121. data/lib/elasticsearch/api/actions/tasks/get.rb +6 -3
  122. data/lib/elasticsearch/api/actions/tasks/list.rb +10 -16
  123. data/lib/elasticsearch/api/actions/termvectors.rb +22 -21
  124. data/lib/elasticsearch/api/actions/update.rb +19 -33
  125. data/lib/elasticsearch/api/actions/update_by_query.rb +13 -33
  126. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +29 -0
  127. data/lib/elasticsearch/api/version.rb +1 -1
  128. data/spec/elasticsearch/api/actions/cluster/state_spec.rb +0 -17
  129. data/spec/elasticsearch/api/actions/cluster/stats_spec.rb +17 -0
  130. data/spec/elasticsearch/api/actions/indices/analyze_spec.rb +0 -37
  131. data/spec/elasticsearch/api/actions/indices/put_settings_spec.rb +0 -15
  132. data/spec/elasticsearch/api/actions/indices/refresh_spec.rb +0 -15
  133. data/spec/elasticsearch/api/actions/indices/segments_spec.rb +0 -15
  134. data/spec/elasticsearch/api/actions/mget_spec.rb +0 -15
  135. data/spec/elasticsearch/api/actions/search_spec.rb +0 -15
  136. data/test/integration/yaml_test_runner.rb +2 -4
  137. data/utils/thor/generate_source.rb +1 -0
  138. data/utils/thor/templates/ruby/method.erb +7 -5
  139. metadata +12 -73
  140. data/lib/elasticsearch/api/actions/delete_template.rb +0 -21
  141. data/lib/elasticsearch/api/actions/field_stats.rb +0 -36
  142. data/lib/elasticsearch/api/actions/get_template.rb +0 -27
  143. data/lib/elasticsearch/api/actions/indices/delete_mapping.rb +0 -26
  144. data/lib/elasticsearch/api/actions/indices/delete_warmer.rb +0 -32
  145. data/lib/elasticsearch/api/actions/indices/get_aliases.rb +0 -37
  146. data/lib/elasticsearch/api/actions/indices/get_warmer.rb +0 -62
  147. data/lib/elasticsearch/api/actions/indices/optimize.rb +0 -77
  148. data/lib/elasticsearch/api/actions/indices/put_warmer.rb +0 -65
  149. data/lib/elasticsearch/api/actions/indices/seal.rb +0 -24
  150. data/lib/elasticsearch/api/actions/indices/snapshot_index.rb +0 -44
  151. data/lib/elasticsearch/api/actions/indices/status.rb +0 -63
  152. data/lib/elasticsearch/api/actions/list_benchmarks.rb +0 -27
  153. data/lib/elasticsearch/api/actions/mlt.rb +0 -130
  154. data/lib/elasticsearch/api/actions/mpercolate.rb +0 -62
  155. data/lib/elasticsearch/api/actions/nodes/shutdown.rb +0 -39
  156. data/lib/elasticsearch/api/actions/percolate.rb +0 -73
  157. data/lib/elasticsearch/api/actions/put_template.rb +0 -25
  158. data/lib/elasticsearch/api/actions/remote/info.rb +0 -21
  159. data/lib/elasticsearch/api/actions/search_exists.rb +0 -63
  160. data/lib/elasticsearch/api/actions/suggest.rb +0 -49
  161. data/spec/elasticsearch/api/actions/delete_template_spec.rb +0 -17
  162. data/spec/elasticsearch/api/actions/field_stats_spec.rb +0 -17
  163. data/spec/elasticsearch/api/actions/get_template_spec.rb +0 -52
  164. data/spec/elasticsearch/api/actions/indices/delete_mapping_spec.rb +0 -77
  165. data/spec/elasticsearch/api/actions/indices/delete_warmer_spec.rb +0 -86
  166. data/spec/elasticsearch/api/actions/indices/freeze_spec.rb +0 -68
  167. data/spec/elasticsearch/api/actions/indices/get_aliases_spec.rb +0 -55
  168. data/spec/elasticsearch/api/actions/indices/get_warmer_spec.rb +0 -48
  169. data/spec/elasticsearch/api/actions/indices/optimize_spec.rb +0 -63
  170. data/spec/elasticsearch/api/actions/indices/put_warmer_spec.rb +0 -101
  171. data/spec/elasticsearch/api/actions/indices/seal_spec.rb +0 -18
  172. data/spec/elasticsearch/api/actions/indices/snapshot_index_spec.rb +0 -89
  173. data/spec/elasticsearch/api/actions/indices/stats_spec.rb +0 -108
  174. data/spec/elasticsearch/api/actions/indices/status_spec.rb +0 -92
  175. data/spec/elasticsearch/api/actions/indices/unfreeze_spec.rb +0 -68
  176. data/spec/elasticsearch/api/actions/list_benchmarks_spec.rb +0 -17
  177. data/spec/elasticsearch/api/actions/mlt_spec.rb +0 -117
  178. data/spec/elasticsearch/api/actions/mpercolate_spec.rb +0 -49
  179. data/spec/elasticsearch/api/actions/nodes/shutdown_spec.rb +0 -59
  180. data/spec/elasticsearch/api/actions/percolate_spec.rb +0 -67
  181. data/spec/elasticsearch/api/actions/put_template_spec.rb +0 -17
  182. data/spec/elasticsearch/api/actions/remote/info_spec.rb +0 -18
  183. data/spec/elasticsearch/api/actions/search_exists_spec.rb +0 -17
  184. data/spec/elasticsearch/api/actions/suggest_spec.rb +0 -77
@@ -22,23 +22,12 @@ module Elasticsearch
22
22
  #
23
23
  # client.nodes.info metric: ['http', 'network']
24
24
  #
25
- # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
26
- # use `_local` to return information from the node you're connecting to, leave
27
- # empty to get information from all nodes
28
- # @option arguments [Boolean] :_all Return all available information
29
- # @option arguments [Boolean] :http Return information about HTTP
30
- # @option arguments [Boolean] :jvm Return information about the JVM
31
- # @option arguments [Boolean] :network Return information about network
32
- # @option arguments [Boolean] :os Return information about the operating system
33
- # @option arguments [Boolean] :plugins Return information about plugins
34
- # @option arguments [Boolean] :process Return information about the Elasticsearch process
35
- # @option arguments [Boolean] :settings Return information about node settings
36
- # @option arguments [Boolean] :thread_pool Return information about the thread pool
37
- # @option arguments [Boolean] :transport Return information about transport
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
26
+ # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Leave empty to return all. (options: settings,os,process,jvm,thread_pool,transport,http,plugins,ingest)
38
27
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
39
28
  # @option arguments [Time] :timeout Explicit operation timeout
40
29
  #
41
- # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
30
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
42
31
  #
43
32
  def info(arguments={})
44
33
  arguments = arguments.clone
@@ -63,20 +52,11 @@ module Elasticsearch
63
52
  # @since 6.2.0
64
53
  ParamsRegistry.register(:info_params, [ :flat_settings, :timeout ].freeze)
65
54
 
66
- # Register this action with its valid parts when the module is loaded.
55
+ # Register this action with its valid params when the module is loaded.
67
56
  #
68
57
  # @since 6.2.0
69
- ParamsRegistry.register(:info_parts, [
70
- :_all,
71
- :http,
72
- :jvm,
73
- :network,
74
- :os,
75
- :plugins,
76
- :process,
77
- :settings,
78
- :thread_pool,
79
- :transport,
58
+ ParamsRegistry.register(:info, [
59
+ :flat_settings,
80
60
  :timeout ].freeze)
81
61
  end
82
62
  end
@@ -14,10 +14,10 @@ module Elasticsearch
14
14
  #
15
15
  # client.nodes.reload_secure_settings(node_id: 'foo,bar')
16
16
  #
17
- # @option arguments [ Array ] :node_id A comma-separated list of node IDs or names to perform the operation on
18
- # @option arguments [ String ] :timeout Explicit operation timeout
17
+ # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
18
+ # @option arguments [Time] :timeout Explicit operation timeout
19
19
  #
20
- # @see http://elasticsearch.org/guide/reference/api/cluster-nodes-reload-secure-settings
20
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/6.x/secure-settings.html#reloadable-secure-settings
21
21
  #
22
22
  def reload_secure_settings(arguments={})
23
23
  valid_params = [
@@ -31,7 +31,13 @@ module Elasticsearch
31
31
 
32
32
  perform_request(method, path, params, body).body
33
33
  end
34
+
35
+ # Register this action with its valid params when the module is loaded.
36
+ #
37
+ # @since 6.2.0
38
+ ParamsRegistry.register(:reload_secure_settings, [
39
+ :timeout ].freeze)
34
40
  end
35
41
  end
36
42
  end
37
- end
43
+ end
@@ -13,34 +13,19 @@ module Elasticsearch
13
13
  #
14
14
  # client.nodes.stats metric: 'indices', index_metric: 'fielddata', fields: '*', human: true
15
15
  #
16
- # @option arguments [List] :metric Limit the information returned to the specified metrics
17
- # (options: _all, breaker, fs, http, indices, jvm, network,
18
- # os, process, thread_pool, transport)
19
- # @option arguments [List] :index_metric Limit the information returned for the `indices` metric
20
- # to the specified index metrics. Used only when
21
- # `indices` or `all` metric is specified.
22
- # (options: _all, completion, docs, fielddata, filter_cache, flush, get,
23
- # id_cache, indexing, merge, percolate, refresh, search, segments, store,
24
- # warmer)
25
- # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit
26
- # the returned information; use `_local` to return information
27
- # from the node you're connecting to, leave empty to get information
28
- # from all nodes
29
- # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest`
30
- # index metrics (supports wildcards)
31
- # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric
32
- # (supports wildcards)
33
- # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index
34
- # metrics (supports wildcards)
35
- # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files. Only applies if segment stats are requested. (default: false)
16
+ # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all,breaker,fs,http,indices,jvm,os,process,thread_pool,transport,discovery)
17
+ # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
18
+ # @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
19
+ # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
20
+ # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
21
+ # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
36
22
  # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
37
- # @option arguments [Boolean] :human Whether to return time and byte values in human-readable format
38
- # @option arguments [String] :level Specify the level for aggregating indices stats
39
- # (options: node, indices, shards)
23
+ # @option arguments [String] :level Return indices stats aggregated at index, node or shard level (options: indices, node, shards)
40
24
  # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
41
25
  # @option arguments [Time] :timeout Explicit operation timeout
26
+ # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
42
27
  #
43
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
28
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
44
29
  #
45
30
  def stats(arguments={})
46
31
  arguments = arguments.clone
@@ -67,18 +52,14 @@ module Elasticsearch
67
52
  #
68
53
  # @since 6.2.0
69
54
  ParamsRegistry.register(:stats, [
70
- :metric,
71
- :index_metric,
72
- :node_id,
73
55
  :completion_fields,
74
56
  :fielddata_fields,
75
57
  :fields,
76
- :include_segment_file_sizes,
77
58
  :groups,
78
- :human,
79
59
  :level,
80
60
  :types,
81
- :timeout ].freeze)
61
+ :timeout,
62
+ :include_segment_file_sizes ].freeze)
82
63
  end
83
64
  end
84
65
  end
@@ -0,0 +1,31 @@
1
+ module Elasticsearch
2
+ module API
3
+ module Nodes
4
+ module Actions
5
+
6
+ # The cluster nodes usage API allows to retrieve information on the usage of features for each node.
7
+ #
8
+ # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all,rest_actions)
9
+ # @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
10
+ # @option arguments [Time] :timeout Explicit operation timeout
11
+ #
12
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html
13
+ #
14
+ def usage(arguments={})
15
+ method = Elasticsearch::API::HTTP_GET
16
+ path = "_nodes/usage"
17
+ params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
18
+ body = nil
19
+
20
+ perform_request(method, path, params, body).body
21
+ end
22
+
23
+ # Register this action with its valid params when the module is loaded.
24
+ #
25
+ # @since 6.2.0
26
+ ParamsRegistry.register(:usage, [
27
+ :timeout ].freeze)
28
+ end
29
+ end
30
+ end
31
+ end
@@ -26,6 +26,12 @@ module Elasticsearch
26
26
  end
27
27
  end
28
28
  end
29
+
30
+ # Register this action with its valid params when the module is loaded.
31
+ #
32
+ # @since 6.2.0
33
+ ParamsRegistry.register(:ping, [
34
+ ].freeze)
29
35
  end
30
36
  end
31
37
  end
@@ -19,13 +19,13 @@ module Elasticsearch
19
19
  # }
20
20
  #
21
21
  # @option arguments [String] :id Script ID (*Required*)
22
- # @option arguments [String] :lang Script language
23
- # @option arguments [Hash] :body A JSON document containing the script (*Required*)
24
- # @option arguments [Number] :version Explicit version number for concurrency control
25
- # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
26
- # @option arguments [String] :op_type Explicit operation type (options: index, create)
22
+ # @option arguments [String] :context Script context
23
+ # @option arguments [Hash] :body The document (*Required*)
24
+ # @option arguments [Time] :timeout Explicit operation timeout
25
+ # @option arguments [Time] :master_timeout Specify timeout for connection to master
26
+ # @option arguments [String] :context Context name to compile script against
27
27
  #
28
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
28
+ # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html#_indexed_scripts
29
29
  #
30
30
  def put_script(arguments={})
31
31
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -40,13 +40,14 @@ module Elasticsearch
40
40
  perform_request(method, path, params, body).body
41
41
  end
42
42
 
43
+
43
44
  # Register this action with its valid params when the module is loaded.
44
45
  #
45
46
  # @since 6.2.0
46
47
  ParamsRegistry.register(:put_script, [
47
- :op_type,
48
- :version,
49
- :version_type ].freeze)
48
+ :timeout,
49
+ :master_timeout,
50
+ :context ].freeze)
50
51
  end
51
52
  end
52
53
  end
@@ -0,0 +1,36 @@
1
+ module Elasticsearch
2
+ module API
3
+ module Actions
4
+
5
+ # The ranking evaluation API allows to evaluate the quality of ranked search results over a set of typical search queries.
6
+ # Given this set of queries and a list of manually rated documents, the _rank_eval endpoint calculates and
7
+ # returns typical information retrieval metrics like mean reciprocal rank, precision or discounted cumulative gain.
8
+ #
9
+ # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
10
+ # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
11
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
12
+ # @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)
13
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
14
+ #
15
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html
16
+ #
17
+ def rank_eval(arguments={})
18
+ raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
19
+ method = Elasticsearch::API::HTTP_GET
20
+ path = "_rank_eval"
21
+ params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
22
+ body = arguments[:body]
23
+
24
+ perform_request(method, path, params, body).body
25
+ end
26
+
27
+ # Register this action with its valid params when the module is loaded.
28
+ #
29
+ # @since 6.2.0
30
+ ParamsRegistry.register(:rank_eval, [
31
+ :ignore_unavailable,
32
+ :allow_no_indices,
33
+ :expand_wildcards ].freeze)
34
+ end
35
+ end
36
+ end
@@ -35,19 +35,14 @@ module Elasticsearch
35
35
  # }
36
36
  # }
37
37
  #
38
- # @option arguments [Hash] :body The definition of the operation (source index, target index, ...)
39
- # (*Required*)
40
- # @option arguments [Boolean] :refresh Whether the affected indexes should be refreshed
41
- # @option arguments [Time] :timeout Time each individual bulk request should wait for shards
42
- # that are unavailable. (Default: 1m)
43
- # @option arguments [String] :consistency Explicit write consistency setting for the operation
44
- # (Options: one, quorum, all)
45
- # @option arguments [Boolean] :wait_for_completion Whether the request should block and wait until
46
- # the operation has completed
47
- # @option arguments [Float] :requests_per_second The throttling for this request in sub-requests per second.
48
- # 0 means set no throttling (default)
49
- # @option arguments [Integer] :slices The number of slices this request should be divided into.
50
- # Defaults to 1 meaning the request isn't sliced into sub-requests.
38
+ # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
39
+ # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
40
+ # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
41
+ # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex 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)
42
+ # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
43
+ # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
44
+ # @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
45
+ #
51
46
  #
52
47
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
53
48
  #
@@ -67,7 +62,7 @@ module Elasticsearch
67
62
  ParamsRegistry.register(:reindex, [
68
63
  :refresh,
69
64
  :timeout,
70
- :consistency,
65
+ :wait_for_active_shards,
71
66
  :wait_for_completion,
72
67
  :requests_per_second,
73
68
  :slices ].freeze)
@@ -0,0 +1,29 @@
1
+ module Elasticsearch
2
+ module API
3
+ module Actions
4
+
5
+ # The value of requests_per_second can be changed on a running reindex using the _rethrottle
6
+ #
7
+ # @option arguments [String] :task_id The task id to rethrottle (*Required*)
8
+ # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
9
+ #
10
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
11
+ #
12
+ def reindex_rethrottle(arguments={})
13
+ raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
14
+ method = Elasticsearch::API::HTTP_POST
15
+ path = "_reindex/#{arguments[:task_id]}/_rethrottle"
16
+ params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
17
+ body = nil
18
+
19
+ perform_request(method, path, params, body).body
20
+ end
21
+
22
+ # Register this action with its valid params when the module is loaded.
23
+ #
24
+ # @since 6.2.0
25
+ ParamsRegistry.register(:reindex_rethrottle, [
26
+ :requests_per_second ].freeze)
27
+ end
28
+ end
29
+ end
@@ -7,7 +7,7 @@ module Elasticsearch
7
7
  # @option arguments [String] :id The id of the stored search template
8
8
  # @option arguments [Hash] :body The search definition template and its params
9
9
  #
10
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
10
+ # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html
11
11
  #
12
12
  def render_search_template(arguments={})
13
13
  method = 'GET'
@@ -0,0 +1,27 @@
1
+ module Elasticsearch
2
+ module API
3
+ module Actions
4
+
5
+ # The Painless execute API allows an arbitrary script to be executed and a result to be returned.
6
+ #
7
+ # @option arguments [Hash] :body The script to execute
8
+ #
9
+ # @see https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html
10
+ #
11
+ def scripts_painless_execute(arguments={})
12
+ method = Elasticsearch::API::HTTP_GET
13
+ path = "_scripts/painless/_execute"
14
+ params = {}
15
+ body = arguments[:body]
16
+
17
+ perform_request(method, path, params, body).body
18
+ end
19
+
20
+ # Register this action with its valid params when the module is loaded.
21
+ #
22
+ # @since 6.2.0
23
+ ParamsRegistry.register(:scripts_painless_execute, [
24
+ ].freeze)
25
+ end
26
+ end
27
+ end
@@ -42,8 +42,9 @@ module Elasticsearch
42
42
  #
43
43
  # @option arguments [String] :scroll_id The scroll ID
44
44
  # @option arguments [Hash] :body The scroll ID if not passed by URL or query parameter.
45
- # @option arguments [Duration] :scroll Specify how long a consistent view of the index
46
- # should be maintained for scrolled search
45
+ # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
46
+ # @option arguments [String] :scroll_id The scroll ID for scrolled search
47
+ # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
47
48
  #
48
49
  # @see http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/scan-scroll.html#scan-scroll
49
50
  # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
@@ -62,62 +62,50 @@ module Elasticsearch
62
62
  #
63
63
  # response.aggregations.tags.terms.to_a.map { |f| "#{f.term} [#{f.count}]" }.join(', ')
64
64
  #
65
- # @option arguments [List] :index A comma-separated list of index names to search; use `_all`
66
- # or empty string to perform the operation on all indices
67
- # @option arguments [List] :type A comma-separated list of document types to search;
68
- # leave empty to perform the operation on all types
65
+ #
66
+ # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
67
+ # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
69
68
  # @option arguments [Hash] :body The search definition using the Query DSL
70
69
  # @option arguments [String] :analyzer The analyzer to use for the query string
71
- # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed
72
- # (default: false)
73
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
74
- # (options: AND, OR)
70
+ # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
71
+ # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
75
72
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
76
- # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation
77
- # as part of a hit
78
- # @option arguments [List] :fields A comma-separated list of fields to return as part of a hit
79
- # @option arguments [List] :fielddata_fields A comma-separated list of fields to return as the field data
80
- # representation of a field for each hit
81
- # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue
82
- # representation of a field for each hit
73
+ # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
83
74
  # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
75
+ # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
84
76
  # @option arguments [Number] :from Starting offset (default: 0)
85
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
86
- # (options: none, missing)
87
- # @option arguments [Boolean] :lenient Specify whether format-based query failures
88
- # (such as providing text to a numeric field) should be ignored
89
- # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
90
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on
91
- # (default: random)
77
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
78
+ # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
79
+ # @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)
80
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
81
+ # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
82
+ # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
92
83
  # @option arguments [String] :q Query in the Lucene query string syntax
93
- # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request
94
- # (defaults to index level setting)
95
84
  # @option arguments [List] :routing A comma-separated list of specific routing values
96
- # @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained
97
- # for scrolled search
98
- # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch,
99
- # dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
85
+ # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
86
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
100
87
  # @option arguments [Number] :size Number of hits to return (default: 10)
101
88
  # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
102
- # @option arguments [String] :source The URL-encoded request definition using the Query DSL
103
- # (instead of using request body)
104
- # @option arguments [String] :_source Specify whether the _source field should be returned,
105
- # or a list of fields to return
106
- # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
107
- # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
108
- # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
89
+ # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
90
+ # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
91
+ # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
92
+ # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
109
93
  # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
110
94
  # @option arguments [String] :suggest_field Specify which field to use for suggestions
111
95
  # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
112
96
  # @option arguments [Number] :suggest_size How many suggestions to return in response
113
- # @option arguments [Text] :suggest_text The source text for which the suggestions should be returned
114
- # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard
97
+ # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
115
98
  # @option arguments [Time] :timeout Explicit operation timeout
99
+ # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
100
+ # @option arguments [Boolean] :track_total_hits Indicate if the number of documents that match the query should be tracked
101
+ # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
116
102
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
117
103
  # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
104
+ # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
118
105
  # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
119
- # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. The default grows with the number of nodes in the cluster but is at most 256.
120
- # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. (Default: 128)
106
+ # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
107
+ # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
108
+ # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
121
109
  #
122
110
  # @return [Hash]
123
111
  #
@@ -151,47 +139,42 @@ module Elasticsearch
151
139
  :default_operator,
152
140
  :df,
153
141
  :explain,
154
- :fielddata_fields,
155
- :docvalue_fields,
156
142
  :stored_fields,
157
- :fields,
143
+ :docvalue_fields,
158
144
  :from,
159
- :ignore_indices,
160
145
  :ignore_unavailable,
146
+ :ignore_throttled,
161
147
  :allow_no_indices,
162
148
  :expand_wildcards,
163
149
  :lenient,
164
- :lowercase_expanded_terms,
165
150
  :preference,
166
151
  :q,
167
- :query_cache,
168
- :request_cache,
169
152
  :routing,
170
153
  :scroll,
171
154
  :search_type,
172
155
  :size,
173
156
  :sort,
174
- :source,
175
157
  :_source,
176
- :_source_include,
177
- :_source_includes,
178
- :_source_exclude,
179
158
  :_source_excludes,
180
- :stored_fields,
159
+ :_source_includes,
160
+ :terminate_after,
181
161
  :stats,
182
162
  :suggest_field,
183
163
  :suggest_mode,
184
164
  :suggest_size,
185
165
  :suggest_text,
186
- :terminate_after,
187
166
  :timeout,
167
+ :track_scores,
168
+ :track_total_hits,
169
+ :allow_partial_search_results,
188
170
  :typed_keys,
189
171
  :version,
172
+ :request_cache,
190
173
  :batched_reduce_size,
191
174
  :max_concurrent_shard_requests,
192
175
  :pre_filter_shard_size,
193
176
  :rest_total_hits_as_int,
194
- :ignore_throttled ].freeze)
177
+ :seq_no_primary_term ].freeze)
195
178
  end
196
179
  end
197
180
  end