[X-Pack] Adds transform endpoint

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack.rb

@@ -79,6 +79,10 @@ def ilm
       def license
         @license ||= xpack.license
       end
+
+      def transform
+        @transform ||= xpack.transform
+      end
     end
   end
 end if defined?(Elasticsearch::Transport::Client)

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

@@ -0,0 +1,44 @@
+# 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 Transform
+        module Actions
+          # TODO: Description
+
+          #
+          # @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.
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html
+          #
+          def delete_transform(arguments = {})
+            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+            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(:delete_transform, [
+            :force
+          ].freeze)
+      end
+    end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/transform/get_transform.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 Transform
+        module Actions
+          # TODO: Description
+
+          #
+          # @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)
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html
+          #
+          def get_transform(arguments = {})
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _transform_id
+                       "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+                     else
+                       "_transform"
+  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_transform, [
+            :from,
+            :size,
+            :allow_no_match
+          ].freeze)
+      end
+    end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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 Transform
+        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 [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)
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html
+          #
+          def get_transform_stats(arguments = {})
+            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_stats"
+            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_transform_stats, [
+            :from,
+            :size,
+            :allow_no_match
+          ].freeze)
+      end
+    end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/transform/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 Transform
+        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/transform/preview_transform.rb

@@ -0,0 +1,32 @@
+# 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 Transform
+        module Actions
+          # TODO: Description
+
+          # @option arguments [Hash] :body The definition for the transform to preview (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html
+          #
+          def preview_transform(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_transform/_preview"
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body).body
+          end
+      end
+    end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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 Transform
+        module Actions
+          # TODO: Description
+
+          #
+          # @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] :body The transform definition (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html
+          #
+          def put_transform(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = arguments[:body]
+            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(:put_transform, [
+            :defer_validation
+          ].freeze)
+      end
+    end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# 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 Transform
+        module Actions
+          # TODO: Description
+
+          #
+          # @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
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html
+          #
+          def start_transform(arguments = {})
+            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_start"
+            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(:start_transform, [
+            :timeout
+          ].freeze)
+      end
+    end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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 Transform
+        module Actions
+          # TODO: Description
+
+          #
+          # @option arguments [String] :transform_id The id of the transform to stop
+          # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false
+          # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false
+          # @option arguments [Time] :timeout Controls the time to wait until the transform has stopped. Default to 30 seconds
+          # @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 [Boolean] :wait_for_checkpoint Whether to wait for the transform to reach a checkpoint before stopping. Default to false
+
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html
+          #
+          def stop_transform(arguments = {})
+            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_stop"
+            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(:stop_transform, [
+            :force,
+            :wait_for_completion,
+            :timeout,
+            :allow_no_match,
+            :wait_for_checkpoint
+          ].freeze)
+      end
+    end
+    end
+  end
+end