elasticsearch-xpack 7.3.0 → 7.4.0

data/lib/elasticsearch/xpack/api/actions/license/post.rb

@@ -17,14 +17,18 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/x-pack/current/license-management.html
           #
           def post(arguments={})
-            valid_params = [ :acknowledge ]
             method = Elasticsearch::API::HTTP_PUT
             path   = "_xpack/license"
-            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, [ :acknowledge ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/license/post_start_basic.rb

@@ -15,15 +15,18 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/x-pack/current/license-management.html
           #
           def post_start_basic(arguments={})
-            valid_params = [
-              :acknowledge ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/license/start_basic"
-            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(:post_start_basic, [ :acknowledge ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/license/post_start_trial.rb

@@ -16,16 +16,19 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/x-pack/current/license-management.html
           #
           def post_start_trial(arguments={})
-            valid_params = [
-              :type,
-              :acknowledge ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/license/start_trial"
-            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(:post_start_trial, [ :type,
+                                                       :acknowledge ].freeze)
         end
       end
     end

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

@@ -19,17 +19,20 @@ module Elasticsearch
           #
           def close_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :allow_no_jobs,
-              :force,
-              :timeout ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_close"
-            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(:close_job, [ :allow_no_jobs,
+                                                :force,
+                                                :timeout ].freeze)
         end
       end
     end

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

@@ -17,15 +17,18 @@ module Elasticsearch
           #
           def delete_datafeed(arguments={})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
-            valid_params = [
-              :force ]
             method = Elasticsearch::API::HTTP_DELETE
             path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_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(:delete_datafeed, [ :force ].freeze)
         end
       end
     end

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

@@ -16,16 +16,18 @@ module Elasticsearch
             method = Elasticsearch::API::HTTP_DELETE
             path   = "_ml/anomaly_detectors/#{arguments[:job_id]}/_forecast/#{arguments[:forecast_id]}"
 
-            valid_params = [
-                :forecast_id,
-                :allow_no_forecasts,
-                :timeout ]
-
-            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(:delete_forecast, [ :forecast_id,
+                                                      :allow_no_forecasts,
+                                                      :timeout ].freeze)
         end
       end
     end

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

@@ -17,15 +17,18 @@ module Elasticsearch
           #
           def delete_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :force ]
             method = Elasticsearch::API::HTTP_DELETE
             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(:delete_job, [ :force ].freeze)
         end
       end
     end

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

@@ -0,0 +1,30 @@
+# 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
+
+          # Estimates memory usage for the given data frame analytics config.
+          #
+          # @option arguments [Hash] :body Memory usage estimation definition (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/estimate-memory-usage-dfanalytics.html
+          #
+          def estimate_memory_usage(arguments={})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/data_frame/analytics/_estimate_memory_usage"
+            params = {}
+            body   = arguments[:body]
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -23,19 +23,22 @@ module Elasticsearch
           #
           def flush_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :calc_interim,
-              :start,
-              :end,
-              :advance_time,
-              :skip_time ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_flush"
-            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(:flush_job, [ :calc_interim,
+                                                :start,
+                                                :end,
+                                                :advance_time,
+                                                :skip_time ].freeze)
         end
       end
     end

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

@@ -18,16 +18,19 @@ module Elasticsearch
           #
           def forecast(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :duration,
-              :expires_in ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_forecast"
-            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(:forecast, [ :duration,
+                                               :expires_in ].freeze)
         end
       end
     end

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

@@ -27,28 +27,30 @@ module Elasticsearch
           #
           def get_buckets(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :timestamp,
-              :expand,
-              :exclude_interim,
-              :from,
-              :size,
-              :start,
-              :end,
-              :anomaly_score,
-              :sort,
-              :desc ]
-
             arguments = arguments.clone
             timestamp = arguments.delete(:timestamp)
 
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "results/buckets", timestamp
-            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_buckets, [ :timestamp,
+                                                  :expand,
+                                                  :exclude_interim,
+                                                  :from,
+                                                  :size,
+                                                  :start,
+                                                  :end,
+                                                  :anomaly_score,
+                                                  :sort,
+                                                  :desc ].freeze)
         end
       end
     end

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

@@ -21,24 +21,26 @@ module Elasticsearch
           #
           def get_calendar_events(arguments={})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
-            valid_params = [
-              :calendar_id,
-              :job_id,
-              :start,
-              :end,
-              :from,
-              :size ]
-
             arguments = arguments.clone
             calendar_id = arguments.delete(:calendar_id)
 
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/calendars/#{calendar_id}/events"
-            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_calendar_events, [ :calendar_id,
+                                                          :job_id,
+                                                          :start,
+                                                          :end,
+                                                          :from,
+                                                          :size ].freeze)
         end
       end
     end

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

@@ -17,21 +17,23 @@ module Elasticsearch
           # @see [TODO]
           #
           def get_calendars(arguments={})
-            valid_params = [
-              :calendar_id,
-              :from,
-              :size ]
-
             arguments = arguments.clone
             calendar_id = arguments.delete(:calendar_id)
 
             method = Elasticsearch::API::HTTP_GET
             path   = "_xpack/ml/calendars/#{calendar_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_calendars, [ :calendar_id,
+                                                    :from,
+                                                    :size ].freeze)
         end
       end
     end

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

@@ -20,16 +20,19 @@ module Elasticsearch
           #
           def get_categories(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            valid_params = [
-              :from,
-              :size ]
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "results/categories", arguments[:category_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_categories, [ :from,
+                                                     :size ].freeze)
         end
       end
     end

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

@@ -16,16 +16,18 @@ module Elasticsearch
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
           #
           def get_datafeed_stats(arguments={})
-            valid_params = [
-              :allow_no_datafeeds ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/datafeeds", arguments[:datafeed_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_datafeed_stats, [ :allow_no_datafeeds ].freeze)
         end
       end
     end

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

@@ -16,16 +16,18 @@ module Elasticsearch
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
           #
           def get_datafeeds(arguments={})
-            valid_params = [
-              :allow_no_datafeeds ]
-
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/datafeeds", arguments[:datafeed_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_datafeeds, [ :allow_no_datafeeds ].freeze)
         end
       end
     end

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

@@ -13,16 +13,19 @@ module Elasticsearch
           # @option arguments [Int] :size specifies a max number of filters to get
           #
           def get_filters(arguments={})
-            valid_params = [
-              :from,
-              :size ]
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/filters", arguments[:filter_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_filters, [ :from,
+                                                  :size ].freeze)
         end
       end
     end