elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,26 +7,34 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Delete an existing model snapshot
           #
-          # @option arguments [String] :job_id The ID of the job to fetch (*Required*)
-          # @option arguments [String] :snapshot_id The ID of the snapshot to delete (*Required*)
+          # @option arguments [String] :job_id The ID of the job to fetch
+          # @option arguments [String] :snapshot_id The ID of the snapshot to delete
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
           #
-          def delete_model_snapshot(arguments={})
+          def delete_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_DELETE
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/model_snapshots/#{arguments[:snapshot_id]}"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/model_snapshots/#{Elasticsearch::API::Utils.__listify(_snapshot_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/estimate_memory_usage.rb

@@ -7,24 +7,26 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # 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={})
+          def estimate_memory_usage(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
             path   = "_ml/data_frame/analytics/_estimate_memory_usage"
             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/evaluate_data_frame.rb

@@ -0,0 +1,32 @@
+# 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 [Hash] :body The evaluation definition (*Required*)
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html
+          #
+          def evaluate_data_frame(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/data_frame/_evaluate"
+            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/find_file_structure.rb

@@ -1,26 +1,70 @@
+# 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
 
-          # Finds the structure of a text file. The text file must contain data that is suitable to be
-          #   ingested into Elasticsearch.
           #
+          # @option arguments [Int] :lines_to_sample How many lines of the file should be included in the analysis
+          # @option arguments [Int] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
+          # @option arguments [Time] :timeout Timeout after which the analysis will be aborted
+          # @option arguments [String] :charset Optional parameter to specify the character set of the file
+          # @option arguments [String] :format Optional parameter to specify the high level file format
+          #   (options: ndjson,xml,delimited,semi_structured_text)
+
+          # @option arguments [Boolean] :has_header_row Optional parameter to specify whether a delimited file includes the column names in its first row
+          # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
+          # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
+          # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character
+          # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
+          # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
+          # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file
+          # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
+          # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived
+
           # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-file-structure.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html
           #
-          def find_file_structure(arguments={})
+          def find_file_structure(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/ml/find_file_structure"
-            body = Elasticsearch::API::Utils.__bulkify(arguments.delete(:body))
+            path   = "_ml/find_file_structure"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-            perform_request(method, path, arguments, body).body
+            body = Elasticsearch::API::Utils.__bulkify(arguments.delete(:body))
+            perform_request(method, path, params, body).body
           end
-        end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:find_file_structure, [
+            :lines_to_sample,
+            :line_merge_size_limit,
+            :timeout,
+            :charset,
+            :format,
+            :has_header_row,
+            :column_names,
+            :delimiter,
+            :quote,
+            :should_trim_fields,
+            :grok_pattern,
+            :timestamp_field,
+            :timestamp_format,
+            :explain
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,40 +7,47 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Force any buffered data to be processed by the job
           #
-          # @option arguments [String] :job_id The name of the job to flush (*Required*)
-          # @option arguments [Hash] :body Flush parameters
+          # @option arguments [String] :job_id The name of the job to flush
           # @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period
           # @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
           # @option arguments [String] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
-          # @option arguments [String] :advance_time Setting this tells the Engine API that no data prior to advance_time is expected
+          # @option arguments [String] :advance_time Advances time to the given value generating results and updating the model for the advanced interval
           # @option arguments [String] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval
-          #
+
+          # @option arguments [Hash] :body Flush parameters
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
           #
-          def flush_job(arguments={})
+          def flush_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]}/_flush"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_flush"
             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(:flush_job, [ :calc_interim,
-                                                :start,
-                                                :end,
-                                                :advance_time,
-                                                :skip_time ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:flush_job, [
+            :calc_interim,
+            :start,
+            :end,
+            :advance_time,
+            :skip_time
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,32 +7,40 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Predict the future behavior of a time series
           #
-          # @option arguments [String] :job_id The ID of the job to forecast for (*Required*)
+          # @option arguments [String] :job_id The ID of the job to forecast for
           # @option arguments [Time] :duration The duration of the forecast
           # @option arguments [Time] :expires_in The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
+
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html
+          # @see [TODO]
           #
-          def forecast(arguments={})
+          def forecast(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]}/_forecast"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_forecast"
             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(:forecast, [ :duration,
-                                               :expires_in ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:forecast, [
+            :duration,
+            :expires_in
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,12 +7,11 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve job results for one or more buckets
           #
-          # @option arguments [String] :job_id ID of the job to get bucket results from (*Required*)
+          # @option arguments [String] :job_id ID of the job to get bucket results from
           # @option arguments [String] :timestamp The timestamp of the desired single bucket result
-          # @option arguments [Hash] :body Bucket selection details if not provided in URI
           # @option arguments [Boolean] :expand Include anomaly records
           # @option arguments [Boolean] :exclude_interim Exclude interim results
           # @option arguments [Int] :from skips a number of buckets
@@ -22,37 +21,48 @@ module Elasticsearch
           # @option arguments [Double] :anomaly_score Filter for the most anomalous buckets
           # @option arguments [String] :sort Sort buckets by a particular field
           # @option arguments [Boolean] :desc Set the sort direction
+
+          # @option arguments [Hash] :body Bucket selection details if not provided in URI
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html
           #
-          def get_buckets(arguments={})
+          def get_buckets(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
             arguments = arguments.clone
-            timestamp = arguments.delete(:timestamp)
+
+            _job_id = arguments.delete(:job_id)
+
+            _timestamp = arguments.delete(:timestamp)
 
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "results/buckets", timestamp
+            path   = if _job_id && _timestamp
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets/#{Elasticsearch::API::Utils.__listify(_timestamp)}"
+                     else
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets"
+  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_buckets, [ :timestamp,
-                                                  :expand,
-                                                  :exclude_interim,
-                                                  :from,
-                                                  :size,
-                                                  :start,
-                                                  :end,
-                                                  :anomaly_score,
-                                                  :sort,
-                                                  :desc ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_buckets, [
+            :expand,
+            :exclude_interim,
+            :from,
+            :size,
+            :start,
+            :end,
+            :anomaly_score,
+            :sort,
+            :desc
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,42 +7,46 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :calendar_id The ID of the calendar containing the events (*Required*)
+          # @option arguments [String] :calendar_id The ID of the calendar containing the events
           # @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all'
           # @option arguments [String] :start Get events after this time
           # @option arguments [Date] :end Get events before this time
           # @option arguments [Int] :from Skips a number of events
           # @option arguments [Int] :size Specifies a max number of events to get
+
           #
           # @see [TODO]
           #
-          def get_calendar_events(arguments={})
+          def get_calendar_events(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
+
             arguments = arguments.clone
-            calendar_id = arguments.delete(:calendar_id)
+
+            _calendar_id = arguments.delete(:calendar_id)
 
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ml/calendars/#{calendar_id}/events"
+            path   = "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}/events"
             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(:get_calendar_events, [ :calendar_id,
-                                                          :job_id,
-                                                          :start,
-                                                          :end,
-                                                          :from,
-                                                          :size ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_calendar_events, [
+            :job_id,
+            :start,
+            :end,
+            :from,
+            :size
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,35 +7,43 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
           # @option arguments [String] :calendar_id The ID of the calendar to fetch
           # @option arguments [Int] :from skips a number of calendars
           # @option arguments [Int] :size specifies a max number of calendars to get
+
+          # @option arguments [Hash] :body The from and size parameters optionally sent in the body
           #
           # @see [TODO]
           #
-          def get_calendars(arguments={})
+          def get_calendars(arguments = {})
             arguments = arguments.clone
-            calendar_id = arguments.delete(:calendar_id)
+
+            _calendar_id = arguments.delete(:calendar_id)
 
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ml/calendars/#{calendar_id}"
+            path   = if _calendar_id
+                       "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}"
+                     else
+                       "_ml/calendars"
+  end
             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(:get_calendars, [ :calendar_id,
-                                                    :from,
-                                                    :size ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_calendars, [
+            :from,
+            :size
+          ].freeze)
       end
     end
+    end
   end
 end