elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,42 +7,56 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve information about model snapshots
           #
-          # @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 fetch
-          # @option arguments [Hash] :body Model snapshot selection criteria
-          # @option arguments [Integer] :from Skips a number of documents
-          # @option arguments [Integer] :size The default number of documents returned in queries as a string.
+          # @option arguments [Int] :from Skips a number of documents
+          # @option arguments [Int] :size The default number of documents returned in queries as a string.
           # @option arguments [Date] :start The filter 'start' query parameter
           # @option arguments [Date] :end The filter 'end' query parameter
           # @option arguments [String] :sort Name of the field to sort on
           # @option arguments [Boolean] :desc True if the results should be sorted in descending order
+
+          # @option arguments [Hash] :body Model snapshot selection criteria
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
           #
-          def get_model_snapshots(arguments={})
+          def get_model_snapshots(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
+            _snapshot_id = arguments.delete(:snapshot_id)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/model_snapshots/#{arguments[:snapshot_id]}"
+            path   = if _job_id && _snapshot_id
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/model_snapshots/#{Elasticsearch::API::Utils.__listify(_snapshot_id)}"
+                     else
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/model_snapshots"
+  end
             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(:get_model_snapshots, [ :from,
-                                                          :size,
-                                                          :start,
-                                                          :end,
-                                                          :sort,
-                                                          :desc ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_model_snapshots, [
+            :from,
+            :size,
+            :start,
+            :end,
+            :sort,
+            :desc
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,11 +7,10 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve overall bucket results that summarize the bucket results of multiple jobs
           #
-          # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results (*Required*)
-          # @option arguments [Hash] :body Overall bucket selection details if not provided in URI
+          # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results
           # @option arguments [Int] :top_n The number of top job bucket scores to be used in the overall_score calculation
           # @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span
           # @option arguments [Double] :overall_score Returns overall buckets with overall scores higher than this value
@@ -19,31 +18,40 @@ module Elasticsearch
           # @option arguments [String] :start Returns overall buckets with timestamps after this time
           # @option arguments [String] :end Returns overall buckets with timestamps earlier than this time
           # @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 [Hash] :body Overall bucket selection details if not provided in URI
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
           #
-          def get_overall_buckets(arguments={})
+          def get_overall_buckets(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_GET
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/overall_buckets"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/overall_buckets"
             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(:get_overall_buckets, [ :top_n,
-                                                          :bucket_span,
-                                                          :overall_score,
-                                                          :exclude_interim,
-                                                          :start,
-                                                          :end,
-                                                          :allow_no_jobs ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_overall_buckets, [
+            :top_n,
+            :bucket_span,
+            :overall_score,
+            :exclude_interim,
+            :start,
+            :end,
+            :allow_no_jobs
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,11 +7,10 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve anomaly records for a job
           #
-          # @option arguments [String] :job_id [TODO] (*Required*)
-          # @option arguments [Hash] :body Record selection criteria
+          # @option arguments [String] :job_id [TODO]
           # @option arguments [Boolean] :exclude_interim Exclude interim results
           # @option arguments [Int] :from skips a number of records
           # @option arguments [Int] :size specifies a max number of records to get
@@ -20,32 +19,41 @@ module Elasticsearch
           # @option arguments [Double] :record_score [TODO]
           # @option arguments [String] :sort Sort records by a particular field
           # @option arguments [Boolean] :desc Set the sort direction
+
+          # @option arguments [Hash] :body Record selection criteria
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
           #
-          def get_records(arguments={})
+          def get_records(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_GET
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/results/records"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/records"
             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(:get_records, [ :exclude_interim,
-                                                  :from,
-                                                  :size,
-                                                  :start,
-                                                  :end,
-                                                  :record_score,
-                                                  :sort,
-                                                  :desc ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_records, [
+            :exclude_interim,
+            :from,
+            :size,
+            :start,
+            :end,
+            :record_score,
+            :sort,
+            :desc
+          ].freeze)
       end
     end
+    end
   end
 end

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

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

@@ -7,26 +7,30 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Open a job to receive and analyze data
           #
-          # @option arguments [String] :job_id The ID of the job to open (*Required*)
-          # @option arguments [Boolean] :ignore_downtime Controls if gaps in data are treated as anomalous or as a maintenance window after a job re-start
-          # @option arguments [Time] :timeout Controls the time to wait until a job has opened. Default to 30 minutes
+          # @option arguments [String] :job_id The ID of the job to open
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html
           #
-          def open_job(arguments={})
+          def open_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]}/_open"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_open"
             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/params_registry.rb

@@ -8,7 +8,6 @@ module Elasticsearch
       module MachineLearning
         module Actions
           module ParamsRegistry
-
             extend self
 
             # A Mapping of all the actions to their list of valid params.

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

@@ -7,26 +7,32 @@ 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] :calendar_id The ID of the calendar to modify
+
           # @option arguments [Hash] :body A list of events (*Required*)
           #
           # @see [TODO]
           #
-          def post_calendar_events(arguments={})
-            raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
+          def post_calendar_events(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
+
+            arguments = arguments.clone
+
+            _calendar_id = arguments.delete(:calendar_id)
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/ml/calendars/#{arguments[:calendar_id]}/events"
+            path   = "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}/events"
             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/post_data.rb

@@ -7,34 +7,42 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Send data to an anomaly detection job for analysis
           #
-          # @option arguments [String] :job_id The name of the job receiving the data (*Required*)
-          # @option arguments [Hash] :body The data to process (*Required*)
+          # @option arguments [String] :job_id The name of the job receiving the data
           # @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range
           # @option arguments [String] :reset_end Optional parameter to specify the end of the bucket resetting range
+
+          # @option arguments [Hash] :body The data to process (*Required*)
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html
           #
-          def post_data(arguments={})
-            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+          def post_data(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_POST
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_data"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_data"
             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(:post_data, [ :reset_start,
-                                                :reset_end ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:post_data, [
+            :reset_start,
+            :reset_end
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,24 +7,30 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Preview a datafeed
           #
-          # @option arguments [String] :datafeed_id The ID of the datafeed to preview (*Required*)
+          # @option arguments [String] :datafeed_id The ID of the datafeed to preview
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html
           #
-          def preview_datafeed(arguments={})
+          def preview_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_GET
-            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_preview"
+            path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_preview"
             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_calendar.rb

@@ -7,25 +7,31 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :calendar_id The ID of the calendar to create (*Required*)
+          # @option arguments [String] :calendar_id The ID of the calendar to create
+
           # @option arguments [Hash] :body The calendar details
           #
           # @see [TODO]
           #
-          def put_calendar(arguments={})
+          def put_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_PUT
-            path   = "_xpack/ml/calendars/#{arguments[:calendar_id]}"
+            path   = "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end