elasticsearch-api 6.0.1 → 7.0.0

data/lib/elasticsearch/api/actions/ingest/params_registry.rb

@@ -0,0 +1,61 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+        module ParamsRegistry
+
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.1.1
+          PARAMS = {}
+
+          # Register an action with its list of valid params.
+          #
+          # @example Register the action.
+          #   ParamsRegistry.register(:benchmark, [ :verbose ])
+          #
+          # @param [ Symbol ] action The action to register.
+          # @param [ Array[Symbol] ] valid_params The list of valid params.
+          #
+          # @since 6.1.1
+          def register(action, valid_params)
+            PARAMS[action.to_sym] = valid_params
+          end
+
+          # Get the list of valid params for a given action.
+          #
+          # @example Get the list of valid params.
+          #   ParamsRegistry.get(:benchmark)
+          #
+          # @param [ Symbol ] action The action.
+          #
+          # @return [ Array<Symbol> ] The list of valid params for the action.
+          #
+          # @since 6.1.1
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/ingest/processor_grok.rb

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+
+        # Extracts structured fields out of a single text field within a document. You choose which field to extract
+        #   matched fields from, as well as the grok pattern you expect will match.
+        #
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        #
+        def processor_grok(arguments={})
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_ingest/processor/grok"
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:processor_grok, [
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb

@@ -1,3 +1,20 @@
+# 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.
+
 module Elasticsearch
   module API
     module Ingest
@@ -15,17 +32,21 @@ module Elasticsearch
         def put_pipeline(arguments={})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          valid_params = [
-            :master_timeout,
-            :timeout ]
           method = 'PUT'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = arguments[:body]
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:put_pipeline, [
+            :master_timeout,
+            :timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/simulate.rb

@@ -1,3 +1,20 @@
+# 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.
+
 module Elasticsearch
   module API
     module Ingest
@@ -14,15 +31,18 @@ module Elasticsearch
         #
         def simulate(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          valid_params = [
-            :verbose ]
           method = 'GET'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id]), '_simulate'
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = arguments[:body]
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:simulate, [ :verbose ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/mget.rb

@@ -1,3 +1,20 @@
+# 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.
+
 module Elasticsearch
   module API
     module Actions
@@ -27,50 +44,45 @@ module Elasticsearch
       #
       # @option arguments [String] :index The name of the index
       # @option arguments [String] :type The type of the document
-      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information)
-      #                                or `ids` (when index and type is provided in the URL (*Required*)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
-      # @option arguments [String] :parent The ID of the parent document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (*Required*)
+      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :_source Specify whether the _source field should be returned,
-      #                                     or a list of fields to return
-      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
       #
       # @see http://elasticsearch.org/guide/reference/api/multi-get/
       #
       def mget(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-        valid_params = [
-          :fields,
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_include,
-          :_source_exclude,
-          :stored_fields ]
-
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  '_mget'
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
 
         perform_request(method, path, params, body).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.1.1
+      ParamsRegistry.register(:mget, [
+          :stored_fields,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_excludes,
+          :_source_includes ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/msearch.rb

@@ -1,3 +1,20 @@
+# 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.
+
 module Elasticsearch
   module API
     module Actions
@@ -22,7 +39,7 @@ module Elasticsearch
       #         { query: { match_all: {} } },
       #         { index: 'myindex', type: 'mytype' },
       #         { query: { query_string: { query: '"Test 1"' } } },
-      #         { search_type: 'count' },
+      #         { search_type: 'query_then_fetch' },
       #         { aggregations: { published: { terms: { field: 'published' } } } }
       #       ]
       #
@@ -32,21 +49,19 @@ module Elasticsearch
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
+      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html
       #
       def msearch(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-         valid_params = [
-          :search_type,
-          :max_concurrent_searches,
-          :typed_keys ]
-
         method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_msearch' )
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         case
@@ -71,8 +86,20 @@ module Elasticsearch
           payload = body
         end
 
-        perform_request(method, path, params, payload).body
+        perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.1.1
+      ParamsRegistry.register(:msearch, [
+          :search_type,
+          :max_concurrent_searches,
+          :typed_keys,
+          :pre_filter_shard_size,
+          :max_concurrent_shard_requests,
+          :rest_total_hits_as_int,
+          :ccs_minimize_roundtrips ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/msearch_template.rb

@@ -1,3 +1,20 @@
+# 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.
+
 module Elasticsearch
   module API
     module Actions
@@ -15,18 +32,20 @@ module Elasticsearch
       # @option arguments [List] :type A comma-separated list of document types to use as default
       # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
+      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+      # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-search-template.html
       #
       def msearch_template(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-        valid_params = [ :search_type ]
         method = HTTP_GET
         path   = Utils.__pathify Utils.__listify(arguments[:index]),
                                  Utils.__listify(arguments[:type]),
                                  '_msearch/template'
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         case
@@ -38,8 +57,18 @@ module Elasticsearch
             payload = body
         end
 
-        perform_request(method, path, params, payload).body
+        perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.1.1
+      ParamsRegistry.register(:msearch_template, [
+          :search_type,
+          :typed_keys,
+          :max_concurrent_searches,
+          :rest_total_hits_as_int,
+          :ccs_minimize_roundtrips ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/mtermvectors.rb

@@ -1,3 +1,20 @@
+# 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.
+
 module Elasticsearch
   module API
     module Actions
@@ -9,25 +26,22 @@ module Elasticsearch
       #
       #     subject.mtermvectors index: 'my-index', type: 'my-type', body: { ids: [1, 2, 3] }
       #
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document
-      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information)
-      #                                or `ids` (when index and type is provided in the URL (*Required*)
-      # @option arguments [List] :ids A comma-separated list of documents ids (alternative to `:body`)
-      # @option arguments [Boolean] :term_statistics Whether total term frequency and
-      #                                              document frequency should be returned.
-      # @option arguments [Boolean] :field_statistics Whether document count, sum of document frequencies
-      #                                               and sum of total term frequencies should be returned.
-      # @option arguments [List] :fields A comma-separated list of fields to return
-      # @option arguments [Boolean] :offsets Whether term offsets should be returned
-      # @option arguments [Boolean] :positions Whether term positions should be returned
-      # @option arguments [Boolean] :payloads Whether term payloads should be returned
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
-      # @option arguments [String] :realtime Specifies if requests are real-time as opposed to near-real-time
-      #                                      (default: true)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :parent Parent ID of documents
+      # @option arguments [String] :index The index in which the document resides.
+      # @option arguments [String] :type The type of the document.
+      # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
+      # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
+      # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [List] :fields A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :offsets Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :positions Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :parent Parent id of documents. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true).
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
       #
@@ -35,19 +49,6 @@ module Elasticsearch
       # @see #termvector
       #
       def mtermvectors(arguments={})
-        valid_params = [
-          :ids,
-          :term_statistics,
-          :field_statistics,
-          :fields,
-          :offsets,
-          :positions,
-          :payloads,
-          :preference,
-          :realtime,
-          :routing,
-          :parent ]
-
         ids = arguments.delete(:ids)
 
         method = HTTP_GET
@@ -55,7 +56,7 @@ module Elasticsearch
                                  Utils.__escape(arguments[:type]),
                                  '_mtermvectors'
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         if ids
           body = { :ids => ids }
@@ -65,6 +66,24 @@ module Elasticsearch
 
         perform_request(method, path, params, body).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.1.1
+      ParamsRegistry.register(:mtermvectors, [
+          :ids,
+          :term_statistics,
+          :field_statistics,
+          :fields,
+          :offsets,
+          :positions,
+          :payloads,
+          :preference,
+          :routing,
+          :parent,
+          :realtime,
+          :version,
+          :version_type ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/nodes/hot_threads.rb

@@ -1,3 +1,20 @@
+# 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.
+
 module Elasticsearch
   module API
     module Nodes
@@ -13,12 +30,11 @@ module Elasticsearch
         #
         #     client.nodes.hot_threads threads: 10
         #
-        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
-        #                                   use `_local` to return information from the node you're connecting to,
-        #                                   leave empty to get information from all nodes
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [Time] :interval The interval for the second sampling of threads
         # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10)
         # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3)
+        # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
         # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
         # @option arguments [Time] :timeout Explicit operation timeout
         #
@@ -27,21 +43,25 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
         #
         def hot_threads(arguments={})
-          valid_params = [
-            :interval,
-            :snapshots,
-            :threads,
-            :type,
-            :timeout ]
-
           method = HTTP_GET
           path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'hot_threads'
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body = nil
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:hot_threads, [
+            :interval,
+            :snapshots,
+            :threads,
+            :ignore_idle_threads,
+            :type,
+            :timeout ].freeze)
       end
     end
   end