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
@@ -23,14 +23,12 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :fields A comma-separated list of fields
25
25
  # @option arguments [List] :index A comma-separated list of index names
26
- # @option arguments [List] :type A comma-separated list of document types *Deprecated*
26
+ # @option arguments [List] :type A comma-separated list of document types *Deprecated*
27
27
  # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
28
28
  # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well
29
29
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
30
30
  # @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)
31
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
32
- # (options: open,closed,hidden,none,all)
33
-
31
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
34
32
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
35
33
  # @option arguments [Hash] :headers Custom HTTP headers
36
34
  #
@@ -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/indices-get-field-mapping.html
40
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-get-field-mapping.html
43
41
  #
44
42
  def get_field_mapping(arguments = {})
45
43
  _fields = arguments.delete(:field) || arguments.delete(:fields)
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Returns an index 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 [List] :name The comma separated names of the index templates
25
29
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
@@ -27,7 +31,7 @@ module Elasticsearch
27
31
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
28
32
  # @option arguments [Hash] :headers Custom HTTP headers
29
33
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
34
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates.html
31
35
  #
32
36
  def get_index_template(arguments = {})
33
37
  headers = arguments.delete(:headers) || {}
@@ -22,15 +22,13 @@ module Elasticsearch
22
22
  # Returns mappings for one or more indices.
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names
25
- # @option arguments [List] :type A comma-separated list of document types *Deprecated*
25
+ # @option arguments [List] :type A comma-separated list of document types *Deprecated*
26
26
  # @option arguments [Boolean] :include_type_name Whether to add the type name to the response (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 [Time] :master_timeout Specify timeout for connection to master
33
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
31
+ # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
34
32
  # @option arguments [Hash] :headers Custom HTTP headers
35
33
  #
36
34
  # *Deprecation notice*:
@@ -38,7 +36,7 @@ module Elasticsearch
38
36
  # Deprecated since version 7.0.0
39
37
  #
40
38
  #
41
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-get-mapping.html
39
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-get-mapping.html
42
40
  #
43
41
  def get_mapping(arguments = {})
44
42
  headers = arguments.delete(:headers) || {}
@@ -26,15 +26,13 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
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 [Boolean] :flat_settings Return settings in flat format (default: false)
33
31
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
34
32
  # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
35
33
  # @option arguments [Hash] :headers Custom HTTP headers
36
34
  #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-get-settings.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-get-settings.html
38
36
  #
39
37
  def get_settings(arguments = {})
40
38
  headers = arguments.delete(:headers) || {}
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates.html
32
32
  #
33
33
  def get_template(arguments = {})
34
34
  headers = arguments.delete(:headers) || {}
@@ -24,12 +24,10 @@ module Elasticsearch
24
24
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
25
25
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
26
26
  # @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)
27
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
28
- # (options: open,closed,hidden,none,all)
29
-
27
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
30
28
  # @option arguments [Hash] :headers Custom HTTP headers
31
29
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-upgrade.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-upgrade.html
33
31
  #
34
32
  def get_upgrade(arguments = {})
35
33
  headers = arguments.delete(:headers) || {}
@@ -26,13 +26,11 @@ module Elasticsearch
26
26
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
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 [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
33
31
  # @option arguments [Hash] :headers Custom HTTP headers
34
32
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-open-close.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-open-close.html
36
34
  #
37
35
  def open(arguments = {})
38
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -28,7 +28,7 @@ module Elasticsearch
28
28
  # @option arguments [Hash] :headers Custom HTTP headers
29
29
  # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
30
30
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-aliases.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-aliases.html
32
32
  #
33
33
  def put_alias(arguments = {})
34
34
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Creates or updates an index 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-templates.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates.html
32
36
  #
33
37
  def put_index_template(arguments = {})
34
38
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -22,15 +22,13 @@ module Elasticsearch
22
22
  # Updates the index mappings.
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
25
- # @option arguments [String] :type The name of the document type *Deprecated*
25
+ # @option arguments [String] :type The name of the document type *Deprecated*
26
26
  # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
27
27
  # @option arguments [Time] :timeout Explicit operation timeout
28
28
  # @option arguments [Time] :master_timeout Specify timeout for connection to master
29
29
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
30
30
  # @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)
31
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
32
- # (options: open,closed,hidden,none,all)
33
-
31
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
34
32
  # @option arguments [Boolean] :write_index_only When true, applies mappings only to the write index of an alias or data stream
35
33
  # @option arguments [Hash] :headers Custom HTTP headers
36
34
  # @option arguments [Hash] :body The mapping definition (*Required*)
@@ -40,7 +38,7 @@ module Elasticsearch
40
38
  # Deprecated since version 7.0.0
41
39
  #
42
40
  #
43
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-put-mapping.html
41
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-put-mapping.html
44
42
  #
45
43
  def put_mapping(arguments = {})
46
44
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -27,14 +27,12 @@ module Elasticsearch
27
27
  # @option arguments [Boolean] :preserve_existing Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
28
28
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
29
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)
30
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
31
- # (options: open,closed,hidden,none,all)
32
-
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)
33
31
  # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
34
32
  # @option arguments [Hash] :headers Custom HTTP headers
35
33
  # @option arguments [Hash] :body The index settings to be updated (*Required*)
36
34
  #
37
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-update-settings.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-update-settings.html
38
36
  #
39
37
  def put_settings(arguments = {})
40
38
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -29,7 +29,7 @@ module Elasticsearch
29
29
  # @option arguments [Hash] :headers Custom HTTP headers
30
30
  # @option arguments [Hash] :body The template definition (*Required*)
31
31
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates.html
33
33
  #
34
34
  def put_template(arguments = {})
35
35
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -26,7 +26,7 @@ module Elasticsearch
26
26
  # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
27
27
  # @option arguments [Hash] :headers Custom HTTP headers
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-recovery.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-recovery.html
30
30
  #
31
31
  def recovery(arguments = {})
32
32
  headers = arguments.delete(:headers) || {}
@@ -24,12 +24,10 @@ module Elasticsearch
24
24
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
25
25
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
26
26
  # @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)
27
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
28
- # (options: open,closed,hidden,none,all)
29
-
27
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
30
28
  # @option arguments [Hash] :headers Custom HTTP headers
31
29
  #
32
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-refresh.html
30
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-refresh.html
33
31
  #
34
32
  def refresh(arguments = {})
35
33
  headers = arguments.delete(:headers) || {}
@@ -20,14 +20,16 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Returns information about any matching indices, aliases, and data streams
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 A comma-separated list of names or wildcard expressions
25
- # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
26
- # (options: open,closed,hidden,none,all)
27
-
29
+ # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
28
30
  # @option arguments [Hash] :headers Custom HTTP headers
29
31
  #
30
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-resolve-index.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-resolve-index-api.html
31
33
  #
32
34
  def resolve_index(arguments = {})
33
35
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -32,7 +32,7 @@ module Elasticsearch
32
32
  # @option arguments [Hash] :headers Custom HTTP headers
33
33
  # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
34
34
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-rollover-index.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-rollover-index.html
36
36
  #
37
37
  def rollover(arguments = {})
38
38
  raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
@@ -24,13 +24,11 @@ module Elasticsearch
24
24
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
25
25
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
26
26
  # @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)
27
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
28
- # (options: open,closed,hidden,none,all)
29
-
27
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
30
28
  # @option arguments [Boolean] :verbose Includes detailed memory usage by Lucene.
31
29
  # @option arguments [Hash] :headers Custom HTTP headers
32
30
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-segments.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-segments.html
34
32
  #
35
33
  def segments(arguments = {})
36
34
  headers = arguments.delete(:headers) || {}
@@ -22,17 +22,13 @@ module Elasticsearch
22
22
  # Provides store information for shard copies of indices.
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
25
- # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for
26
- # (options: green,yellow,red,all)
27
-
25
+ # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all)
28
26
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
29
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)
30
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
31
- # (options: open,closed,hidden,none,all)
32
-
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)
33
29
  # @option arguments [Hash] :headers Custom HTTP headers
34
30
  #
35
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-shards-stores.html
31
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-shards-stores.html
36
32
  #
37
33
  def shard_stores(arguments = {})
38
34
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-shrink-index.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-shrink-index.html
34
34
  #
35
35
  def shrink(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Simulate matching the given index name against the index templates in the system
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 index (it must be a concrete index name)
25
29
  # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run 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 New index template definition, which will be included in the simulation, as if it already exists in the system
30
34
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates.html
32
36
  #
33
37
  def simulate_index_template(arguments = {})
34
38
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -20,6 +20,10 @@ module Elasticsearch
20
20
  module Indices
21
21
  module Actions
22
22
  # Simulate resolving the given template name or body
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 index template
25
29
  # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run 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 New index template definition to be simulated, if no index template name is specified
30
34
  #
31
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
35
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates.html
32
36
  #
33
37
  def simulate_template(arguments = {})
34
38
  headers = arguments.delete(:headers) || {}
@@ -30,7 +30,7 @@ module Elasticsearch
30
30
  # @option arguments [Hash] :headers Custom HTTP headers
31
31
  # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
32
32
  #
33
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-split-index.html
33
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-split-index.html
34
34
  #
35
35
  def split(arguments = {})
36
36
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -21,27 +21,21 @@ module Elasticsearch
21
21
  module Actions
22
22
  # Provides statistics on operations happening in an index.
23
23
  #
24
- # @option arguments [List] :metric Limit the information returned the specific metrics.
25
- # (options: _all,completion,docs,fielddata,query_cache,flush,get,indexing,merge,request_cache,refresh,search,segments,store,warmer,suggest)
26
-
24
+ # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest)
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 [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
29
27
  # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
30
28
  # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
31
29
  # @option arguments [List] :groups A comma-separated list of search groups for `search` index metric
32
- # @option arguments [String] :level Return stats aggregated at cluster, index or shard level
33
- # (options: cluster,indices,shards)
34
-
30
+ # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards)
35
31
  # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
36
32
  # @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)
37
33
  # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
38
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
39
- # (options: open,closed,hidden,none,all)
40
-
34
+ # @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)
41
35
  # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
42
36
  # @option arguments [Hash] :headers Custom HTTP headers
43
37
  #
44
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-stats.html
38
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-stats.html
45
39
  #
46
40
  def stats(arguments = {})
47
41
  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 The definition of `actions` to perform (*Required*)
28
28
  #
29
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-aliases.html
29
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-aliases.html
30
30
  #
31
31
  def update_aliases(arguments = {})
32
32
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -23,15 +23,13 @@ module Elasticsearch
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
25
25
  # @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
-
26
+ # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
29
27
  # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
30
28
  # @option arguments [Boolean] :wait_for_completion Specify whether the request should block until the all segments are upgraded (default: false)
31
29
  # @option arguments [Boolean] :only_ancient_segments If true, only ancient (an older Lucene major release) segments will be upgraded
32
30
  # @option arguments [Hash] :headers Custom HTTP headers
33
31
  #
34
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-upgrade.html
32
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-upgrade.html
35
33
  #
36
34
  def upgrade(arguments = {})
37
35
  headers = arguments.delete(:headers) || {}
@@ -22,19 +22,15 @@ module Elasticsearch
22
22
  # Allows a user to validate a potentially expensive query without executing it.
23
23
  #
24
24
  # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
25
- # @option arguments [List] :type A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types *Deprecated*
25
+ # @option arguments [List] :type A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types *Deprecated*
26
26
  # @option arguments [Boolean] :explain Return detailed information about the error
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 [String] :q Query in the Lucene query string syntax
33
31
  # @option arguments [String] :analyzer The analyzer to use for the query string
34
32
  # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
35
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
36
- # (options: AND,OR)
37
-
33
+ # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
38
34
  # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
39
35
  # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
40
36
  # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed.
@@ -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-validate.html
46
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-validate.html
51
47
  #
52
48
  def validate_query(arguments = {})
53
49
  headers = arguments.delete(:headers) || {}