RubyGems - elasticsearch-xpack - Versions diffs - 7.8.0 → 7.9.0.pre - Mend

elasticsearch-xpack 7.8.0 → 7.9.0.pre

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (214) hide show

data/lib/elasticsearch/xpack/api/actions/license/delete.rb CHANGED

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/delete-license.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-license.html
           #
           def delete(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -38,8 +38,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/license/get.rb CHANGED

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Boolean] :accept_enterprise If the active license is an enterprise license, return type as 'enterprise' (default: false)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/get-license.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-license.html
           #
           def get(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -48,8 +48,8 @@ module Elasticsearch
             :local,
             :accept_enterprise
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/license/get_basic_status.rb CHANGED

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/get-basic-status.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-basic-status.html
           #
           def get_basic_status(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -38,8 +38,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/license/get_trial_status.rb CHANGED

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/get-trial-status.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-trial-status.html
           #
           def get_trial_status(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -38,8 +38,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body licenses to be installed
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/update-license.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/update-license.html
           #
           def post(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -47,8 +47,8 @@ module Elasticsearch
           ParamsRegistry.register(:post, [
             :acknowledge
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/start-basic.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/start-basic.html
           #
           def post_start_basic(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -46,8 +46,8 @@ module Elasticsearch
           ParamsRegistry.register(:post_start_basic, [
             :acknowledge
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/start-trial.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/start-trial.html
           #
           def post_start_trial(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -48,8 +48,8 @@ module Elasticsearch
             :type,
             :acknowledge
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -29,7 +29,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The URL params optionally sent in the body
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-close-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-close-job.html
           #
           def close_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -56,8 +56,8 @@ module Elasticsearch
             :force,
             :timeout
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :calendar_id The ID of the calendar to delete
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-calendar.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-calendar.html
           #
           def delete_calendar(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
@@ -43,8 +43,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_calendar_event.rb CHANGED

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :event_id The ID of the event to remove from the calendar
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-calendar-event.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-calendar-event.html
           #
           def delete_calendar_event(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
@@ -47,8 +47,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_calendar_job.rb CHANGED

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :job_id The ID of the job to remove from the calendar
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-calendar-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-calendar-job.html
           #
           def delete_calendar_job(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
@@ -47,8 +47,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_data_frame_analytics.rb CHANGED

@@ -27,7 +27,7 @@ module Elasticsearch
           # @option arguments [Time] :timeout Controls the time to wait until a job is deleted. Defaults to 1 minute
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/delete-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-dfanalytics.html
           #
           def delete_data_frame_analytics(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -53,8 +53,8 @@ module Elasticsearch
             :force,
             :timeout
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-datafeed.html
           #
           def delete_datafeed(arguments = {})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
@@ -51,8 +51,8 @@ module Elasticsearch
           ParamsRegistry.register(:delete_datafeed, [
             :force
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -22,25 +22,42 @@ module Elasticsearch
         module Actions
           # Deletes expired and unused machine learning data.
           #
+          # @option arguments [String] :job_id The ID of the job(s) to perform expired data hygiene for
+          # @option arguments [Number] :requests_per_second The desired requests per second for the deletion processes.
+          # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body deleting expired data parameters
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-expired-data.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-expired-data.html
           #
           def delete_expired_data(arguments = {})
             headers = arguments.delete(:headers) || {}
             arguments = arguments.clone
+            _job_id = arguments.delete(:job_id)
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_ml/_delete_expired_data"
-            params = {}
+            path   = if _job_id
+                       "_ml/_delete_expired_data/#{Elasticsearch::API::Utils.__listify(_job_id)}"
+                     else
+                       "_ml/_delete_expired_data"
+                     end
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             body = arguments[:body]
             perform_request(method, path, params, body, headers).body
           end
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_expired_data, [
+            :requests_per_second,
+            :timeout
+          ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_filter.rb CHANGED

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :filter_id The ID of the filter to delete
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-filter.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-filter.html
           #
           def delete_filter(arguments = {})
             raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
@@ -43,8 +43,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -28,7 +28,7 @@ module Elasticsearch
           # @option arguments [Time] :timeout Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-forecast.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-forecast.html
           #
           def delete_forecast(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -46,7 +46,7 @@ module Elasticsearch
                        "_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
+                     end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
             body = nil
@@ -60,8 +60,8 @@ module Elasticsearch
             :allow_no_forecasts,
             :timeout
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -27,7 +27,7 @@ module Elasticsearch
           # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-job.html
           #
           def delete_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -53,8 +53,8 @@ module Elasticsearch
             :force,
             :wait_for_completion
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_model_snapshot.rb CHANGED

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :snapshot_id The ID of the snapshot to delete
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-delete-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-delete-snapshot.html
           #
           def delete_model_snapshot(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -47,8 +47,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_trained_model.rb CHANGED

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :model_id The ID of the trained model to delete
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/delete-inference.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-inference.html
           #
           def delete_trained_model(arguments = {})
             raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
@@ -43,8 +43,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -38,8 +38,8 @@ module Elasticsearch
             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/estimate_model_memory.rb CHANGED

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The analysis config, plus cardinality estimates for fields it references (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-apis.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-apis.html
           #
           def estimate_model_memory(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -41,8 +41,8 @@ module Elasticsearch
             body = arguments[:body]
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/machine_learning/evaluate_data_frame.rb CHANGED

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The evaluation definition (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/evaluate-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/evaluate-dfanalytics.html
           #
           def evaluate_data_frame(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -41,8 +41,8 @@ module Elasticsearch
             body = arguments[:body]
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end