elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,30 +7,35 @@ module Elasticsearch
     module API
       module License
         module Actions
-
           # TODO: Description
+
           #
           # @option arguments [String] :type The type of trial license to generate (default: "trial")
           # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/license-management.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html
           #
-          def post_start_trial(arguments={})
+          def post_start_trial(arguments = {})
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/license/start_trial"
+            path   = "_license/start_trial"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            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
+          # @since 6.2.0
+          ParamsRegistry.register(:post_start_trial, [
+            :type,
+            :acknowledge
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,34 +7,43 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :job_id The name of the job to close (*Required*)
+          # @option arguments [String] :job_id The name of the job to close
           # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
           # @option arguments [Boolean] :force True if the job should be forcefully closed
           # @option arguments [Time] :timeout Controls the time to wait until a job has closed. Default to 30 minutes
+
+          # @option arguments [Hash] :body The URL params optionally sent in the body
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html
           #
-          def close_job(arguments={})
+          def close_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_close"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_close"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            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(:close_job, [ :allow_no_jobs,
-                                                :force,
-                                                :timeout ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:close_job, [
+            :allow_no_jobs,
+            :force,
+            :timeout
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,24 +7,30 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :calendar_id The ID of the calendar to delete (*Required*)
+          # @option arguments [String] :calendar_id The ID of the calendar to delete
+
           #
           # @see [TODO]
           #
-          def delete_calendar(arguments={})
+          def delete_calendar(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
+
+            arguments = arguments.clone
+
+            _calendar_id = arguments.delete(:calendar_id)
+
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/ml/calendars/#{arguments[:calendar_id]}"
+            path   = "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_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/delete_calendar_event.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] :event_id The ID of the event to remove from the calendar (*Required*)
+          # @option arguments [String] :calendar_id The ID of the calendar to modify
+          # @option arguments [String] :event_id The ID of the event to remove from the calendar
+
           #
           # @see [TODO]
           #
-          def delete_calendar_event(arguments={})
+          def delete_calendar_event(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
             raise ArgumentError, "Required argument 'event_id' missing" unless arguments[:event_id]
+
+            arguments = arguments.clone
+
+            _calendar_id = arguments.delete(:calendar_id)
+
+            _event_id = arguments.delete(:event_id)
+
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/ml/calendars/#{arguments[:calendar_id]}/events/#{URI.escape(arguments[:event_id])}"
+            path   = "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}/events/#{Elasticsearch::API::Utils.__listify(_event_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/delete_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 remove from 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 remove from the calendar
+
           #
           # @see [TODO]
           #
-          def delete_calendar_job(arguments={})
+          def delete_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_DELETE
-            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/delete_data_frame_analytics.rb

@@ -0,0 +1,36 @@
+# 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 delete
+
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html
+          #
+          def delete_data_frame_analytics(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body).body
+          end
+      end
+    end
+    end
+  end
+end

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

@@ -7,30 +7,38 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :datafeed_id The ID of the datafeed to delete (*Required*)
+          # @option arguments [String] :datafeed_id The ID of the datafeed to delete
           # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html
           #
-          def delete_datafeed(arguments={})
+          def delete_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_DELETE
-            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}"
+            path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            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
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_datafeed, [
+            :force
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,17 +7,23 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
+
+          #
+          # @see [TODO]
+          #
+          def delete_expired_data(arguments = {})
+            arguments = arguments.clone
 
-          def delete_expired_data(arguments={})
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/ml/_delete_expired_data"
+            path   = "_ml/_delete_expired_data"
             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/delete_filter.rb

@@ -7,20 +7,30 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # @option arguments [String] :filter_id The ID of the filter to delete (*Required*)
           #
-          def delete_filter(arguments={})
+          # @option arguments [String] :filter_id The ID of the filter to delete
+
+          #
+          # @see [TODO]
+          #
+          def delete_filter(arguments = {})
             raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
+
+            arguments = arguments.clone
+
+            _filter_id = arguments.delete(:filter_id)
+
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/ml/filters/#{arguments[:filter_id]}"
+            path   = "_ml/filters/#{Elasticsearch::API::Utils.__listify(_filter_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/delete_forecast.rb

@@ -1,35 +1,53 @@
+# 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] :job_id The ID of the job from which to delete forecasts (*Required*)
-          # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list.
-          #   Leaving blank implies `_all`
+          #
+          # @option arguments [String] :job_id The ID of the job from which to delete forecasts
+          # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`
           # @option arguments [Boolean] :allow_no_forecasts Whether to ignore if `_all` matches no forecasts
-          # @option arguments [Time] :timeout Controls the time to wait until the forecast(s) are deleted.
-          #   Default to 30 seconds.
+          # @option arguments [Time] :timeout Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
+
           #
-          def delete_forecast(arguments={})
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html
+          #
+          def delete_forecast(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
-            method = Elasticsearch::API::HTTP_DELETE
-            path   = "_ml/anomaly_detectors/#{arguments[:job_id]}/_forecast/#{arguments[:forecast_id]}"
 
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
+            _forecast_id = arguments.delete(:forecast_id)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = if _job_id && _forecast_id
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_forecast/#{Elasticsearch::API::Utils.__listify(_forecast_id)}"
+                     else
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_forecast"
+  end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            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
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_forecast, [
+            :allow_no_forecasts,
+            :timeout
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,30 +7,40 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Delete an existing anomaly detection job
           #
-          # @option arguments [String] :job_id The ID of the job to delete (*Required*)
+          # @option arguments [String] :job_id The ID of the job to delete
           # @option arguments [Boolean] :force True if the job should be forcefully deleted
+          # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
           #
-          def delete_job(arguments={})
+          def delete_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            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
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_job, [
+            :force,
+            :wait_for_completion
+          ].freeze)
       end
     end
+    end
   end
 end