[X-Pack] Adds X-Pack cat Endpoint API

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack.rb

@@ -87,6 +87,10 @@ def transform
       def async_search
         @async_search ||= xpack.async_search
       end
+
+      def cat
+        @cat ||= xpack.cat
+      end
     end
   end
 end if defined?(Elasticsearch::Transport::Client)

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb

@@ -0,0 +1,64 @@
+# 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 Cat
+        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 configs. (This includes `_all` string or when no configs have been specified)
+          # @option arguments [String] :bytes The unit in which to display byte values
+          #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
+
+          # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+          # @option arguments [List] :h Comma-separated list of column names to display
+          # @option arguments [Boolean] :help Return help information
+          # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+          # @option arguments [String] :time The unit in which to display time values
+          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html
+          #
+          def ml_data_frame_analytics(arguments = {})
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _id
+                       "_cat/ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}"
+                     else
+                       "_cat/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(:ml_data_frame_analytics, [
+            :allow_no_match,
+            :bytes,
+            :format,
+            :h,
+            :help,
+            :s,
+            :time,
+            :v
+          ].freeze)
+      end
+    end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb

@@ -0,0 +1,60 @@
+# 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 Cat
+        module Actions
+          # TODO: Description
+
+          #
+          # @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 [String] :format a short version of the Accept header, e.g. json, yaml
+          # @option arguments [List] :h Comma-separated list of column names to display
+          # @option arguments [Boolean] :help Return help information
+          # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+          # @option arguments [String] :time The unit in which to display time values
+          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
+          #
+          def ml_datafeeds(arguments = {})
+            arguments = arguments.clone
+
+            _datafeed_id = arguments.delete(:datafeed_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _datafeed_id
+                       "_cat/ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}"
+                     else
+                       "_cat/ml/datafeeds"
+  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(:ml_datafeeds, [
+            :allow_no_datafeeds,
+            :format,
+            :h,
+            :help,
+            :s,
+            :time,
+            :v
+          ].freeze)
+      end
+    end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb

@@ -0,0 +1,64 @@
+# 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 Cat
+        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)
+          # @option arguments [String] :bytes The unit in which to display byte values
+          #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
+
+          # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+          # @option arguments [List] :h Comma-separated list of column names to display
+          # @option arguments [Boolean] :help Return help information
+          # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+          # @option arguments [String] :time The unit in which to display time values
+          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
+          #
+          def ml_jobs(arguments = {})
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _job_id
+                       "_cat/ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}"
+                     else
+                       "_cat/ml/anomaly_detectors"
+  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(:ml_jobs, [
+            :allow_no_jobs,
+            :bytes,
+            :format,
+            :h,
+            :help,
+            :s,
+            :time,
+            :v
+          ].freeze)
+      end
+    end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb

@@ -0,0 +1,68 @@
+# 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 Cat
+        module Actions
+          # TODO: Description
+
+          #
+          # @option arguments [String] :model_id The ID of the trained models stats 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)
+          # @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 [String] :bytes The unit in which to display byte values
+          #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
+
+          # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+          # @option arguments [List] :h Comma-separated list of column names to display
+          # @option arguments [Boolean] :help Return help information
+          # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+          # @option arguments [String] :time The unit in which to display time values
+          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
+          #
+          def ml_trained_models(arguments = {})
+            arguments = arguments.clone
+
+            _model_id = arguments.delete(:model_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _model_id
+                       "_cat/ml/trained_models/#{Elasticsearch::API::Utils.__listify(_model_id)}"
+                     else
+                       "_cat/ml/trained_models"
+  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(:ml_trained_models, [
+            :allow_no_match,
+            :from,
+            :size,
+            :bytes,
+            :format,
+            :h,
+            :help,
+            :s,
+            :time,
+            :v
+          ].freeze)
+      end
+    end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/params_registry.rb

@@ -0,0 +1,49 @@
+# 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 Cat
+        module Actions
+          module ParamsRegistry
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            PARAMS = {}
+
+            # Register an action with its list of valid params.
+            #
+            # @example Register the action.
+            #   ParamsRegistry.register(:benchmark, [ :verbose ])
+            #
+            # @param [ Symbol ] action The action to register.
+            # @param [ Array[Symbol] ] valid_params The list of valid params.
+            #
+            # @since 7.4.0
+            def register(action, valid_params)
+              PARAMS[action.to_sym] = valid_params
+            end
+
+            # Get the list of valid params for a given action.
+            #
+            # @example Get the list of valid params.
+            #   ParamsRegistry.get(:benchmark)
+            #
+            # @param [ Symbol ] action The action.
+            #
+            # @return [ Array<Symbol> ] The list of valid params for the action.
+            #
+            # @since 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/transform.rb

@@ -0,0 +1,64 @@
+# 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 Cat
+        module Actions
+          # TODO: Description
+
+          #
+          # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
+          # @option arguments [Int] :from skips a number of transform configs, defaults to 0
+          # @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100
+          # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
+          # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+          # @option arguments [List] :h Comma-separated list of column names to display
+          # @option arguments [Boolean] :help Return help information
+          # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+          # @option arguments [String] :time The unit in which to display time values
+          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
+          #
+          def transform(arguments = {})
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _transform_id
+                       "_cat/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+                     else
+                       "_cat/transforms"
+  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(:transform, [
+            :from,
+            :size,
+            :allow_no_match,
+            :format,
+            :h,
+            :help,
+            :s,
+            :time,
+            :v
+          ].freeze)
+      end
+    end
+    end
+  end
+end