elasticsearch-api 7.17.11 → 9.0.2

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

@@ -14,42 +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 any matching indices, aliases, and data streams
+        # Resolve indices.
+        # Resolve the names and/or index patterns for indices, aliases, and data streams.
+        # Multiple patterns and remote clusters are supported.
         #
-        # @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 [String, Array<String>] :name Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.
+        #  Resources on remote clusters can be specified using the +<cluster>+:+<name>+ syntax. (*Required*)
+        # @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+, the request returns an error if it targets a missing or closed index.
+        # @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+. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-resolve-index-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index
         #
         def resolve_index(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_index' }
+
+          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_GET
-          path   = "_resolve/index/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "_resolve/index/#{Utils.listify(_name)}"
+          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(:resolve_index, [
-          :expand_wildcards
-        ].freeze)
       end
     end
   end

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

@@ -14,32 +14,73 @@
 # 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
-        # Updates an alias to point to a new index when the existing index
-        # is considered to be too large or too old.
+        # Roll over to a new index.
+        # TIP: It is recommended to use the index lifecycle rollover action to automate rollovers.
+        # The rollover API creates a new index for a data stream or index alias.
+        # The API behavior depends on the rollover target.
+        # **Roll over a data stream**
+        # If you roll over a data stream, the API creates a new write index for the stream.
+        # The stream's previous write index becomes a regular backing index.
+        # A rollover also increments the data stream's generation.
+        # **Roll over an index alias with a write index**
+        # TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.
+        # Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.
+        # If an index alias points to multiple indices, one of the indices must be a write index.
+        # The rollover API creates a new write index for the alias with +is_write_index+ set to +true+.
+        # The API also +sets is_write_index+ to +false+ for the previous write index.
+        # **Roll over an index alias with one index**
+        # If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.
+        # NOTE: A rollover creates a new index and is subject to the +wait_for_active_shards+ setting.
+        # **Increment index names for an alias**
+        # When you roll over an index alias, you can specify a name for the new index.
+        # If you don't specify a name and the current index ends with +-+ and a number, such as +my-index-000001+ or +my-index-3+, the new index name increments that number.
+        # For example, if you roll over an alias with a current index of +my-index-000001+, the rollover creates a new index named +my-index-000002+.
+        # This number is always six characters and zero-padded, regardless of the previous index's name.
+        # If you use an index alias for time series data, you can use date math in the index name to track the rollover date.
+        # For example, you can create an alias that points to an index named +<my-index-{now/d}-000001>+.
+        # If you create the index on May 6, 2099, the index's name is +my-index-2099.05.06-000001+.
+        # If you roll over the alias on May 7, 2099, the new index's name is +my-index-2099.05.07-000002+.
         #
-        # @option arguments [String] :alias The name of the alias to rollover
-        # @option arguments [String] :new_index The name of the rollover index
-        # @option arguments [Boolean] :include_type_name Whether a type should be included in the body of the mappings.
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
+        # @option arguments [String] :alias Name of the data stream or index alias to roll over. (*Required*)
+        # @option arguments [String] :new_index Name of the index to create.
+        #  Supports date math.
+        #  Data streams do not support this parameter.
+        # @option arguments [Boolean] :dry_run If +true+, checks whether the current index satisfies the specified conditions but does not perform a rollover.
+        # @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 [Time] :timeout Period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
+        #  Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
+        # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.
+        #  Only allowed on data streams.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-rollover-index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-rollover
         #
         def rollover(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.rollover' }
+
+          defined_params = [:alias, :new_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 'alias' missing" unless arguments[:alias]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = arguments.delete(:body)
 
           _alias = arguments.delete(:alias)
 
@@ -47,26 +88,16 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _alias && _new_index
-                     "#{Utils.__listify(_alias)}/_rollover/#{Utils.__listify(_new_index)}"
+                     "#{Utils.listify(_alias)}/_rollover/#{Utils.listify(_new_index)}"
                    else
-                     "#{Utils.__listify(_alias)}/_rollover"
+                     "#{Utils.listify(_alias)}/_rollover"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          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(:rollover, [
-          :include_type_name,
-          :timeout,
-          :dry_run,
-          :master_timeout,
-          :wait_for_active_shards
-        ].freeze)
       end
     end
   end

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

@@ -14,50 +14,59 @@
 # 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
-        # Provides low-level information about segments in a Lucene index.
+        # Get index segments.
+        # Get low-level information about the Lucene segments in index shards.
+        # For data streams, the API returns information about the stream's backing 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 [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] :verbose Includes detailed memory usage by Lucene.
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases 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+, the request returns an error if it targets a missing or closed index.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-segments.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-segments
         #
         def segments(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.segments' }
+
+          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_GET
           path   = if _index
-                     "#{Utils.__listify(_index)}/_segments"
+                     "#{Utils.listify(_index)}/_segments"
                    else
-                     "_segments"
+                     '_segments'
                    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(:segments, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :verbose
-        ].freeze)
       end
     end
   end

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

@@ -14,50 +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
-        # Provides store information for shard copies of indices.
+        # Get index shard stores.
+        # Get store information about replica shards in one or more indices.
+        # For data streams, the API retrieves store information for the stream's backing indices.
+        # The index shard stores API returns the following information:
+        # * The node on which each replica shard exists.
+        # * The allocation ID for each replica shard.
+        # * A unique ID for each replica shard.
+        # * Any errors encountered while opening the shard index or from an earlier failure.
+        # By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.
         #
-        # @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 [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 List of data streams, indices, and aliases used to limit the request.
+        # @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.
+        # @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. Server default: open.
+        # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
+        # @option arguments [Shardstorestatus] :status List of shard health statuses used to limit the request.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-shards-stores.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shard-stores
         #
         def shard_stores(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.shard_stores' }
+
+          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_GET
           path   = if _index
-                     "#{Utils.__listify(_index)}/_shard_stores"
+                     "#{Utils.listify(_index)}/_shard_stores"
                    else
-                     "_shard_stores"
+                     '_shard_stores'
                    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(:shard_stores, [
-          :status,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
       end
     end
   end

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

@@ -14,53 +14,79 @@
 # 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
-        # Allow to shrink an existing index into a new index with fewer primary shards.
+        # Shrink an index.
+        # Shrink an index into a new index with fewer primary shards.
+        # Before you can shrink an index:
+        # * The index must be read-only.
+        # * A copy of every shard in the index must reside on the same node.
+        # * The index must have a green health status.
+        # To make shard allocation easier, we recommend you also remove the index's replica shards.
+        # You can later re-add replica shards as part of the shrink operation.
+        # The requested number of primary shards in the target index must be a factor of the number of shards in the source index.
+        # For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.
+        # If the number of shards in the index is a prime number it can only be shrunk into a single primary shard
+        #  Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.
+        # The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.
+        # A shrink operation:
+        # * Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.
+        # * Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.
+        # * Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the +.routing.allocation.initial_recovery._id+ index setting.
+        # IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:
+        # * The target index must not exist.
+        # * The source index must have more primary shards than the target index.
+        # * The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.
+        # * The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.
+        # * The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.
         #
-        # @option arguments [String] :index The name of the source index to shrink
-        # @option arguments [String] :target The name of the target index to shrink into
-        # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
+        # @option arguments [String] :index Name of the source index to shrink. (*Required*)
+        # @option arguments [String] :target Name of the target index to create. (*Required*)
+        # @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 [Time] :timeout Period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
+        #  Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-shrink-index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shrink
         #
         def shrink(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.shrink' }
+
+          defined_params = [:index, :target].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 'target' missing" unless arguments[:target]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = arguments.delete(:body)
 
           _index = arguments.delete(:index)
 
           _target = arguments.delete(:target)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "#{Utils.__listify(_index)}/_shrink/#{Utils.__listify(_target)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "#{Utils.listify(_index)}/_shrink/#{Utils.listify(_target)}"
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          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(:shrink, [
-          :copy_settings,
-          :timeout,
-          :master_timeout,
-          :wait_for_active_shards
-        ].freeze)
       end
     end
   end

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

@@ -14,47 +14,51 @@
 # 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
-        # Simulate matching the given index name against the index templates in the system
+        # Simulate an index.
+        # Get the index configuration that would be applied to the specified index from an existing index template.
         #
-        # @option arguments [String] :name The name of the index (it must be a concrete index name)
+        # @option arguments [String] :name Name of the index to simulate (*Required*)
         # @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 [String] :cause User defined reason for dry-run creating the new template for simulation purposes Server default: false.
+        # @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 [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
         # @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.17/indices-templates.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template
         #
         def simulate_index_template(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_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_POST
-          path   = "_index_template/_simulate_index/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = "_index_template/_simulate_index/#{Utils.listify(_name)}"
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          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(:simulate_index_template, [
-          :create,
-          :cause,
-          :master_timeout
-        ].freeze)
       end
     end
   end

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

@@ -14,49 +14,55 @@
 # 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
-        # Simulate resolving the given template name or body
+        # Simulate an index template.
+        # Get the index configuration that would be applied by a particular index template.
         #
-        # @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] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit
+        #  this parameter and specify the template configuration in the request body.
+        # @option arguments [Boolean] :create If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.
         # @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 [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 [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified
+        # @option arguments [Hash] :body request body
         #
-        # @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-simulate-template
         #
         def simulate_template(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_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?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _name
-                     "_index_template/_simulate/#{Utils.__listify(_name)}"
+                     "_index_template/_simulate/#{Utils.listify(_name)}"
                    else
-                     "_index_template/_simulate"
+                     '_index_template/_simulate'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          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(:simulate_template, [
-          :create,
-          :cause,
-          :master_timeout
-        ].freeze)
       end
     end
   end