elasticsearch-api 7.9.0.pre → 7.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (155) hide show
  1. checksums.yaml +4 -4
  2. data/lib/elasticsearch/api/actions/bulk.rb +2 -4
  3. data/lib/elasticsearch/api/actions/cat/aliases.rb +2 -4
  4. data/lib/elasticsearch/api/actions/cat/allocation.rb +2 -4
  5. data/lib/elasticsearch/api/actions/cat/count.rb +1 -1
  6. data/lib/elasticsearch/api/actions/cat/fielddata.rb +2 -4
  7. data/lib/elasticsearch/api/actions/cat/health.rb +2 -4
  8. data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
  9. data/lib/elasticsearch/api/actions/cat/indices.rb +5 -13
  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 +4 -8
  13. data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +2 -4
  14. data/lib/elasticsearch/api/actions/cat/plugins.rb +1 -1
  15. data/lib/elasticsearch/api/actions/cat/recovery.rb +3 -7
  16. data/lib/elasticsearch/api/actions/cat/repositories.rb +1 -1
  17. data/lib/elasticsearch/api/actions/cat/segments.rb +2 -4
  18. data/lib/elasticsearch/api/actions/cat/shards.rb +3 -7
  19. data/lib/elasticsearch/api/actions/cat/snapshots.rb +2 -4
  20. data/lib/elasticsearch/api/actions/cat/tasks.rb +2 -4
  21. data/lib/elasticsearch/api/actions/cat/templates.rb +1 -1
  22. data/lib/elasticsearch/api/actions/cat/thread_pool.rb +2 -4
  23. data/lib/elasticsearch/api/actions/clear_scroll.rb +2 -2
  24. data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +1 -1
  25. data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +5 -1
  26. data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +1 -1
  27. data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +5 -1
  28. data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +5 -1
  29. data/lib/elasticsearch/api/actions/cluster/get_settings.rb +1 -1
  30. data/lib/elasticsearch/api/actions/cluster/health.rb +5 -13
  31. data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +1 -1
  32. data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +1 -1
  33. data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +5 -1
  34. data/lib/elasticsearch/api/actions/cluster/put_settings.rb +1 -1
  35. data/lib/elasticsearch/api/actions/cluster/remote_info.rb +1 -1
  36. data/lib/elasticsearch/api/actions/cluster/reroute.rb +2 -4
  37. data/lib/elasticsearch/api/actions/cluster/state.rb +3 -7
  38. data/lib/elasticsearch/api/actions/cluster/stats.rb +1 -1
  39. data/lib/elasticsearch/api/actions/count.rb +3 -7
  40. data/lib/elasticsearch/api/actions/create.rb +4 -8
  41. data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
  42. data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
  43. data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +1 -1
  44. data/lib/elasticsearch/api/actions/delete.rb +4 -8
  45. data/lib/elasticsearch/api/actions/delete_by_query.rb +6 -14
  46. data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +2 -2
  47. data/lib/elasticsearch/api/actions/delete_script.rb +1 -1
  48. data/lib/elasticsearch/api/actions/exists.rb +3 -5
  49. data/lib/elasticsearch/api/actions/exists_source.rb +3 -5
  50. data/lib/elasticsearch/api/actions/explain.rb +3 -5
  51. data/lib/elasticsearch/api/actions/field_caps.rb +2 -4
  52. data/lib/elasticsearch/api/actions/get.rb +3 -5
  53. data/lib/elasticsearch/api/actions/get_script.rb +1 -1
  54. data/lib/elasticsearch/api/actions/get_script_context.rb +5 -1
  55. data/lib/elasticsearch/api/actions/get_script_languages.rb +5 -1
  56. data/lib/elasticsearch/api/actions/get_source.rb +3 -5
  57. data/lib/elasticsearch/api/actions/index.rb +5 -11
  58. data/lib/elasticsearch/api/actions/indices/add_block.rb +2 -4
  59. data/lib/elasticsearch/api/actions/indices/analyze.rb +1 -1
  60. data/lib/elasticsearch/api/actions/indices/clear_cache.rb +2 -4
  61. data/lib/elasticsearch/api/actions/indices/clone.rb +1 -1
  62. data/lib/elasticsearch/api/actions/indices/close.rb +2 -4
  63. data/lib/elasticsearch/api/actions/indices/create.rb +1 -1
  64. data/lib/elasticsearch/api/actions/indices/delete.rb +2 -4
  65. data/lib/elasticsearch/api/actions/indices/delete_alias.rb +1 -1
  66. data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +5 -1
  67. data/lib/elasticsearch/api/actions/indices/delete_template.rb +1 -1
  68. data/lib/elasticsearch/api/actions/indices/exists.rb +2 -4
  69. data/lib/elasticsearch/api/actions/indices/exists_alias.rb +2 -4
  70. data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +5 -1
  71. data/lib/elasticsearch/api/actions/indices/exists_template.rb +1 -1
  72. data/lib/elasticsearch/api/actions/indices/exists_type.rb +2 -4
  73. data/lib/elasticsearch/api/actions/indices/flush.rb +2 -4
  74. data/lib/elasticsearch/api/actions/indices/flush_synced.rb +2 -4
  75. data/lib/elasticsearch/api/actions/indices/forcemerge.rb +2 -4
  76. data/lib/elasticsearch/api/actions/indices/get.rb +2 -4
  77. data/lib/elasticsearch/api/actions/indices/get_alias.rb +2 -4
  78. data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +3 -5
  79. data/lib/elasticsearch/api/actions/indices/get_index_template.rb +5 -1
  80. data/lib/elasticsearch/api/actions/indices/get_mapping.rb +4 -6
  81. data/lib/elasticsearch/api/actions/indices/get_settings.rb +2 -4
  82. data/lib/elasticsearch/api/actions/indices/get_template.rb +1 -1
  83. data/lib/elasticsearch/api/actions/indices/get_upgrade.rb +2 -4
  84. data/lib/elasticsearch/api/actions/indices/open.rb +2 -4
  85. data/lib/elasticsearch/api/actions/indices/put_alias.rb +1 -1
  86. data/lib/elasticsearch/api/actions/indices/put_index_template.rb +5 -1
  87. data/lib/elasticsearch/api/actions/indices/put_mapping.rb +3 -5
  88. data/lib/elasticsearch/api/actions/indices/put_settings.rb +2 -4
  89. data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
  90. data/lib/elasticsearch/api/actions/indices/recovery.rb +1 -1
  91. data/lib/elasticsearch/api/actions/indices/refresh.rb +2 -4
  92. data/lib/elasticsearch/api/actions/indices/resolve_index.rb +6 -4
  93. data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
  94. data/lib/elasticsearch/api/actions/indices/segments.rb +2 -4
  95. data/lib/elasticsearch/api/actions/indices/shard_stores.rb +3 -7
  96. data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -1
  97. data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +5 -1
  98. data/lib/elasticsearch/api/actions/indices/simulate_template.rb +5 -1
  99. data/lib/elasticsearch/api/actions/indices/split.rb +1 -1
  100. data/lib/elasticsearch/api/actions/indices/stats.rb +4 -10
  101. data/lib/elasticsearch/api/actions/indices/update_aliases.rb +1 -1
  102. data/lib/elasticsearch/api/actions/indices/upgrade.rb +2 -4
  103. data/lib/elasticsearch/api/actions/indices/validate_query.rb +4 -8
  104. data/lib/elasticsearch/api/actions/info.rb +1 -1
  105. data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +1 -1
  106. data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +1 -1
  107. data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +1 -1
  108. data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +1 -1
  109. data/lib/elasticsearch/api/actions/ingest/simulate.rb +1 -1
  110. data/lib/elasticsearch/api/actions/mget.rb +2 -2
  111. data/lib/elasticsearch/api/actions/msearch.rb +2 -4
  112. data/lib/elasticsearch/api/actions/msearch_template.rb +2 -4
  113. data/lib/elasticsearch/api/actions/mtermvectors.rb +2 -4
  114. data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +2 -4
  115. data/lib/elasticsearch/api/actions/nodes/info.rb +2 -4
  116. data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +1 -1
  117. data/lib/elasticsearch/api/actions/nodes/stats.rb +4 -10
  118. data/lib/elasticsearch/api/actions/nodes/usage.rb +2 -4
  119. data/lib/elasticsearch/api/actions/ping.rb +1 -1
  120. data/lib/elasticsearch/api/actions/put_script.rb +1 -1
  121. data/lib/elasticsearch/api/actions/rank_eval.rb +7 -7
  122. data/lib/elasticsearch/api/actions/reindex.rb +1 -1
  123. data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +2 -2
  124. data/lib/elasticsearch/api/actions/render_search_template.rb +1 -1
  125. data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +5 -1
  126. data/lib/elasticsearch/api/actions/scroll.rb +2 -2
  127. data/lib/elasticsearch/api/actions/search.rb +5 -13
  128. data/lib/elasticsearch/api/actions/search_shards.rb +2 -4
  129. data/lib/elasticsearch/api/actions/search_template.rb +3 -7
  130. data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +1 -1
  131. data/lib/elasticsearch/api/actions/snapshot/create.rb +1 -1
  132. data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +1 -1
  133. data/lib/elasticsearch/api/actions/snapshot/delete.rb +1 -1
  134. data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +1 -1
  135. data/lib/elasticsearch/api/actions/snapshot/get.rb +1 -1
  136. data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
  137. data/lib/elasticsearch/api/actions/snapshot/restore.rb +1 -1
  138. data/lib/elasticsearch/api/actions/snapshot/status.rb +1 -1
  139. data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +1 -1
  140. data/lib/elasticsearch/api/actions/tasks/cancel.rb +1 -1
  141. data/lib/elasticsearch/api/actions/tasks/get.rb +1 -1
  142. data/lib/elasticsearch/api/actions/tasks/list.rb +2 -4
  143. data/lib/elasticsearch/api/actions/termvectors.rb +3 -5
  144. data/lib/elasticsearch/api/actions/update.rb +3 -5
  145. data/lib/elasticsearch/api/actions/update_by_query.rb +6 -14
  146. data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +2 -2
  147. data/lib/elasticsearch/api/version.rb +1 -1
  148. data/utils/thor/generate_source.rb +32 -4
  149. data/utils/thor/templates/_documentation_top.erb +1 -0
  150. metadata +5 -11
  151. data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +0 -49
  152. data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +0 -62
  153. data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +0 -48
  154. data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +0 -50
  155. data/spec/elasticsearch/api/actions/indices/data_streams_stats_spec.rb +0 -72
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [Hash] :headers Custom HTTP headers
24
24
  #
25
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index.html
25
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/index.html
26
26
  #
27
27
  def info(arguments = {})
28
28
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :timeout Explicit operation timeout
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-pipeline-api.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/delete-pipeline-api.html
30
30
  #
31
31
  def delete_pipeline(arguments = {})
32
32
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-pipeline-api.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/get-pipeline-api.html
29
29
  #
30
30
  def get_pipeline(arguments = {})
31
31
  headers = arguments.delete(:headers) || {}
@@ -23,7 +23,7 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [Hash] :headers Custom HTTP headers
25
25
  #
26
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/grok-processor.html#grok-processor-rest-get
26
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/grok-processor.html#grok-processor-rest-get
27
27
  #
28
28
  def processor_grok(arguments = {})
29
29
  headers = arguments.delete(:headers) || {}
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body The ingest definition (*Required*)
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-pipeline-api.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/put-pipeline-api.html
31
31
  #
32
32
  def put_pipeline(arguments = {})
33
33
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body The simulate definition (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/simulate-pipeline-api.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/simulate-pipeline-api.html
30
30
  #
31
31
  def simulate(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -21,7 +21,7 @@ module Elasticsearch
21
21
  # Allows to get multiple documents in one request.
22
22
  #
23
23
  # @option arguments [String] :index The name of the index
24
- # @option arguments [String] :type The type of the document *Deprecated*
24
+ # @option arguments [String] :type The type of the document *Deprecated*
25
25
  # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
26
26
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
27
27
  # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
@@ -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.x/docs-multi-get.html
41
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-multi-get.html
42
42
  #
43
43
  def mget(arguments = {})
44
44
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -22,9 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [List] :index A comma-separated list of index names to use as default
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
- # @option arguments [String] :search_type Search operation type
26
- # (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
27
-
25
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
28
26
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
29
27
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
30
28
  # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
@@ -39,7 +37,7 @@ module Elasticsearch
39
37
  # Deprecated since version 7.0.0
40
38
  #
41
39
  #
42
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-multi-search.html
40
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-multi-search.html
43
41
  #
44
42
  def msearch(arguments = {})
45
43
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -22,9 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [List] :index A comma-separated list of index names to use as default
24
24
  # @option arguments [List] :type A comma-separated list of document types to use as default
25
- # @option arguments [String] :search_type Search operation type
26
- # (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
27
-
25
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
28
26
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
29
27
  # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
30
28
  # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
@@ -37,7 +35,7 @@ module Elasticsearch
37
35
  # Deprecated since version 7.0.0
38
36
  #
39
37
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-multi-search.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-multi-search.html
41
39
  #
42
40
  def msearch_template(arguments = {})
43
41
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -33,9 +33,7 @@ module Elasticsearch
33
33
  # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
34
34
  # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true).
35
35
  # @option arguments [Number] :version Explicit version number for concurrency control
36
- # @option arguments [String] :version_type Specific version type
37
- # (options: internal,external,external_gte,force)
38
-
36
+ # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
39
37
  # @option arguments [Hash] :headers Custom HTTP headers
40
38
  # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
41
39
  #
@@ -44,7 +42,7 @@ module Elasticsearch
44
42
  # Deprecated since version 7.0.0
45
43
  #
46
44
  #
47
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-multi-termvectors.html
45
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-multi-termvectors.html
48
46
  #
49
47
  def mtermvectors(arguments = {})
50
48
  headers = arguments.delete(:headers) || {}
@@ -26,9 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10)
27
27
  # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3)
28
28
  # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
29
- # @option arguments [String] :type The type to sample (default: cpu)
30
- # (options: cpu,wait,block)
31
-
29
+ # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
32
30
  # @option arguments [Time] :timeout Explicit operation timeout
33
31
  # @option arguments [Hash] :headers Custom HTTP headers
34
32
  #
@@ -37,7 +35,7 @@ module Elasticsearch
37
35
  # Deprecated since version 7.0.0
38
36
  #
39
37
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-hot-threads.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-nodes-hot-threads.html
41
39
  #
42
40
  def hot_threads(arguments = {})
43
41
  headers = arguments.delete(:headers) || {}
@@ -22,14 +22,12 @@ module Elasticsearch
22
22
  # Returns information about nodes in the cluster.
23
23
  #
24
24
  # @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] :metric A comma-separated list of metrics you wish returned. Leave empty to return all.
26
- # (options: settings,os,process,jvm,thread_pool,transport,http,plugins,ingest)
27
-
25
+ # @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)
28
26
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
29
27
  # @option arguments [Time] :timeout Explicit operation timeout
30
28
  # @option arguments [Hash] :headers Custom HTTP headers
31
29
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-info.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-nodes-info.html
33
31
  #
34
32
  def info(arguments = {})
35
33
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/secure-settings.html#reloadable-secure-settings
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/secure-settings.html#reloadable-secure-settings
30
30
  #
31
31
  def reload_secure_settings(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -22,25 +22,19 @@ module Elasticsearch
22
22
  # Returns statistical information about nodes in the cluster.
23
23
  #
24
24
  # @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] :metric Limit the information returned to the specified metrics
26
- # (options: _all,breaker,fs,http,indices,jvm,os,process,thread_pool,transport,discovery,indexing_pressure)
27
-
28
- # @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.
29
- # (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
30
-
25
+ # @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, indexing_pressure)
26
+ # @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)
31
27
  # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
32
28
  # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
33
29
  # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
34
30
  # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
35
- # @option arguments [String] :level Return indices stats aggregated at index, node or shard level
36
- # (options: indices,node,shards)
37
-
31
+ # @option arguments [String] :level Return indices stats aggregated at index, node or shard level (options: indices, node, shards)
38
32
  # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
39
33
  # @option arguments [Time] :timeout Explicit operation timeout
40
34
  # @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)
41
35
  # @option arguments [Hash] :headers Custom HTTP headers
42
36
  #
43
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-stats.html
37
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-nodes-stats.html
44
38
  #
45
39
  def stats(arguments = {})
46
40
  headers = arguments.delete(:headers) || {}
@@ -22,13 +22,11 @@ module Elasticsearch
22
22
  # Returns low-level information about REST actions usage on nodes.
23
23
  #
24
24
  # @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] :metric Limit the information returned to the specified metrics
26
- # (options: _all,rest_actions)
27
-
25
+ # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions)
28
26
  # @option arguments [Time] :timeout Explicit operation timeout
29
27
  # @option arguments [Hash] :headers Custom HTTP headers
30
28
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-nodes-usage.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-nodes-usage.html
32
30
  #
33
31
  def usage(arguments = {})
34
32
  headers = arguments.delete(:headers) || {}
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [Hash] :headers Custom HTTP headers
24
24
  #
25
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index.html
25
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/index.html
26
26
  #
27
27
  def ping(arguments = {})
28
28
  headers = arguments.delete(:headers) || {}
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  # @option arguments [Hash] :body The document (*Required*)
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-scripting.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-scripting.html
32
32
  #
33
33
  def put_script(arguments = {})
34
34
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -19,20 +19,20 @@ module Elasticsearch
19
19
  module API
20
20
  module Actions
21
21
  # Allows to evaluate the quality of ranked search results over a set of typical search queries
22
+ # This functionality is Experimental and may be changed or removed
23
+ # completely in a future release. Elastic will take a best effort approach
24
+ # to fix any issues, but experimental features are not subject to the
25
+ # support SLA of official GA features.
22
26
  #
23
27
  # @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
24
28
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
25
29
  # @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)
26
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
27
- # (options: open,closed,hidden,none,all)
28
-
29
- # @option arguments [String] :search_type Search operation type
30
- # (options: query_then_fetch,dfs_query_then_fetch)
31
-
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
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
32
32
  # @option arguments [Hash] :headers Custom HTTP headers
33
33
  # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-rank-eval.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-rank-eval.html
36
36
  #
37
37
  def rank_eval(arguments = {})
38
38
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -33,7 +33,7 @@ module Elasticsearch
33
33
  # @option arguments [Hash] :headers Custom HTTP headers
34
34
  # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
35
35
  #
36
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-reindex.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-reindex.html
37
37
  #
38
38
  def reindex(arguments = {})
39
39
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -21,10 +21,10 @@ module Elasticsearch
21
21
  # Changes the number of requests per second for a particular Reindex operation.
22
22
  #
23
23
  # @option arguments [String] :task_id The task id to rethrottle
24
- # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
24
+ # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
25
25
  # @option arguments [Hash] :headers Custom HTTP headers
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-reindex.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-reindex.html
28
28
  #
29
29
  def reindex_rethrottle(arguments = {})
30
30
  raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
@@ -24,7 +24,7 @@ module Elasticsearch
24
24
  # @option arguments [Hash] :headers Custom HTTP headers
25
25
  # @option arguments [Hash] :body The search definition template and its params
26
26
  #
27
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-template.html#_validating_templates
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-template.html#_validating_templates
28
28
  #
29
29
  def render_search_template(arguments = {})
30
30
  headers = arguments.delete(:headers) || {}
@@ -19,11 +19,15 @@ module Elasticsearch
19
19
  module API
20
20
  module Actions
21
21
  # Allows an arbitrary script to be executed and a result to be returned
22
+ # This functionality is Experimental and may be changed or removed
23
+ # completely in a future release. Elastic will take a best effort approach
24
+ # to fix any issues, but experimental features are not subject to the
25
+ # support SLA of official GA features.
22
26
  #
23
27
  # @option arguments [Hash] :headers Custom HTTP headers
24
28
  # @option arguments [Hash] :body The script to execute
25
29
  #
26
- # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.x/painless-execute-api.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.9/painless-execute-api.html
27
31
  #
28
32
  def scripts_painless_execute(arguments = {})
29
33
  headers = arguments.delete(:headers) || {}
@@ -20,7 +20,7 @@ module Elasticsearch
20
20
  module Actions
21
21
  # Allows to retrieve a large numbers of results from a single search request.
22
22
  #
23
- # @option arguments [String] :scroll_id The scroll ID *Deprecated*
23
+ # @option arguments [String] :scroll_id The scroll ID *Deprecated*
24
24
  # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
25
25
  # @option arguments [String] :scroll_id The scroll ID for scrolled search
26
26
  # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # Deprecated since version 7.0.0
33
33
  #
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-request-body.html#request-body-search-scroll
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-request-body.html#request-body-search-scroll
36
36
  #
37
37
  def scroll(arguments = {})
38
38
  headers = arguments.delete(:headers) || {}
@@ -25,9 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [String] :analyzer The analyzer to use for the query string
26
26
  # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
27
27
  # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
28
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
29
- # (options: AND,OR)
30
-
28
+ # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
31
29
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
32
30
  # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
33
31
  # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -36,17 +34,13 @@ module Elasticsearch
36
34
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
37
35
  # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
38
36
  # @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)
39
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
40
- # (options: open,closed,hidden,none,all)
41
-
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)
42
38
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
43
39
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
44
40
  # @option arguments [String] :q Query in the Lucene query string syntax
45
41
  # @option arguments [List] :routing A comma-separated list of specific routing values
46
42
  # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
47
- # @option arguments [String] :search_type Search operation type
48
- # (options: query_then_fetch,dfs_query_then_fetch)
49
-
43
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
50
44
  # @option arguments [Number] :size Number of hits to return (default: 10)
51
45
  # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
52
46
  # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
@@ -55,9 +49,7 @@ module Elasticsearch
55
49
  # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
56
50
  # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
57
51
  # @option arguments [String] :suggest_field Specify which field to use for suggestions
58
- # @option arguments [String] :suggest_mode Specify suggest mode
59
- # (options: missing,popular,always)
60
-
52
+ # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
61
53
  # @option arguments [Number] :suggest_size How many suggestions to return in response
62
54
  # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
63
55
  # @option arguments [Time] :timeout Explicit operation timeout
@@ -80,7 +72,7 @@ module Elasticsearch
80
72
  # Deprecated since version 7.0.0
81
73
  #
82
74
  #
83
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-search.html
75
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-search.html
84
76
  #
85
77
  def search(arguments = {})
86
78
  headers = arguments.delete(:headers) || {}
@@ -26,12 +26,10 @@ module Elasticsearch
26
26
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
27
27
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
28
28
  # @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)
29
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
30
- # (options: open,closed,hidden,none,all)
31
-
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)
32
30
  # @option arguments [Hash] :headers Custom HTTP headers
33
31
  #
34
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-shards.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-shards.html
35
33
  #
36
34
  def search_shards(arguments = {})
37
35
  headers = arguments.delete(:headers) || {}
@@ -25,15 +25,11 @@ module Elasticsearch
25
25
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
26
26
  # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
27
27
  # @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)
28
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
29
- # (options: open,closed,hidden,none,all)
30
-
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)
31
29
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
32
30
  # @option arguments [List] :routing A comma-separated list of specific routing values
33
31
  # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
34
- # @option arguments [String] :search_type Search operation type
35
- # (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
36
-
32
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
37
33
  # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
38
34
  # @option arguments [Boolean] :profile Specify whether to profile the query execution
39
35
  # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
@@ -47,7 +43,7 @@ module Elasticsearch
47
43
  # Deprecated since version 7.0.0
48
44
  #
49
45
  #
50
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-template.html
46
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-template.html
51
47
  #
52
48
  def search_template(arguments = {})
53
49
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :timeout Explicit operation timeout
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/clean-up-snapshot-repo-api.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/clean-up-snapshot-repo-api.html
30
30
  #
31
31
  def cleanup_repository(arguments = {})
32
32
  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]