elasticsearch-xpack 7.6.0 → 7.7.0.pre

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

data/lib/elasticsearch/xpack/api/actions/transform/preview_transform.rb

@@ -0,0 +1,35 @@
+# 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
+          # Previews a transform.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @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]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_transform/_preview"
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+          end
+      end
+    end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# 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
+          # 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*)
+          #
+          # @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]
+
+            headers = arguments.delete(:headers) || {}
+
+            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, headers).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

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

@@ -0,0 +1,45 @@
+# 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
+          # 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
+          #
+          # @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]
+
+            headers = arguments.delete(:headers) || {}
+
+            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, headers).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

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

@@ -0,0 +1,53 @@
+# 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
+          # Stops one or more transforms.
+          #
+          # @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
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @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]
+
+            headers = arguments.delete(:headers) || {}
+
+            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, headers).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

data/lib/elasticsearch/xpack/api/actions/transform/update_transform.rb

@@ -0,0 +1,47 @@
+# 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
+          # Updates certain properties of a transform.
+          #
+          # @option arguments [String] :transform_id The id of the transform.  (*Required*)
+          # @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 update transform definition (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html
+          #
+          def update_transform(arguments = {})
+            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)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_update"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = arguments[:body]
+            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(:update_transform, [
+            :defer_validation
+          ].freeze)
+      end
+    end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/usage.rb

@@ -6,15 +6,16 @@ module Elasticsearch
   module XPack
     module API
       module Actions
-        # TODO: Description
-
+        # Retrieves usage information about the installed X-Pack features.
         #
         # @option arguments [Time] :master_timeout Specify timeout for watch write operation
-
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html
         #
         def usage(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_GET
@@ -22,7 +23,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/watcher/ack_watch.rb

@@ -7,18 +7,19 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
-          # TODO: Description
-
+          # Acknowledges a watch, manually throttling the execution of the watch's actions.
           #
           # @option arguments [String] :watch_id Watch ID
           # @option arguments [List] :action_id A comma-separated list of the action ids to be acked
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html
           #
           def ack_watch(arguments = {})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _watch_id = arguments.delete(:watch_id)
@@ -34,7 +35,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/watcher/activate_watch.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
-          # TODO: Description
-
+          # Activates a currently inactive watch.
           #
           # @option arguments [String] :watch_id Watch ID
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html
           #
           def activate_watch(arguments = {})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _watch_id = arguments.delete(:watch_id)
@@ -27,7 +28,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/watcher/deactivate_watch.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
-          # TODO: Description
-
+          # Deactivates a currently active watch.
           #
           # @option arguments [String] :watch_id Watch ID
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html
           #
           def deactivate_watch(arguments = {})
             raise ArgumentError, "Required argument 'watch_id' missing" unless arguments[:watch_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _watch_id = arguments.delete(:watch_id)
@@ -27,7 +28,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/watcher/delete_watch.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
-          # TODO: Description
-
+          # Removes a watch from Watcher.
           #
           # @option arguments [String] :id Watch ID
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html
           #
           def delete_watch(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -28,9 +29,9 @@ module Elasticsearch
 
             body = nil
             if Array(arguments[:ignore]).include?(404)
-              Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+              Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
             else
-              perform_request(method, path, params, body).body
+              perform_request(method, path, params, body, headers).body
             end
           end
       end

data/lib/elasticsearch/xpack/api/actions/watcher/execute_watch.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Watcher
         module Actions
-          # TODO: Description
-
+          # Forces the execution of a stored watch.
           #
           # @option arguments [String] :id Watch ID
           # @option arguments [Boolean] :debug indicates whether the watch should execute in debug mode
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Execution control
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html
           #
           def execute_watch(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -27,11 +28,11 @@ module Elasticsearch
                        "_watcher/watch/#{Elasticsearch::API::Utils.__listify(_id)}/_execute"
                      else
                        "_watcher/watch/_execute"
-  end
+            end
             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.