elasticsearch-xpack 7.6.0 → 7.7.0.pre

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

@@ -7,18 +7,19 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves configuration information for data frame analytics jobs.
           #
           # @option arguments [String] :id The ID of the data frame analytics to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
           # @option arguments [Int] :from skips a number of analytics
           # @option arguments [Int] :size specifies a max number of analytics to get
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html
           #
           def get_data_frame_analytics(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -28,11 +29,11 @@ module Elasticsearch
                        "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}"
                      else
                        "_ml/data_frame/analytics"
-  end
+            end
             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_data_frame_analytics_stats.rb

@@ -7,18 +7,19 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves usage information for data frame analytics jobs.
           #
           # @option arguments [String] :id The ID of the data frame analytics stats to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
           # @option arguments [Int] :from skips a number of analytics
           # @option arguments [Int] :size specifies a max number of analytics to get
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html
           #
           def get_data_frame_analytics_stats(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -28,11 +29,11 @@ module Elasticsearch
                        "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_stats"
                      else
                        "_ml/data_frame/analytics/_stats"
-  end
+            end
             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_datafeed_stats.rb

@@ -7,16 +7,17 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves usage information for datafeeds.
           #
           # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
           # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
           #
           def get_datafeed_stats(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _datafeed_id = arguments.delete(:datafeed_id)
@@ -26,11 +27,11 @@ module Elasticsearch
                        "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_stats"
                      else
                        "_ml/datafeeds/_stats"
-  end
+            end
             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_datafeeds.rb

@@ -7,16 +7,17 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves configuration information for datafeeds.
           #
           # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch
           # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
           #
           def get_datafeeds(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _datafeed_id = arguments.delete(:datafeed_id)
@@ -26,11 +27,11 @@ module Elasticsearch
                        "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}"
                      else
                        "_ml/datafeeds"
-  end
+            end
             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_filters.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves filters.
           #
           # @option arguments [String] :filter_id The ID of the filter to fetch
           # @option arguments [Int] :from skips a number of filters
           # @option arguments [Int] :size specifies a max number of filters to get
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html
           #
           def get_filters(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _filter_id = arguments.delete(:filter_id)
@@ -27,11 +28,11 @@ module Elasticsearch
                        "_ml/filters/#{Elasticsearch::API::Utils.__listify(_filter_id)}"
                      else
                        "_ml/filters"
-  end
+            end
             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_influencers.rb

@@ -7,10 +7,9 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves anomaly detection job results for one or more influencers.
           #
-          # @option arguments [String] :job_id [TODO]
+          # @option arguments [String] :job_id Identifier for the anomaly detection job
           # @option arguments [Boolean] :exclude_interim Exclude interim results
           # @option arguments [Int] :from skips a number of influencers
           # @option arguments [Int] :size specifies a max number of influencers to get
@@ -19,14 +18,16 @@ module Elasticsearch
           # @option arguments [Double] :influencer_score influencer score threshold for the requested influencers
           # @option arguments [String] :sort sort field for the requested influencers
           # @option arguments [Boolean] :desc whether the results should be sorted in decending order
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Influencer selection criteria
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
           #
           def get_influencers(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)
@@ -36,7 +37,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_job_stats.rb

@@ -7,16 +7,17 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves usage information for anomaly detection jobs.
           #
           # @option arguments [String] :job_id The ID of the jobs stats to fetch
           # @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] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html
           #
           def get_job_stats(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -26,11 +27,11 @@ module Elasticsearch
                        "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_stats"
                      else
                        "_ml/anomaly_detectors/_stats"
-  end
+            end
             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_jobs.rb

@@ -7,16 +7,17 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves configuration information for anomaly detection jobs.
           #
           # @option arguments [String] :job_id The ID of the jobs to fetch
           # @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] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
           #
           def get_jobs(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -26,11 +27,11 @@ module Elasticsearch
                        "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}"
                      else
                        "_ml/anomaly_detectors"
-  end
+            end
             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_model_snapshots.rb

@@ -7,8 +7,7 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves information about model snapshots.
           #
           # @option arguments [String] :job_id The ID of the job to fetch
           # @option arguments [String] :snapshot_id The ID of the snapshot to fetch
@@ -18,14 +17,16 @@ module Elasticsearch
           # @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] :headers Custom HTTP headers
           # @option arguments [Hash] :body Model snapshot selection criteria
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
           #
           def get_model_snapshots(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)
@@ -41,7 +42,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_overall_buckets.rb

@@ -7,8 +7,7 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
           #
           # @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
@@ -18,14 +17,16 @@ 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] :headers Custom HTTP headers
           # @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
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
           #
           def get_overall_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)
@@ -35,7 +36,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_records.rb

@@ -7,26 +7,27 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves anomaly records for an anomaly detection job.
           #
-          # @option arguments [String] :job_id [TODO]
+          # @option arguments [String] :job_id The ID of the job
           # @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
           # @option arguments [String] :start Start time filter for records
           # @option arguments [String] :end End time filter for records
-          # @option arguments [Double] :record_score [TODO]
+          # @option arguments [Double] :record_score Returns records with anomaly scores greater or equal than this value
           # @option arguments [String] :sort Sort records by a particular field
           # @option arguments [Boolean] :desc Set the sort direction
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Record selection criteria
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
           #
           def get_records(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)
@@ -36,7 +37,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_trained_models.rb

@@ -7,8 +7,7 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves configuration information for a trained inference model.
           #
           # @option arguments [String] :model_id The ID of the trained models to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
@@ -16,11 +15,14 @@ module Elasticsearch
           # @option arguments [Boolean] :decompress_definition Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true.
           # @option arguments [Int] :from skips a number of trained models
           # @option arguments [Int] :size specifies a max number of trained models to get
-
+          # @option arguments [List] :tags A comma-separated list of tags that the model must have.
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference.html
           #
           def get_trained_models(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _model_id = arguments.delete(:model_id)
@@ -30,11 +32,11 @@ module Elasticsearch
                        "_ml/inference/#{Elasticsearch::API::Utils.__listify(_model_id)}"
                      else
                        "_ml/inference"
-  end
+            end
             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.
@@ -45,7 +47,8 @@ module Elasticsearch
             :include_model_definition,
             :decompress_definition,
             :from,
-            :size
+            :size,
+            :tags
           ].freeze)
       end
     end