# 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
        # 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 [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 A setting that does two separate checks on the index expression.
        #  If `false`, the request returns an error (1) if any wildcard expression
        #  (including `_all` and `*`) resolves to zero matching indices or (2) if the
        #  complete set of resolved indices, aliases or data streams is empty after all
        #  expressions are evaluated. If `true`, index expressions that resolve to no
        #  indices are allowed and the request returns an empty result.
        # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
        # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation Server default: true.
        # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a concrete (non-wildcarded)
        #  index, alias, or data stream that is missing, closed, or otherwise unavailable.
        #  If `true`, unavailable concrete targets are silently ignored.
        # @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 Server default: true.
        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
        #  when they occur.
        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
        #  returned by Elasticsearch.
        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
        #  For example `"exists_time": "1h"` for humans and
        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
        #  readable values will be omitted. This makes sense for responses being consumed
        #  only by machines.
        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
        #  this option for debugging only.
        # @option arguments [Hash] :headers Custom HTTP headers
        #
        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge
        #
        def forcemerge(arguments = {})
          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"
                   else
                     '_forcemerge'
                   end
          params = Utils.process_params(arguments)

          Elasticsearch::API::Response.new(
            perform_request(method, path, params, body, headers, request_opts)
          )
        end
      end
    end
  end
end
