elasticsearch-api 7.9.0.pre → 7.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
@@ -20,13 +20,17 @@ module Elasticsearch
20
20
  module Cluster
21
21
  module Actions
22
22
  # Returns one or more component templates
23
+ # This functionality is Experimental and may be changed or removed
24
+ # completely in a future release. Elastic will take a best effort approach
25
+ # to fix any issues, but experimental features are not subject to the
26
+ # support SLA of official GA features.
23
27
  #
24
28
  # @option arguments [List] :name The comma separated names of the component templates
25
29
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
26
30
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
27
31
  # @option arguments [Hash] :headers Custom HTTP headers
28
32
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-component-template.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-component-template.html
30
34
  #
31
35
  def get_component_template(arguments = {})
32
36
  headers = arguments.delete(:headers) || {}
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting.
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-update-settings.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-update-settings.html
31
31
  #
32
32
  def get_settings(arguments = {})
33
33
  headers = arguments.delete(:headers) || {}
@@ -22,28 +22,20 @@ module Elasticsearch
22
22
  # Returns basic information about the health of the cluster.
23
23
  #
24
24
  # @option arguments [List] :index Limit the information returned to a specific index
25
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
26
- # (options: open,closed,hidden,none,all)
27
-
28
- # @option arguments [String] :level Specify the level of detail for returned information
29
- # (options: cluster,indices,shards)
30
-
25
+ # @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)
26
+ # @option arguments [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
31
27
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
32
28
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
33
29
  # @option arguments [Time] :timeout Explicit operation timeout
34
30
  # @option arguments [String] :wait_for_active_shards Wait until the specified number of shards is active
35
31
  # @option arguments [String] :wait_for_nodes Wait until the specified number of nodes is available
36
- # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed
37
- # (options: immediate,urgent,high,normal,low,languid)
38
-
32
+ # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid)
39
33
  # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster
40
34
  # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster
41
- # @option arguments [String] :wait_for_status Wait until cluster is in a specific state
42
- # (options: green,yellow,red)
43
-
35
+ # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
44
36
  # @option arguments [Hash] :headers Custom HTTP headers
45
37
  #
46
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-health.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-health.html
47
39
  #
48
40
  def health(arguments = {})
49
41
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-pending.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-pending.html
30
30
  #
31
31
  def pending_tasks(arguments = {})
32
32
  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/voting-config-exclusions.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/voting-config-exclusions.html
30
30
  #
31
31
  def post_voting_config_exclusions(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Cluster
21
21
  module Actions
22
22
  # Creates or updates a component template
23
+ # This functionality is Experimental and may be changed or removed
24
+ # completely in a future release. Elastic will take a best effort approach
25
+ # to fix any issues, but experimental features are not subject to the
26
+ # support SLA of official GA features.
23
27
  #
24
28
  # @option arguments [String] :name The name of the template
25
29
  # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
@@ -28,7 +32,7 @@ module Elasticsearch
28
32
  # @option arguments [Hash] :headers Custom HTTP headers
29
33
  # @option arguments [Hash] :body The template definition (*Required*)
30
34
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-component-template.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-component-template.html
32
36
  #
33
37
  def put_component_template(arguments = {})
34
38
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-update-settings.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-update-settings.html
31
31
  #
32
32
  def put_settings(arguments = {})
33
33
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -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/cluster-remote-info.html
26
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-remote-info.html
27
27
  #
28
28
  def remote_info(arguments = {})
29
29
  headers = arguments.delete(:headers) || {}
@@ -24,15 +24,13 @@ module Elasticsearch
24
24
  # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state
25
25
  # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed
26
26
  # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many subsequent allocation failures
27
- # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata
28
- # (options: _all,blocks,metadata,nodes,routing_table,master_node,version)
29
-
27
+ # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata (options: _all, blocks, metadata, nodes, routing_table, master_node, version)
30
28
  # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
31
29
  # @option arguments [Time] :timeout Explicit operation timeout
32
30
  # @option arguments [Hash] :headers Custom HTTP headers
33
31
  # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
34
32
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-reroute.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-reroute.html
36
34
  #
37
35
  def reroute(arguments = {})
38
36
  headers = arguments.delete(:headers) || {}
@@ -21,9 +21,7 @@ module Elasticsearch
21
21
  module Actions
22
22
  # Returns a comprehensive information about the state of the cluster.
23
23
  #
24
- # @option arguments [List] :metric Limit the information returned to the specified metrics
25
- # (options: _all,blocks,metadata,nodes,routing_table,routing_nodes,master_node,version)
26
-
24
+ # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version)
27
25
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
28
26
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
29
27
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
@@ -32,12 +30,10 @@ module Elasticsearch
32
30
  # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
33
31
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
34
32
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
35
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
36
- # (options: open,closed,hidden,none,all)
37
-
33
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
38
34
  # @option arguments [Hash] :headers Custom HTTP headers
39
35
  #
40
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-state.html
36
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-state.html
41
37
  #
42
38
  def state(arguments = {})
43
39
  headers = arguments.delete(:headers) || {}
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Time] :timeout Explicit operation timeout
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-stats.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster-stats.html
30
30
  #
31
31
  def stats(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -25,18 +25,14 @@ 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 [Number] :min_score Include only documents with a specific `_score` value in the result
32
30
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
33
31
  # @option arguments [List] :routing A comma-separated list of specific routing values
34
32
  # @option arguments [String] :q Query in the Lucene query string syntax
35
33
  # @option arguments [String] :analyzer The analyzer to use for the query string
36
34
  # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
37
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
38
- # (options: AND,OR)
39
-
35
+ # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
40
36
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
41
37
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
42
38
  # @option arguments [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early
@@ -48,7 +44,7 @@ module Elasticsearch
48
44
  # Deprecated since version 7.0.0
49
45
  #
50
46
  #
51
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-count.html
47
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-count.html
52
48
  #
53
49
  def count(arguments = {})
54
50
  headers = arguments.delete(:headers) || {}
@@ -24,17 +24,13 @@ module Elasticsearch
24
24
  #
25
25
  # @option arguments [String] :id Document ID
26
26
  # @option arguments [String] :index The name of the index
27
- # @option arguments [String] :type The type of the document *Deprecated*
27
+ # @option arguments [String] :type The type of the document *Deprecated*
28
28
  # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index 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)
29
- # @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.
30
- # (options: true,false,wait_for)
31
-
29
+ # @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)
32
30
  # @option arguments [String] :routing Specific routing value
33
31
  # @option arguments [Time] :timeout Explicit operation timeout
34
32
  # @option arguments [Number] :version Explicit version number for concurrency control
35
- # @option arguments [String] :version_type Specific version type
36
- # (options: internal,external,external_gte)
37
-
33
+ # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
38
34
  # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
39
35
  # @option arguments [Hash] :headers Custom HTTP headers
40
36
  # @option arguments [Hash] :body The document (*Required*)
@@ -44,7 +40,7 @@ module Elasticsearch
44
40
  # Deprecated since version 7.0.0
45
41
  #
46
42
  #
47
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-index_.html
43
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-index_.html
48
44
  #
49
45
  def create(arguments = {})
50
46
  if arguments[:id]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-gateway-dangling-indices.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-gateway-dangling-indices.html
31
31
  #
32
32
  def delete_dangling_index(arguments = {})
33
33
  raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]
@@ -27,7 +27,7 @@ module Elasticsearch
27
27
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-gateway-dangling-indices.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-gateway-dangling-indices.html
31
31
  #
32
32
  def import_dangling_index(arguments = {})
33
33
  raise ArgumentError, "Required argument 'index_uuid' missing" unless arguments[:index_uuid]
@@ -23,7 +23,7 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [Hash] :headers Custom HTTP headers
25
25
  #
26
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-gateway-dangling-indices.html
26
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-gateway-dangling-indices.html
27
27
  #
28
28
  def list_dangling_indices(arguments = {})
29
29
  headers = arguments.delete(:headers) || {}
@@ -22,19 +22,15 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [String] :id The document ID
24
24
  # @option arguments [String] :index The name of the index
25
- # @option arguments [String] :type The type of the document *Deprecated*
25
+ # @option arguments [String] :type The type of the document *Deprecated*
26
26
  # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete 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)
27
- # @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.
28
- # (options: true,false,wait_for)
29
-
27
+ # @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)
30
28
  # @option arguments [String] :routing Specific routing value
31
29
  # @option arguments [Time] :timeout Explicit operation timeout
32
30
  # @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number
33
31
  # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term
34
32
  # @option arguments [Number] :version Explicit version number for concurrency control
35
- # @option arguments [String] :version_type Specific version type
36
- # (options: internal,external,external_gte,force)
37
-
33
+ # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
38
34
  # @option arguments [Hash] :headers Custom HTTP headers
39
35
  #
40
36
  # *Deprecation notice*:
@@ -42,7 +38,7 @@ module Elasticsearch
42
38
  # Deprecated since version 7.0.0
43
39
  #
44
40
  #
45
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-delete.html
41
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-delete.html
46
42
  #
47
43
  def delete(arguments = {})
48
44
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -20,31 +20,23 @@ module Elasticsearch
20
20
  module Actions
21
21
  # Deletes documents matching the provided query.
22
22
  #
23
- # @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 (*Required*)
23
+ # @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 (*Required*)
24
24
  # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
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
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
28
- # (options: AND,OR)
29
-
27
+ # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
30
28
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
31
29
  # @option arguments [Number] :from Starting offset (default: 0)
32
30
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
33
31
  # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
34
- # @option arguments [String] :conflicts What to do when the delete by query hits version conflicts?
35
- # (options: abort,proceed)
36
-
37
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
38
- # (options: open,closed,hidden,none,all)
39
-
32
+ # @option arguments [String] :conflicts What to do when the delete by query hits version conflicts? (options: abort, proceed)
33
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
40
34
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
41
35
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
42
36
  # @option arguments [String] :q Query in the Lucene query string syntax
43
37
  # @option arguments [List] :routing A comma-separated list of specific routing values
44
38
  # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
45
- # @option arguments [String] :search_type Search operation type
46
- # (options: query_then_fetch,dfs_query_then_fetch)
47
-
39
+ # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
48
40
  # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
49
41
  # @option arguments [Number] :size Deprecated, please use `max_docs` instead
50
42
  # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
@@ -71,7 +63,7 @@ module Elasticsearch
71
63
  # Deprecated since version 7.0.0
72
64
  #
73
65
  #
74
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-delete-by-query.html
66
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-delete-by-query.html
75
67
  #
76
68
  def delete_by_query(arguments = {})
77
69
  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 Delete By Query 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-delete-by-query.html
27
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-delete-by-query.html
28
28
  #
29
29
  def delete_by_query_rethrottle(arguments = {})
30
30
  raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
@@ -25,7 +25,7 @@ module Elasticsearch
25
25
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
26
26
  # @option arguments [Hash] :headers Custom HTTP headers
27
27
  #
28
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-scripting.html
28
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-scripting.html
29
29
  #
30
30
  def delete_script(arguments = {})
31
31
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [String] :id The document ID
24
24
  # @option arguments [String] :index The name of the index
25
- # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) *Deprecated*
25
+ # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) *Deprecated*
26
26
  # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
27
27
  # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
28
28
  # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
@@ -32,9 +32,7 @@ module Elasticsearch
32
32
  # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
33
33
  # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
34
34
  # @option arguments [Number] :version Explicit version number for concurrency control
35
- # @option arguments [String] :version_type Specific version type
36
- # (options: internal,external,external_gte,force)
37
-
35
+ # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
38
36
  # @option arguments [Hash] :headers Custom HTTP headers
39
37
  #
40
38
  # *Deprecation notice*:
@@ -42,7 +40,7 @@ module Elasticsearch
42
40
  # Deprecated since version 7.0.0
43
41
  #
44
42
  #
45
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-get.html
43
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-get.html
46
44
  #
47
45
  def exists(arguments = {})
48
46
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -22,7 +22,7 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [String] :id The document ID
24
24
  # @option arguments [String] :index The name of the index
25
- # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0 *Deprecated*
25
+ # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0 *Deprecated*
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
28
28
  # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
@@ -31,9 +31,7 @@ module Elasticsearch
31
31
  # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
32
32
  # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
33
33
  # @option arguments [Number] :version Explicit version number for concurrency control
34
- # @option arguments [String] :version_type Specific version type
35
- # (options: internal,external,external_gte,force)
36
-
34
+ # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
37
35
  # @option arguments [Hash] :headers Custom HTTP headers
38
36
  #
39
37
  # *Deprecation notice*:
@@ -41,7 +39,7 @@ module Elasticsearch
41
39
  # Deprecated since version 7.0.0
42
40
  #
43
41
  #
44
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-get.html
42
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-get.html
45
43
  #
46
44
  def exists_source(arguments = {})
47
45
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -22,12 +22,10 @@ module Elasticsearch
22
22
  #
23
23
  # @option arguments [String] :id The document ID
24
24
  # @option arguments [String] :index The name of the index
25
- # @option arguments [String] :type The type of the document *Deprecated*
25
+ # @option arguments [String] :type The type of the document *Deprecated*
26
26
  # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
27
27
  # @option arguments [String] :analyzer The analyzer for the query string query
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 default field for query string query (default: _all)
32
30
  # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
33
31
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
@@ -45,7 +43,7 @@ module Elasticsearch
45
43
  # Deprecated since version 7.0.0
46
44
  #
47
45
  #
48
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-explain.html
46
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-explain.html
49
47
  #
50
48
  def explain(arguments = {})
51
49
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]