elasticsearch-api 7.17.11 → 9.0.2

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

@@ -14,29 +14,47 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns information about whether a particular alias exists.
+        # Check aliases.
+        # Check if one or more data stream or index aliases exist.
         #
-        # @option arguments [List] :name A comma-separated list of alias names to return
-        # @option arguments [List] :index A comma-separated list of index names to filter aliases
-        # @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 [String, Array<String>] :name Comma-separated list of aliases to check. Supports wildcards (+*+). (*Required*)
+        # @option arguments [String, Array] :index Comma-separated list of data streams or indices used to limit the request. Supports wildcards (+*+).
+        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
+        # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
+        #  This behavior applies even if the request targets other open indices. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+        #  Supports comma-separated values, such as +open,hidden+.
+        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
+        # @option arguments [Boolean] :ignore_unavailable If +false+, requests that include a missing data stream or index in the target indices or data streams return an error.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-aliases.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-alias
         #
         def exists_alias(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_alias' }
+
+          defined_params = [: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)
 
@@ -44,30 +62,18 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_HEAD
           path   = if _index && _name
-                     "#{Utils.__listify(_index)}/_alias/#{Utils.__listify(_name)}"
+                     "#{Utils.listify(_index)}/_alias/#{Utils.listify(_name)}"
                    else
-                     "_alias/#{Utils.__listify(_name)}"
+                     "_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
+          Utils.rescue_from_not_found do
+            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,51 +14,52 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns information about whether a particular index template exists.
+        # Check index templates.
+        # Check whether index templates exist.
         #
-        # @option arguments [String] :name The name of the template
-        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. (*Required*)
+        # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
+        # @option arguments [Boolean] :flat_settings If true, returns settings in flat format.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-index-template
         #
         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__)
-
-          body = nil
+          path   = "_index_template/#{Utils.listify(_name)}"
+          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_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,51 +14,57 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns information about whether a particular index template exists.
+        # Check existence of index templates.
+        # Get information about whether index templates exist.
+        # Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
+        # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
         #
-        # @option arguments [List] :name The comma separated names of the index templates
-        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [String, Array<String>] :name A comma-separated list of index template names used to limit the request.
+        #  Wildcard (+*+) expressions are supported. (*Required*)
+        # @option arguments [Boolean] :flat_settings Indicates whether to use a flat format for the response.
+        # @option arguments [Boolean] :local Indicates whether to get information from the local node only.
+        # @option arguments [Time] :master_timeout The period to wait for the master node.
+        #  If the master node is not available before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-template
         #
         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
+          path   = "_template/#{Utils.listify(_name)}"
+          params = Utils.process_params(arguments)
 
-          Utils.__rescue_from_not_found do
-            perform_request(method, path, params, body, headers).status == 200 ? true : false
+          Utils.rescue_from_not_found do
+            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,63 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Get the status for a data stream lifecycle.
+        # Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
+        #
+        # @option arguments [String, Array] :index The name of the index to explain (*Required*)
+        # @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/docs/api/doc/elasticsearch/v9/operation/operation-indices-explain-data-lifecycle
+        #
+        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/field_usage_stats.rb

@@ -14,52 +14,63 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns the field usage stats for each field of an index
+        # Get field usage stats.
+        # Get field usage information for each shard and field of an index.
+        # Field usage statistics are automatically captured when queries are running on a cluster.
+        # A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.
+        # The response body reports the per-shard usage count of the data structures that back the fields in the index.
+        # A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.
         # 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 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 [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*Required*)
+        # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
+        #  This behavior applies even if the request targets other open indices.
+        #  For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+        #  Supports comma-separated values, such as +open,hidden+.
+        # @option arguments [Boolean] :ignore_unavailable If +true+, missing or closed indices are not included in the response.
+        # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/field-usage-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-field-usage-stats
         #
         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]
 
+          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)}/_field_usage_stats"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "#{Utils.listify(_index)}/_field_usage_stats"
+          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(:field_usage_stats, [
-          :fields,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
       end
     end
   end

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

@@ -14,52 +14,68 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Performs the flush operation on one or more indices.
+        # Flush data streams or indices.
+        # Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.
+        # When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.
+        # Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.
+        # After each operation has been flushed it is permanently stored in the Lucene index.
+        # This may mean that there is no need to maintain an additional copy of it in the transaction log.
+        # The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.
+        # It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly.
+        # If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
-        # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
-        # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.
-        # @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, Array] :index Comma-separated list of data streams, indices, and aliases to flush.
+        #  Supports wildcards (+*+).
+        #  To flush all data streams and indices, omit this parameter or use +*+ or +_all+.
+        # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
+        #  This behavior applies even if the request targets other open indices. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+        #  Supports comma-separated values, such as +open,hidden+.
+        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
+        # @option arguments [Boolean] :force If +true+, the request forces a flush even if there are no changes to commit to the index. Server default: true.
+        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+        # @option arguments [Boolean] :wait_if_ongoing If +true+, the flush operation blocks until execution when another flush operation is running.
+        #  If +false+, Elasticsearch returns an error if you request a flush when another flush operation is running. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-flush.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-flush
         #
         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)
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _index
-                     "#{Utils.__listify(_index)}/_flush"
+                     "#{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,54 +14,93 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Performs the force merge operation on one or more indices.
+        # Force a merge.
+        # Perform the force merge operation on the shards of one or more indices.
+        # For data streams, the API forces a merge on the shards of the stream's backing indices.
+        # Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.
+        # Merging normally happens automatically, but sometimes it is useful to trigger a merge manually.
+        # WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).
+        # When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone".
+        # These soft-deleted documents are automatically cleaned up during regular segment merges.
+        # But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.
+        # So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.
+        # If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.
+        # **Blocks during a force merge**
+        # Calls to this API block until the merge is complete (unless request contains +wait_for_completion=false+).
+        # If the client connection is lost before completion then the force merge process will continue in the background.
+        # Any new requests to force merge the same indices will also block until the ongoing force merge is complete.
+        # **Running force merge asynchronously**
+        # If the request contains +wait_for_completion=false+, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.
+        # However, you can not cancel this task as the force merge task is not cancelable.
+        # Elasticsearch creates a record of this task as a document at +_tasks/<task_id>+.
+        # When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.
+        # **Force merging multiple indices**
+        # You can force merge multiple indices with a single request by targeting:
+        # * One or more data streams that contain multiple backing indices
+        # * Multiple indices
+        # * One or more aliases
+        # * All data streams and indices in a cluster
+        # Each targeted shard is force-merged separately using the force_merge threadpool.
+        # By default each node only has a single +force_merge+ thread which means that the shards on that node are force-merged one at a time.
+        # If you expand the +force_merge+ threadpool on a node then it will force merge its shards in parallel
+        # Force merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case +max_num_segments parameter+ is set to +1+, to rewrite all segments into a new one.
+        # **Data streams and time-based indices**
+        # Force-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.
+        # In these cases, each index only receives indexing traffic for a certain period of time.
+        # Once an index receive no more writes, its shards can be force-merged to a single segment.
+        # This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.
+        # For example:
+        # +
+        # POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1
+        # +
         #
-        # @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 [String, Array] :index A comma-separated list of index names; use +_all+ or empty string to perform the operation on all indices
+        # @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, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
         # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true)
         # @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 [Number] :max_num_segments The number of segments the index should be merged into (default: dynamic)
+        # @option arguments [Integer] :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.17/indices-forcemerge.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-forcemerge
         #
         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)
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _index
-                     "#{Utils.__listify(_index)}/_forcemerge"
+                     "#{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