elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,26 +7,34 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :calendar_id The ID of the calendar to modify (*Required*)
-          # @option arguments [String] :job_id The ID of the job to add to the calendar (*Required*)
+          # @option arguments [String] :calendar_id The ID of the calendar to modify
+          # @option arguments [String] :job_id The ID of the job to add to the calendar
+
           #
           # @see [TODO]
           #
-          def put_calendar_job(arguments={})
+          def put_calendar_job(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            arguments = arguments.clone
+
+            _calendar_id = arguments.delete(:calendar_id)
+
+            _job_id = arguments.delete(:job_id)
+
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/ml/calendars/#{arguments[:calendar_id]}/jobs/#{arguments[:job_id]}"
+            path   = "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}/jobs/#{Elasticsearch::API::Utils.__listify(_job_id)}"
             params = {}
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -0,0 +1,38 @@
+# 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
+          # TODO: Description
+
+          #
+          # @option arguments [String] :id The ID of the data frame analytics to create
+
+          # @option arguments [Hash] :body The data frame analytics configuration (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html
+          #
+          def put_data_frame_analytics(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}"
+            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/put_datafeed.rb

@@ -7,26 +7,32 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Create a new datafeed
           #
-          # @option arguments [String] :datafeed_id The ID of the datafeed to create (*Required*)
+          # @option arguments [String] :datafeed_id The ID of the datafeed to create
+
           # @option arguments [Hash] :body The datafeed config (*Required*)
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html
           #
-          def put_datafeed(arguments={})
-            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+          def put_datafeed(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+
+            arguments = arguments.clone
+
+            _datafeed_id = arguments.delete(:datafeed_id)
+
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}"
+            path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,22 +7,32 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
+
+          #
+          # @option arguments [String] :filter_id The ID of the filter to create
 
-          # @option arguments [String] :filter_id The ID of the filter to create (*Required*)
           # @option arguments [Hash] :body The filter details (*Required*)
           #
-          def put_filter(arguments={})
-            raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
+          # @see [TODO]
+          #
+          def put_filter(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
+
+            arguments = arguments.clone
+
+            _filter_id = arguments.delete(:filter_id)
+
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/ml/filters/#{arguments[:filter_id]}"
+            path   = "_ml/filters/#{Elasticsearch::API::Utils.__listify(_filter_id)}"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,26 +7,32 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Create a new job
           #
-          # @option arguments [String] :job_id The ID of the job to create (*Required*)
+          # @option arguments [String] :job_id The ID of the job to create
+
           # @option arguments [Hash] :body The job (*Required*)
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html
           #
-          def put_job(arguments={})
-            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+          def put_job(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,32 +7,43 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Revert to a specific snapshot (eg. before a highly-anomalous, but insignificant event)
           #
-          # @option arguments [String] :job_id The ID of the job to fetch (*Required*)
+          # @option arguments [String] :job_id The ID of the job to fetch
           # @option arguments [String] :snapshot_id The ID of the snapshot to revert to
-          # @option arguments [Hash] :body Reversion options
           # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot?
+
+          # @option arguments [Hash] :body Reversion options
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html
           #
-          def revert_model_snapshot(arguments={})
+          def revert_model_snapshot(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            raise ArgumentError, "Required argument 'snapshot_id' missing" unless arguments[:snapshot_id]
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
+            _snapshot_id = arguments.delete(:snapshot_id)
+
             method = Elasticsearch::API::HTTP_POST
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "model_snapshots", arguments[:snapshot_id], "_revert"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/model_snapshots/#{Elasticsearch::API::Utils.__listify(_snapshot_id)}/_revert"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = arguments[:body]
 
+            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
+          # @since 6.2.0
+          ParamsRegistry.register(:revert_model_snapshot, [
+            :delete_intervening_results
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,32 +7,35 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening.
-          # When enabled=true this API temporarily halts all job and datafeed tasks and prohibits new job and
-          #   datafeed tasks from starting.
           #
-          # @option arguments [ true, false ] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false.
-          # @option arguments [String] :timeout Controls the time to wait before action times out. Defaults to 30 seconds.
+          # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false.
+          # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
           #
-          def set_upgrade_mode(arguments={})
+          def set_upgrade_mode(arguments = {})
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = '_ml/set_upgrade_mode'
+            path   = "_ml/set_upgrade_mode"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-            perform_request(method, path, params).body
+            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(:set_upgrade_mode, [ :enabled,
-                                                       :timeout ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:set_upgrade_mode, [
+            :enabled,
+            :timeout
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -0,0 +1,45 @@
+# 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
+          # TODO: Description
+
+          #
+          # @option arguments [String] :id The ID of the data frame analytics to start
+          # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds
+
+          # @option arguments [Hash] :body The start data frame analytics parameters
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html
+          #
+          def start_data_frame_analytics(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_start"
+            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 6.2.0
+          ParamsRegistry.register(:start_data_frame_analytics, [
+            :timeout
+          ].freeze)
+      end
+    end
+    end
+  end
+end

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

@@ -7,35 +7,43 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Start a datafeed
           #
-          # @option arguments [String] :datafeed_id The ID of the datafeed to start (*Required*)
-          # @option arguments [Hash] :body The start datafeed parameters
+          # @option arguments [String] :datafeed_id The ID of the datafeed to start
           # @option arguments [String] :start The start time from where the datafeed should begin
           # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
           # @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds
+
+          # @option arguments [Hash] :body The start datafeed parameters
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
           #
-          def start_datafeed(arguments={})
+          def start_datafeed(arguments = {})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+
+            arguments = arguments.clone
+
+            _datafeed_id = arguments.delete(:datafeed_id)
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_start"
+            path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_start"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = arguments[:body]
 
+            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
+          # @since 6.2.0
+          ParamsRegistry.register(:start_datafeed, [
+            :start,
+            :end,
+            :timeout
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -0,0 +1,49 @@
+# 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
+          # TODO: Description
+
+          #
+          # @option arguments [String] :id The ID of the data frame analytics to stop
+          # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
+          # @option arguments [Boolean] :force True if the data frame analytics should be forcefully stopped
+          # @option arguments [Time] :timeout Controls the time to wait until the task has stopped. Defaults to 20 seconds
+
+          # @option arguments [Hash] :body The stop data frame analytics parameters
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html
+          #
+          def stop_data_frame_analytics(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_stop"
+            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 6.2.0
+          ParamsRegistry.register(:stop_data_frame_analytics, [
+            :allow_no_match,
+            :force,
+            :timeout
+          ].freeze)
+      end
+    end
+    end
+  end
+end