elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,34 +7,48 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve job results for one or more categories
           #
-          # @option arguments [String] :job_id The name of the job (*Required*)
+          # @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 [Hash] :body Category selection details if not provided in URI
           # @option arguments [Int] :from skips a number of categories
           # @option arguments [Int] :size specifies a max number of categories to get
+
+          # @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
           #
-          def get_categories(arguments={})
+          def get_categories(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
+            _category_id = arguments.delete(:category_id)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/anomaly_detectors", arguments[:job_id], "results/categories", arguments[:category_id]
+            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]
 
+            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_categories, [ :from,
-                                                     :size ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_categories, [
+            :from,
+            :size
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -0,0 +1,50 @@
+# 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 [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
+
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html
+          #
+          def get_data_frame_analytics(arguments = {})
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _id
+                       "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}"
+                     else
+                       "_ml/data_frame/analytics"
+  end
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:get_data_frame_analytics, [
+            :allow_no_match,
+            :from,
+            :size
+          ].freeze)
+      end
+    end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 [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
+
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html
+          #
+          def get_data_frame_analytics_stats(arguments = {})
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _id
+                       "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_stats"
+                     else
+                       "_ml/data_frame/analytics/_stats"
+  end
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:get_data_frame_analytics_stats, [
+            :allow_no_match,
+            :from,
+            :size
+          ].freeze)
+      end
+    end
+    end
+  end
+end

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

@@ -7,29 +7,40 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve 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)
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
           #
-          def get_datafeed_stats(arguments={})
+          def get_datafeed_stats(arguments = {})
+            arguments = arguments.clone
+
+            _datafeed_id = arguments.delete(:datafeed_id)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/datafeeds", arguments[:datafeed_id], "/_stats"
+            path   = if _datafeed_id
+                       "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_stats"
+                     else
+                       "_ml/datafeeds/_stats"
+  end
             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_datafeed_stats, [ :allow_no_datafeeds ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_datafeed_stats, [
+            :allow_no_datafeeds
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,29 +7,40 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve configuration information for datafeeds
           #
-          # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
+          # @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)
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
           #
-          def get_datafeeds(arguments={})
+          def get_datafeeds(arguments = {})
+            arguments = arguments.clone
+
+            _datafeed_id = arguments.delete(:datafeed_id)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/datafeeds", arguments[:datafeed_id]
+            path   = if _datafeed_id
+                       "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}"
+                     else
+                       "_ml/datafeeds"
+  end
             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_datafeeds, [ :allow_no_datafeeds ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_datafeeds, [
+            :allow_no_datafeeds
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,27 +7,42 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
+          #
           # @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
+
           #
-          def get_filters(arguments={})
+          # @see [TODO]
+          #
+          def get_filters(arguments = {})
+            arguments = arguments.clone
+
+            _filter_id = arguments.delete(:filter_id)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/filters", arguments[:filter_id]
+            path   = if _filter_id
+                       "_ml/filters/#{Elasticsearch::API::Utils.__listify(_filter_id)}"
+                     else
+                       "_ml/filters"
+  end
             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_filters, [ :from,
-                                                  :size ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_filters, [
+            :from,
+            :size
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,11 +7,10 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve job results for one or more influencers
           #
-          # @option arguments [String] :job_id [TODO] (*Required*)
-          # @option arguments [Hash] :body Influencer selection criteria
+          # @option arguments [String] :job_id [TODO]
           # @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
@@ -20,32 +19,41 @@ 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] :body Influencer selection criteria
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
           #
-          def get_influencers(arguments={})
+          def get_influencers(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/influencers"
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/results/influencers"
             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_influencers, [ :exclude_interim,
-                                                      :from,
-                                                      :size,
-                                                      :start,
-                                                      :end,
-                                                      :influencer_score,
-                                                      :sort,
-                                                      :desc ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_influencers, [
+            :exclude_interim,
+            :from,
+            :size,
+            :start,
+            :end,
+            :influencer_score,
+            :sort,
+            :desc
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,29 +7,40 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-
           # TODO: Description
+
           #
           # @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)
+
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-job-stats.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html
           #
-          def get_job_stats(arguments={})
+          def get_job_stats(arguments = {})
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_stats"
+            path   = if _job_id
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_stats"
+                     else
+                       "_ml/anomaly_detectors/_stats"
+  end
             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_job_stats, [ :allow_no_jobs ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_job_stats, [
+            :allow_no_jobs
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,29 +7,40 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
+          # TODO: Description
 
-          # Retrieve configuration information for 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)
+
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
           #
-          def get_jobs(arguments={})
+          def get_jobs(arguments = {})
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}"
+            path   = if _job_id
+                       "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}"
+                     else
+                       "_ml/anomaly_detectors"
+  end
             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_jobs, [ :allow_no_jobs ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_jobs, [
+            :allow_no_jobs
+          ].freeze)
       end
     end
+    end
   end
 end