elasticsearch-xpack 7.6.0 → 7.7.0.pre

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

@@ -0,0 +1,69 @@
+# 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
+          # Gets configuration and usage information about inference trained models.
+          #
+          # @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,h,m,s,ms,micros,nanos)
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
+          #
+          def ml_trained_models(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            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, headers).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

data/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

data/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

data/lib/elasticsearch/xpack/api/actions/cat/transforms.rb

@@ -0,0 +1,65 @@
+# 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
+          # Gets configuration and usage information about transforms.
+          #
+          # @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,h,m,s,ms,micros,nanos)
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
+          #
+          def transforms(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            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, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:transforms, [
+            :from,
+            :size,
+            :allow_no_match,
+            :format,
+            :h,
+            :help,
+            :s,
+            :time,
+            :v
+          ].freeze)
+      end
+    end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/delete_transform.rb

@@ -7,12 +7,11 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Deletes an existing transform.
           #
           # @option arguments [String] :transform_id The id of the transform to delete
           # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # *Deprecation notice*:
           # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
@@ -24,6 +23,8 @@ module Elasticsearch
           def delete_transform(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _transform_id = arguments.delete(:transform_id)
@@ -33,7 +34,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/data_frame_transform_deprecated/get_transform.rb

@@ -7,14 +7,13 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Retrieves configuration information for transforms.
           #
           # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get 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 [Hash] :headers Custom HTTP headers
           #
           # *Deprecation notice*:
           # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
@@ -24,6 +23,8 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html
           #
           def get_transform(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _transform_id = arguments.delete(:transform_id)
@@ -33,11 +34,11 @@ module Elasticsearch
                        "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
                      else
                        "_data_frame/transforms"
-  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/data_frame_transform_deprecated/get_transform_stats.rb

@@ -7,14 +7,13 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Retrieves usage information for transforms.
           #
           # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
           # @option arguments [Number] :from skips a number of transform stats, defaults to 0
           # @option arguments [Number] :size specifies a max number of transform stats 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 [Hash] :headers Custom HTTP headers
           #
           # *Deprecation notice*:
           # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
@@ -26,6 +25,8 @@ module Elasticsearch
           def get_transform_stats(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _transform_id = arguments.delete(:transform_id)
@@ -35,7 +36,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/data_frame_transform_deprecated/preview_transform.rb

@@ -7,8 +7,9 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Previews a transform.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The definition for the transform to preview (*Required*)
           #
           # *Deprecation notice*:
@@ -21,6 +22,8 @@ module Elasticsearch
           def preview_transform(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -28,7 +31,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/data_frame_transform_deprecated/put_transform.rb

@@ -7,12 +7,11 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Instantiates a transform.
           #
           # @option arguments [String] :transform_id The id of the new transform.
           # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The transform definition (*Required*)
           #
           # *Deprecation notice*:
@@ -26,6 +25,8 @@ module Elasticsearch
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _transform_id = arguments.delete(:transform_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/data_frame_transform_deprecated/start_transform.rb

@@ -7,12 +7,11 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Starts one or more transforms.
           #
           # @option arguments [String] :transform_id The id of the transform to start
           # @option arguments [Time] :timeout Controls the time to wait for the transform to start
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # *Deprecation notice*:
           # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
@@ -24,6 +23,8 @@ module Elasticsearch
           def start_transform(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _transform_id = arguments.delete(:transform_id)
@@ -33,7 +34,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.