elasticsearch-xpack 7.3.0 → 7.4.0

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_influencers.rb

@@ -25,22 +25,25 @@ module Elasticsearch
           #
           def get_influencers(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :exclude_interim,
-              :from,
-              :size,
-              :start,
-              :end,
-              :influencer_score,
-              :sort,
-              :desc ]
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/influencers"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:get_influencers, [ :exclude_interim,
+                                                      :from,
+                                                      :size,
+                                                      :start,
+                                                      :end,
+                                                      :influencer_score,
+                                                      :sort,
+                                                      :desc ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_job_stats.rb

@@ -16,16 +16,18 @@ module Elasticsearch
           # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-job-stats.html
           #
           def get_job_stats(arguments={})
-            valid_params = [
-              :allow_no_jobs ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_stats"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:get_job_stats, [ :allow_no_jobs ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_jobs.rb

@@ -16,16 +16,18 @@ module Elasticsearch
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
           #
           def get_jobs(arguments={})
-            valid_params = [
-              :allow_no_jobs ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:get_jobs, [ :allow_no_jobs ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_model_snapshots.rb

@@ -24,20 +24,23 @@ module Elasticsearch
           #
           def get_model_snapshots(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :from,
-              :size,
-              :start,
-              :end,
-              :sort,
-              :desc ]
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/model_snapshots/#{arguments[:snapshot_id]}"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:get_model_snapshots, [ :from,
+                                                          :size,
+                                                          :start,
+                                                          :end,
+                                                          :sort,
+                                                          :desc ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_overall_buckets.rb

@@ -24,23 +24,24 @@ module Elasticsearch
           #
           def get_overall_buckets(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-
-            valid_params = [
-              :top_n,
-              :bucket_span,
-              :overall_score,
-              :exclude_interim,
-              :start,
-              :end,
-              :allow_no_jobs ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/overall_buckets"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:get_overall_buckets, [ :top_n,
+                                                          :bucket_span,
+                                                          :overall_score,
+                                                          :exclude_interim,
+                                                          :start,
+                                                          :end,
+                                                          :allow_no_jobs ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_records.rb

@@ -25,24 +25,25 @@ module Elasticsearch
           #
           def get_records(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-
-            valid_params = [
-              :exclude_interim,
-              :from,
-              :size,
-              :start,
-              :end,
-              :record_score,
-              :sort,
-              :desc ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/records"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:get_records, [ :exclude_interim,
+                                                  :from,
+                                                  :size,
+                                                  :start,
+                                                  :end,
+                                                  :record_score,
+                                                  :sort,
+                                                  :desc ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/params_registry.rb

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+          module ParamsRegistry
+
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            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 7.4.0
+            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 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/machine_learning/post_data.rb

@@ -20,16 +20,19 @@ module Elasticsearch
           def post_data(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-            valid_params = [
-              :reset_start,
-              :reset_end ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_data"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:post_data, [ :reset_start,
+                                                :reset_end ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/revert_model_snapshot.rb

@@ -19,17 +19,18 @@ module Elasticsearch
           #
           def revert_model_snapshot(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-
-            valid_params = [
-              :delete_intervening_results ]
-
             method = Elasticsearch::API::HTTP_POST
             path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "model_snapshots", arguments[:snapshot_id], "_revert"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:revert_model_snapshot, [ :delete_intervening_results ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/set_upgrade_mode.rb

@@ -18,17 +18,19 @@ module Elasticsearch
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
           #
           def set_upgrade_mode(arguments={})
-
-            valid_params = [
-                :enabled,
-                :timeout ]
-
             method = Elasticsearch::API::HTTP_POST
             path   = '_ml/set_upgrade_mode'
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             perform_request(method, path, params).body
           end
+
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 7.4.0
+          ParamsRegistry.register(:set_upgrade_mode, [ :enabled,
+                                                       :timeout ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb

@@ -20,19 +20,20 @@ module Elasticsearch
           #
           def start_datafeed(arguments={})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
-
-            valid_params = [
-              :start,
-              :end,
-              :timeout ]
-
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_start"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:start_datafeed, [ :start,
+                                                     :end,
+                                                     :timeout ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb

@@ -19,17 +19,20 @@ module Elasticsearch
           #
           def stop_datafeed(arguments={})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
-            valid_params = [
-              :allow_no_datafeeds,
-              :force,
-              :timeout ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_stop"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:stop_datafeed, [ :allow_no_datafeeds,
+                                                    :force,
+                                                    :timeout ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/migration/get_assistance.rb

@@ -18,18 +18,20 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html
           #
           def get_assistance(arguments={})
-            valid_params = [
-              :allow_no_indices,
-              :expand_wildcards,
-              :ignore_unavailable ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/migration/assistance"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            params = Elasticsearch::API::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 7.4.0
+          ParamsRegistry.register(:get_assistance, [ :allow_no_indices,
+                                                     :expand_wildcards,
+                                                     :ignore_unavailable ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/migration/params_registry.rb

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module XPack
+    module API
+      module Migration
+        module Actions
+          module ParamsRegistry
+
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            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 7.4.0
+            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 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end