elasticsearch-xpack 7.6.0 → 7.7.0.pre

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

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Deletes an existing anomaly detection job.
           #
           # @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
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
           #
           def delete_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -29,7 +30,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Deletes an existing model snapshot.
           #
           # @option arguments [String] :job_id The ID of the job to fetch
           # @option arguments [String] :snapshot_id The ID of the snapshot to delete
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
           #
           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]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -31,7 +32,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
           #
           # @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/current/delete-inference.html
           #
           def delete_trained_model(arguments = {})
             raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _model_id = arguments.delete(:model_id)
@@ -27,7 +28,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -0,0 +1,35 @@
+# 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
+          # Estimates the model memory
+          #
+          # @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/current/ml-apis.html
+          #
+          def estimate_model_memory(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/anomaly_detectors/_estimate_model_memory"
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+          end
+      end
+    end
+    end
+  end
+end

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

@@ -7,15 +7,18 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Evaluates the data frame analytics for an annotated index.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The evaluation definition (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html
+          # @see https://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]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -23,7 +26,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -7,16 +7,17 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Explains a data frame analytics config.
           #
           # @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/current/explain-dfanalytics.html
           #
           def explain_data_frame_analytics(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -26,11 +27,11 @@ module Elasticsearch
                        "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_explain"
                      else
                        "_ml/data_frame/analytics/_explain"
-  end
+            end
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -7,8 +7,7 @@ module Elasticsearch
     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.
@@ -26,14 +25,16 @@ module Elasticsearch
           # @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] :headers Custom HTTP headers
           # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html
           #
           def find_file_structure(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -41,7 +42,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = Elasticsearch::API::Utils.__bulkify(arguments.delete(:body))
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,8 +7,7 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Forces any buffered data to be processed by the job.
           #
           # @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
@@ -16,14 +15,16 @@ module Elasticsearch
           # @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 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] :headers Custom HTTP headers
           # @option arguments [Hash] :body Flush parameters
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
           #
           def flush_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -33,7 +34,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Predicts the future behavior of a time series by using its historical behavior.
           #
           # @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 [Hash] :headers Custom HTTP headers
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html
           #
           def forecast(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -29,7 +30,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,8 +7,7 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves anomaly detection job results for one or more buckets.
           #
           # @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
@@ -21,14 +20,16 @@ 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] :headers Custom HTTP headers
           # @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
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html
           #
           def get_buckets(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -44,7 +45,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,8 +7,7 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves information about the scheduled events in calendars.
           #
           # @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'
@@ -16,13 +15,15 @@ module Elasticsearch
           # @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
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html
           #
           def get_calendar_events(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _calendar_id = arguments.delete(:calendar_id)
@@ -32,7 +33,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,18 +7,19 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves configuration information for calendars.
           #
           # @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] :headers Custom HTTP headers
           # @option arguments [Hash] :body The from and size parameters optionally sent in the body
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html
           #
           def get_calendars(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _calendar_id = arguments.delete(:calendar_id)
@@ -28,11 +29,11 @@ module Elasticsearch
                        "_ml/calendars/#{Elasticsearch::API::Utils.__listify(_calendar_id)}"
                      else
                        "_ml/calendars"
-  end
+            end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,21 +7,22 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves anomaly detection job results for one or more categories.
           #
           # @option arguments [String] :job_id The name of the job
           # @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 [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Category selection details if not provided in URI
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html
           #
           def get_categories(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -37,7 +38,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.