elasticsearch-api 7.13.3 → 8.14.0

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
@@ -29,14 +32,22 @@ 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.13/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-aliases.html
         #
         def exists_alias(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_alias' }
+
+          defined_params = %i[name index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _name = arguments.delete(:name)
 
@@ -48,25 +59,14 @@ module Elasticsearch
                    else
                      "_alias/#{Utils.__listify(_name)}"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          params = Utils.process_params(arguments)
 
           Utils.__rescue_from_not_found do
-            perform_request(method, path, params, body, headers).status == 200 ? true : false
+            perform_request(method, path, params, body, headers, request_opts).status == 200
           end
         end
 
-        alias_method :exists_alias?, :exists_alias
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_alias, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :local
-        ].freeze)
+        alias exists_alias? exists_alias
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
@@ -27,34 +30,35 @@ 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.13/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/index-templates.html
         #
         def exists_index_template(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_index_template' }
+
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_HEAD
           path   = "_index_template/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
 
-        alias_method :exists_index_template?, :exists_index_template
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_index_template, [
-          :flat_settings,
-          :master_timeout,
-          :local
-        ].freeze)
+        alias exists_index_template? exists_index_template
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
@@ -27,37 +30,35 @@ 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.13/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-template-exists-v1.html
         #
         def exists_template(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_template' }
+
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_HEAD
           path   = "_template/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          params = Utils.process_params(arguments)
 
           Utils.__rescue_from_not_found do
-            perform_request(method, path, params, body, headers).status == 200 ? true : false
+            perform_request(method, path, params, body, headers, request_opts).status == 200
           end
         end
 
-        alias_method :exists_template?, :exists_template
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_template, [
-          :flat_settings,
-          :master_timeout,
-          :local
-        ].freeze)
+        alias exists_template? exists_template
       end
     end
   end

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

@@ -0,0 +1,66 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
+        # 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] :index The name of the index to explain
+        # @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle
+        # @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/8.14/data-streams-explain-lifecycle.html
+        #
+        def explain_data_lifecycle(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.explain_data_lifecycle' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "#{Utils.__listify(_index)}/_lifecycle/explain"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/{exists_type.rb → field_usage_stats.rb}

@@ -14,56 +14,54 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns information about whether a particular document type exists. (DEPRECATED)
+        # Returns the field usage stats for each field of an index
+        # 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] :index A comma-separated list of index names; use `_all` to check the types across all indices
-        # @option arguments [List] :type A comma-separated list of document types to check
+        # @option arguments [String] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+        # @option arguments [List] :fields A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards)
         # @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 [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.13/indices-types-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/field-usage-stats.html
         #
-        def exists_type(arguments = {})
+        def field_usage_stats(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.field_usage_stats' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body   = nil
 
           _index = arguments.delete(:index)
 
-          _type = arguments.delete(:type)
-
-          method = Elasticsearch::API::HTTP_HEAD
-          path   = "#{Utils.__listify(_index)}/_mapping/#{Utils.__listify(_type)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          method = Elasticsearch::API::HTTP_GET
+          path   = "#{Utils.__listify(_index)}/_field_usage_stats"
+          params = Utils.process_params(arguments)
 
-          Utils.__rescue_from_not_found do
-            perform_request(method, path, params, body, headers).status == 200 ? true : false
-          end
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        alias_method :exists_type?, :exists_type
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_type, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :local
-        ].freeze)
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
@@ -29,12 +32,20 @@ module Elasticsearch
         # @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.13/indices-flush.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-flush.html
         #
         def flush(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.flush' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
 
           _index = arguments.delete(:index)
 
@@ -42,24 +53,14 @@ module Elasticsearch
           path   = if _index
                      "#{Utils.__listify(_index)}/_flush"
                    else
-                     "_flush"
+                     '_flush'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:flush, [
-          :force,
-          :wait_if_ongoing,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
@@ -28,14 +31,23 @@ module Elasticsearch
         # @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 [Boolean] :wait_for_completion Should the request wait until the force merge is completed.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.13/indices-forcemerge.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-forcemerge.html
         #
         def forcemerge(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.forcemerge' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
 
           _index = arguments.delete(:index)
 
@@ -43,25 +55,14 @@ module Elasticsearch
           path   = if _index
                      "#{Utils.__listify(_index)}/_forcemerge"
                    else
-                     "_forcemerge"
+                     '_forcemerge'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:forcemerge, [
-          :flush,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :max_num_segments,
-          :only_expunge_deletes
-        ].freeze)
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
@@ -22,48 +25,43 @@ module Elasticsearch
         # Returns information about one or more indices.
         #
         # @option arguments [List] :index A comma-separated list of index names
-        # @option arguments [Boolean] :include_type_name Whether to add the type name to the response (default: false)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
         # @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 [String] :features Return only information on specified index features (options: aliases, mappings, settings)
         # @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.13/indices-get-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-get-index.html
         #
         def get(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.get' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body   = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
           path   = "#{Utils.__listify(_index)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get, [
-          :include_type_name,
-          :local,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :flat_settings,
-          :include_defaults,
-          :master_timeout
-        ].freeze)
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Indices
@@ -29,12 +32,20 @@ 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.13/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-aliases.html
         #
         def get_alias(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.get_alias' }
+
+          defined_params = %i[name index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
           _name = arguments.delete(:name)
 
@@ -48,23 +59,14 @@ module Elasticsearch
                    elsif _name
                      "_alias/#{Utils.__listify(_name)}"
                    else
-                     "_alias"
+                     '_alias'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_alias, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :local
-        ].freeze)
       end
     end
   end