elasticsearch-api 7.8.1 → 7.9.0.pre

data/lib/elasticsearch/api/actions/indices/exists_type.rb

@@ -27,10 +27,11 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-types-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-types-exists.html
         #
         def exists_type(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -65,7 +66,7 @@ module Elasticsearch
           :expand_wildcards,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/flush.rb

@@ -28,9 +28,10 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-flush.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-flush.html
         #
         def flush(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -44,7 +45,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_flush"
                    else
                      "_flush"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -61,7 +62,7 @@ module Elasticsearch
           :allow_no_indices,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/flush_synced.rb

@@ -26,9 +26,10 @@ module Elasticsearch
         # @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)
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
         #   (options: open,closed,none,all)
+
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-synced-flush-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-synced-flush-api.html
         #
         def flush_synced(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -42,7 +43,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_flush/synced"
                    else
                      "_flush/synced"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -61,7 +62,7 @@ module Elasticsearch
           :allow_no_indices,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/forcemerge.rb

@@ -27,11 +27,12 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Number] :max_num_segments The number of segments the index should be merged into (default: dynamic)
         # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-forcemerge.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-forcemerge.html
         #
         def forcemerge(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -45,7 +46,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_forcemerge"
                    else
                      "_forcemerge"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -63,7 +64,7 @@ module Elasticsearch
           :max_num_segments,
           :only_expunge_deletes
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get.rb

@@ -28,12 +28,13 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
         # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
         #   (options: open,closed,hidden,none,all)
+
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-get-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-get-index.html
         #
         def get(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -65,7 +66,7 @@ module Elasticsearch
           :include_defaults,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get_alias.rb

@@ -27,10 +27,11 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-aliases.html
         #
         def get_alias(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -50,7 +51,7 @@ module Elasticsearch
                      "_alias/#{Utils.__listify(_name)}"
                    else
                      "_alias"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -66,7 +67,7 @@ module Elasticsearch
           :expand_wildcards,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/{get_data_streams.rb → get_data_stream.rb}

@@ -20,17 +20,13 @@ module Elasticsearch
     module Indices
       module Actions
         # Returns data streams.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
-        # @option arguments [String] :name The name or wildcard expression of the requested data streams
+        # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/data-streams.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
         #
-        def get_data_streams(arguments = {})
+        def get_data_stream(arguments = {})
           headers = arguments.delete(:headers) || {}
 
           arguments = arguments.clone
@@ -39,16 +35,16 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _name
-                     "_data_streams/#{Utils.__listify(_name)}"
+                     "_data_stream/#{Utils.__listify(_name)}"
                    else
-                     "_data_streams"
-      end
+                     "_data_stream"
+                   end
           params = {}
 
           body = nil
           perform_request(method, path, params, body, headers).body
         end
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb

@@ -30,6 +30,7 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
@@ -38,7 +39,7 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-get-field-mapping.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-get-field-mapping.html
         #
         def get_field_mapping(arguments = {})
           _fields = arguments.delete(:field) || arguments.delete(:fields)
@@ -61,7 +62,7 @@ module Elasticsearch
                      "_mapping/#{Utils.__listify(_type)}/field/#{Utils.__listify(_fields)}"
                    else
                      "_mapping/field/#{Utils.__listify(_fields)}"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -79,7 +80,7 @@ module Elasticsearch
           :expand_wildcards,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get_index_template.rb

@@ -20,10 +20,6 @@ module Elasticsearch
     module Indices
       module Actions
         # Returns an index template.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [List] :name The comma separated names of the index templates
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
@@ -31,7 +27,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
         #
         def get_index_template(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -45,7 +41,7 @@ module Elasticsearch
                      "_index_template/#{Utils.__listify(_name)}"
                    else
                      "_index_template"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -60,7 +56,7 @@ module Elasticsearch
           :master_timeout,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get_mapping.rb

@@ -28,8 +28,9 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)   *Deprecated*
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # *Deprecation notice*:
@@ -37,7 +38,7 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-get-mapping.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-get-mapping.html
         #
         def get_mapping(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -57,7 +58,7 @@ module Elasticsearch
                      "_mapping/#{Utils.__listify(_type)}"
                    else
                      "_mapping"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -75,7 +76,7 @@ module Elasticsearch
           :master_timeout,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get_settings.rb

@@ -28,12 +28,13 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-get-settings.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-get-settings.html
         #
         def get_settings(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -53,7 +54,7 @@ module Elasticsearch
                      "_settings/#{Utils.__listify(_name)}"
                    else
                      "_settings"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -72,7 +73,7 @@ module Elasticsearch
           :local,
           :include_defaults
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get_template.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
         #
         def get_template(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -42,7 +42,7 @@ module Elasticsearch
                      "_template/#{Utils.__listify(_name)}"
                    else
                      "_template"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -58,7 +58,7 @@ module Elasticsearch
           :master_timeout,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/get_upgrade.rb

@@ -26,9 +26,10 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-upgrade.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-upgrade.html
         #
         def get_upgrade(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -42,7 +43,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_upgrade"
                    else
                      "_upgrade"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -57,7 +58,7 @@ module Elasticsearch
           :allow_no_indices,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/open.rb

@@ -28,10 +28,11 @@ module Elasticsearch
         # @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)
         # @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)
+
         # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-open-close.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-open-close.html
         #
         def open(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -61,7 +62,7 @@ module Elasticsearch
           :expand_wildcards,
           :wait_for_active_shards
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/put_alias.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-aliases.html
         #
         def put_alias(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -45,7 +45,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = if _index && _name
                      "#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}"
-  end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -59,7 +59,7 @@ module Elasticsearch
           :timeout,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end