elasticsearch-api 7.8.1 → 7.10.1

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.10/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

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The template definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-templates.html
         #
         def put_index_template(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -60,7 +60,7 @@ module Elasticsearch
           :cause,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -22,14 +22,14 @@ module Elasticsearch
         # Updates the index mappings.
         #
         # @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.
-        # @option arguments [String] :type The name of the document type   *Deprecated*
+        # @option arguments [String] :type The name of the document type *Deprecated*
         # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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] :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] :write_index_only When true, applies mappings only to the write index of an alias or data stream
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The mapping definition (*Required*)
         #
@@ -38,7 +38,7 @@ module Elasticsearch
         # Deprecated since version 7.0.0
         #
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-put-mapping.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-put-mapping.html
         #
         def put_mapping(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -58,7 +58,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_mappings"
                    elsif _type
                      "_mappings/#{Utils.__listify(_type)}"
-  end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -74,9 +74,10 @@ module Elasticsearch
           :master_timeout,
           :ignore_unavailable,
           :allow_no_indices,
-          :expand_wildcards
+          :expand_wildcards,
+          :write_index_only
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,13 +27,12 @@ module Elasticsearch
         # @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`
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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] :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 [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The index settings to be updated (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-update-settings.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-update-settings.html
         #
         def put_settings(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -49,7 +48,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_settings"
                    else
                      "_settings"
-  end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -68,7 +67,7 @@ module Elasticsearch
           :expand_wildcards,
           :flat_settings
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The template definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-templates.html
         #
         def put_template(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -58,7 +58,7 @@ module Elasticsearch
           :create,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-recovery.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-recovery.html
         #
         def recovery(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -40,7 +40,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_recovery"
                    else
                      "_recovery"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -54,7 +54,7 @@ module Elasticsearch
           :detailed,
           :active_only
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -24,11 +24,10 @@ module Elasticsearch
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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] :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-refresh.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-refresh.html
         #
         def refresh(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -42,7 +41,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_refresh"
                    else
                      "_refresh"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -57,7 +56,7 @@ module Elasticsearch
           :allow_no_indices,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/{delete_data_stream.rb → resolve_index.rb}

@@ -19,18 +19,19 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # Deletes a data stream.
+        # Returns information about any matching indices, aliases, and 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 of the data stream
+        # @option arguments [List] :name A comma-separated list of names or wildcard expressions
+        # @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 [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.10/indices-resolve-index-api.html
         #
-        def delete_data_stream(arguments = {})
+        def resolve_index(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
@@ -39,14 +40,21 @@ module Elasticsearch
 
           _name = arguments.delete(:name)
 
-          method = Elasticsearch::API::HTTP_DELETE
-          path   = "_data_stream/#{Utils.__listify(_name)}"
-          params = {}
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_resolve/index/#{Utils.__listify(_name)}"
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
           perform_request(method, path, params, body, headers).body
         end
-end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:resolve_index, [
+          :expand_wildcards
+        ].freeze)
       end
+    end
   end
 end

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-rollover-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-rollover-index.html
         #
         def rollover(arguments = {})
           raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
@@ -50,7 +50,7 @@ module Elasticsearch
                      "#{Utils.__listify(_alias)}/_rollover/#{Utils.__listify(_new_index)}"
                    else
                      "#{Utils.__listify(_alias)}/_rollover"
-  end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -67,7 +67,7 @@ module Elasticsearch
           :master_timeout,
           :wait_for_active_shards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -24,12 +24,11 @@ module Elasticsearch
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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] :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] :verbose Includes detailed memory usage by Lucene.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-segments.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-segments.html
         #
         def segments(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -43,7 +42,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_segments"
                    else
                      "_segments"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -59,7 +58,7 @@ module Elasticsearch
           :expand_wildcards,
           :verbose
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -22,15 +22,13 @@ module Elasticsearch
         # Provides store information for shard copies of indices.
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @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)
+        # @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)
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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] :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-shards-stores.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-shards-stores.html
         #
         def shard_stores(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -44,7 +42,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_shard_stores"
                    else
                      "_shard_stores"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -60,7 +58,7 @@ module Elasticsearch
           :allow_no_indices,
           :expand_wildcards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-shrink-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-shrink-index.html
         #
         def shrink(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -61,7 +61,7 @@ module Elasticsearch
           :master_timeout,
           :wait_for_active_shards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body New index template definition, which will be included in the simulation, as if it already exists in the system
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-templates.html
         #
         def simulate_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -59,7 +59,7 @@ module Elasticsearch
           :cause,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/indices/{create_data_stream.rb → simulate_template.rb}

@@ -19,36 +19,49 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # Creates or updates a data stream
+        # Simulate resolving the given template name or body
         # 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 of the data stream
+        # @option arguments [String] :name The name of the index template
+        # @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
+        # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The data stream definition (*Required*)
+        # @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/data-streams.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-templates.html
         #
-        def create_data_stream(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-
+        def simulate_template(arguments = {})
           headers = arguments.delete(:headers) || {}
 
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
 
-          method = Elasticsearch::API::HTTP_PUT
-          path   = "_data_stream/#{Utils.__listify(_name)}"
-          params = {}
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _name
+                     "_index_template/_simulate/#{Utils.__listify(_name)}"
+                   else
+                     "_index_template/_simulate"
+                   end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
           perform_request(method, path, params, body, headers).body
         end
-end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:simulate_template, [
+          :create,
+          :cause,
+          :master_timeout
+        ].freeze)
       end
+    end
   end
 end