elasticsearch-xpack 7.8.1 → 7.9.0.pre

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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -21,15 +21,11 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
           #
           # @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]
@@ -47,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

@@ -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

@@ -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

@@ -21,15 +21,11 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Evaluates the data frame analytics for an annotated index.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
           #
           # @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]
@@ -45,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/explain_data_frame_analytics.rb

@@ -21,16 +21,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Explains a data frame analytics config.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
           #
           # @option arguments [String] :id The ID of the data frame analytics to explain
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The data frame analytics config to explain
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/7.8/explain-dfanalytics.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/7.x/explain-dfanalytics.html
           #
           def explain_data_frame_analytics(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -39,19 +35,24 @@ module Elasticsearch
 
             _id = arguments.delete(:id)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _id
-                       "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_explain"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "_ml/data_frame/analytics/_explain"
-            end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _id
+                     "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_explain"
+                   else
+                     "_ml/data_frame/analytics/_explain"
+                   end
             params = {}
 
             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/find_file_structure.rb

@@ -21,10 +21,6 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
           #
           # @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.
@@ -32,6 +28,7 @@ module Elasticsearch
           # @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
@@ -44,7 +41,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-find-file-structure.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-find-file-structure.html
           #
           def find_file_structure(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -80,8 +77,8 @@ module Elasticsearch
             :timestamp_format,
             :explain
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -31,7 +31,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Flush parameters
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-flush-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-flush-job.html
           #
           def flush_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -60,8 +60,8 @@ module Elasticsearch
             :advance_time,
             :skip_time
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -25,9 +25,10 @@ module Elasticsearch
           # @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.
+          # @option arguments [String] :max_model_memory The max memory able to be used by the forecast. Default is 20mb.
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-forecast.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-forecast.html
           #
           def forecast(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -51,10 +52,11 @@ module Elasticsearch
           # @since 6.2.0
           ParamsRegistry.register(:forecast, [
             :duration,
-            :expires_in
+            :expires_in,
+            :max_model_memory
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -36,7 +36,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Bucket selection details if not provided in URI
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-get-bucket.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-bucket.html
           #
           def get_buckets(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -49,12 +49,17 @@ module Elasticsearch
 
             _timestamp = arguments.delete(:timestamp)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _job_id && _timestamp
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets/#{Elasticsearch::API::Utils.__listify(_timestamp)}"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/buckets"
-  end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            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]
@@ -75,8 +80,8 @@ module Elasticsearch
             :sort,
             :desc
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -30,7 +30,7 @@ module Elasticsearch
           # @option arguments [Int] :size Specifies a max number of events to get
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-get-calendar-event.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-calendar-event.html
           #
           def get_calendar_events(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
@@ -59,8 +59,8 @@ module Elasticsearch
             :from,
             :size
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -28,7 +28,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The from and size parameters optionally sent in the body
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-get-calendar.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-calendar.html
           #
           def get_calendars(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -37,12 +37,17 @@ module Elasticsearch
 
             _calendar_id = arguments.delete(:calendar_id)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _calendar_id
-                       "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "_ml/calendars"
-            end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            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 = arguments[:body]
@@ -56,8 +61,8 @@ module Elasticsearch
             :from,
             :size
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -26,10 +26,11 @@ module Elasticsearch
           # @option arguments [Long] :category_id The identifier of the category definition of interest
           # @option arguments [Int] :from skips a number of categories
           # @option arguments [Int] :size specifies a max number of categories to get
+          # @option arguments [String] :partition_field_value Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled.
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Category selection details if not provided in URI
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-get-category.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-category.html
           #
           def get_categories(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -42,12 +43,17 @@ module Elasticsearch
 
             _category_id = arguments.delete(:category_id)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _job_id && _category_id
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories/#{Elasticsearch::API::Utils.__listify(_category_id)}"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories"
-  end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _job_id && _category_id
+                     "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories/#{Elasticsearch::API::Utils.__listify(_category_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/categories"
+                   end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
@@ -59,10 +65,11 @@ module Elasticsearch
           # @since 6.2.0
           ParamsRegistry.register(:get_categories, [
             :from,
-            :size
+            :size,
+            :partition_field_value
           ].freeze)
+        end
       end
     end
-    end
   end
 end