elasticsearch-xpack 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa4a8d4dc0d5cb53f1f1c84fced0773310872d6130173d2ce935330d7b07090
-  data.tar.gz: 6af0a1fe2995ca424aec5914fae9b4a884895442aa5ad09c5cca74b0a5feeb13
+  metadata.gz: 7913c8a63a2df01c7d876709583348cb2eaac5fb46532164567c8095d527c377
+  data.tar.gz: 3c512f17307d2014b39c7ae9b0ca0f8b9ae558efa70f9f160aa0f39e6f931391
 SHA512:
-  metadata.gz: 4ddbf54710f11af50108d6b2e8c68a7a51cf5300ecfa579b1e95111a6d0e7391f2fcaec6e66ace7f35887e821264b7de3fd74c88b14c44e72cbc339bf385256a
-  data.tar.gz: 677489d21d61e33d56683862c0417c096963624bf5bddbd5faec396dbbbbe52e2b8899f8b3c10a4351d1ecf56bae9fb9ea0caf3c3788f6e8cc3e5c477f0f305c
+  metadata.gz: 4e7ff84451376fc5f87cefe883ff79fca0fe2415ecbd87f1cdc92890d48a01d9575bfd4bb7314b017173d3d3e5db47212a55a375ffc98cae5b963e5ee59cf5fd
+  data.tar.gz: fc1a7fb35baf259cd4b2f7a031107c80b43180a31d0b08d70dee8eb386bf39582413b531b726e9257dec12d6b225aba32f78282e071efd5955b4f46b61e2f494

data/lib/elasticsearch/xpack.rb

@@ -4,7 +4,9 @@
 
 require "elasticsearch/api"
 require "elasticsearch/xpack/version"
+require "elasticsearch/xpack/api/actions/params_registry"
 
+Dir[ File.expand_path('../xpack/api/actions/**/params_registry.rb', __FILE__) ].each   { |f| require f }
 Dir[ File.expand_path('../xpack/api/actions/**/*.rb', __FILE__) ].each   { |f| require f }
 Dir[ File.expand_path('../xpack/api/namespace/**/*.rb', __FILE__) ].each { |f| require f }
 
@@ -25,7 +27,7 @@ module Elasticsearch
   end
 end
 
-Elasticsearch::API::COMMON_PARAMS.push :job_id, :datafeed_id, :filter_id, :snapshot_id, :category_id
+Elasticsearch::API::COMMON_PARAMS.push :job_id, :datafeed_id, :filter_id, :snapshot_id, :category_id, :policy_id
 
 module Elasticsearch
   module Transport
@@ -69,6 +71,10 @@ module Elasticsearch
       def data_frame
         @data_frame ||= xpack.data_frame
       end
+
+      def ilm
+        @ilm ||= xpack.ilm
+      end
     end
   end
 end if defined?(Elasticsearch::Transport::Client)

data/lib/elasticsearch/xpack/api/actions/data_frame/delete_data_frame_transform.rb

@@ -11,21 +11,29 @@ module Elasticsearch
           # Deletes an existing data frame transform.
           #
           # @option arguments [String] :transform_id The id of the transform to delete. *Required*
+          # @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-data-frame-transform.html
           #
           # @since 7.2.0
           def delete_data_frame_transform(arguments={})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
-            transform_id = URI.escape(arguments[:transform_id])
+            arguments.clone
+            transform_id = URI.escape(arguments.delete(:transform_id))
 
             method = Elasticsearch::API::HTTP_DELETE
             path   = "_data_frame/transforms/#{transform_id}"
-            params = {}
+            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 7.4.0
+          ParamsRegistry.register(:delete_data_frame_transform, [ :force ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/data_frame/get_data_frame_transform.rb

@@ -22,18 +22,20 @@ module Elasticsearch
             arguments = arguments.clone
             transform_id = URI.escape(arguments.delete(:transform_id))
 
-            valid_params = [
-                :from,
-                :size,
-                :allow_no_match]
-
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify('_data_frame/transforms', Elasticsearch::API::Utils.__listify(transform_id))
-            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, valid_params)
+            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 7.4.0
+          ParamsRegistry.register(:get_data_frame_transform, [ :from,
+                                                               :size,
+                                                               :allow_no_match ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/data_frame/get_data_frame_transform_stats.rb

@@ -22,17 +22,19 @@ module Elasticsearch
             arguments = arguments.clone
             transform_id = URI.escape(arguments.delete(:transform_id))
 
-            valid_params = [
-                :from,
-                :size]
-
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify('_data_frame/transforms', Elasticsearch::API::Utils.__listify(transform_id), '_stats')
-            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, valid_params)
+            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 7.4.0
+          ParamsRegistry.register(:get_data_frame_transform_stats, [ :from,
+                                                                     :size ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/data_frame/params_registry.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 DataFrame
+        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/data_frame/put_data_frame_transform.rb

@@ -12,6 +12,8 @@ module Elasticsearch
           #
           # @option arguments [Hash] :transform_id The id of the new transform. *Required*
           # @option arguments [Hash] :body The data frame transform definition. *Required*
+          # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts,
+          #   defaults to false.
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html
           #
@@ -20,15 +22,21 @@ module Elasticsearch
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
-            transform_id = URI.escape(arguments[:transform_id])
+            arguments = arguments.clone
+            transform_id = URI.escape(arguments.delete(:transform_id))
             body = arguments[:body]
 
             method = Elasticsearch::API::HTTP_PUT
             path   = "_data_frame/transforms/#{transform_id}"
-            params = {}
+            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, ParamsRegistry.get(__method__))
 
             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(:put_data_frame_transform, [ :defer_validation ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/data_frame/start_data_frame_transform.rb

@@ -21,16 +21,18 @@ module Elasticsearch
             arguments = arguments.clone
             transform_id = URI.escape(arguments.delete(:transform_id))
 
-            valid_params = [
-                :timeout]
-
             method = Elasticsearch::API::HTTP_POST
             path   = "_data_frame/transforms/#{transform_id}/_start"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            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 7.4.0
+          ParamsRegistry.register(:start_data_frame_transform, [ :timeout ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/data_frame/stop_data_frame_transform.rb

@@ -24,18 +24,21 @@ module Elasticsearch
             arguments = arguments.clone
             transform_id = URI.escape(arguments.delete(:transform_id))
 
-            valid_params = [
-                :timeout,
-                :wait_for_completion,
-                :allow_no_match ]
-
             method = Elasticsearch::API::HTTP_POST
             path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(transform_id)}/_stop"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, valid_params)
+            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 7.4.0
+          ParamsRegistry.register(:stop_data_frame_transform, [ :timeout,
+                                                                :wait_for_completion,
+                                                                :allow_no_match ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/data_frame/update_data_frame_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 DataFrame
+        module Actions
+
+          # Updates an existing data frame transform.
+          #
+          # @option arguments [Hash] :transform_id The id of the new transform. *Required*
+          # @option arguments [Hash] :body The update data frame transform definition. *Required*
+          # @option arguments [Boolean] :defer_validation If validations should be deferred until data frame
+          #   transform starts, defaults to false.
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-data-frame-transform.html
+          #
+          # @since 7.4.0
+          def update_data_frame_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 = URI.escape(arguments.delete(:transform_id))
+            body = arguments.delete(:body)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_data_frame/transforms/#{transform_id}/_update"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, ParamsRegistry.get(__method__))
+
+            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(:update_data_frame_transform, [ :defer_validation ].freeze)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/graph/explore.rb

@@ -21,21 +21,23 @@ module Elasticsearch
           # @see https://www.elastic.co/guide/en/graph/current/explore.html
           #
           def explore(arguments={})
-            valid_params = [
-              :routing,
-              :timeout ]
-
             arguments = arguments.clone
             index = arguments.delete(:index)
             type  = arguments.delete(:type)
 
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify Elasticsearch::API::Utils.__listify(index), Elasticsearch::API::Utils.__listify(type), '_graph/explore'
-            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            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 7.4.0
+          ParamsRegistry.register(:explore, [ :routing,
+                                              :timeout ].freeze)
         end
       end
     end

data/lib/elasticsearch/xpack/api/actions/graph/params_registry.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 Graph
+        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/index_lifecycle_management/delete_policy.rb

@@ -0,0 +1,39 @@
+# 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 IndexLifecycleManagement
+        module Actions
+
+          # Deletes a lifecycle policy
+          #
+          # @option arguments [String] :policy_id Identifier for the policy
+          # @option arguments [Time] :master_timeout Specifies the period of time to wait for a connection to the master node
+          # @option arguments [Time] :timeout Specifies the period of time to wait for a response.
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
+          #
+          def delete_policy(arguments={})
+            raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = Elasticsearch::API::Utils.__pathify "_ilm/policy",
+                                                         Elasticsearch::API::Utils.__escape(arguments[:policy_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.
+          #
+          ParamsRegistry.register(:delete_policy, [ :master_timeout,
+                                                    :timeout ].freeze)
+
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain.rb

@@ -0,0 +1,40 @@
+# 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 IndexLifecycleManagement
+        module Actions
+
+          # Shows an index’s current lifecycle status
+          #
+          # @option arguments [String] :index The target index (*Required*)
+          # @option arguments [Time] :master_timeout Specifies the period of time to wait for a connection to the master node
+          # @option arguments [Time] :timeout Specifies the period of time to wait for a response.
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
+          #
+          def explain(arguments={})
+            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+            index = Elasticsearch::API::Utils.__escape(arguments.delete(:index))
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = Elasticsearch::API::Utils.__pathify index, "_ilm/explain"
+            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.
+          #
+          ParamsRegistry.register(:explain, [ :master_timeout,
+                                              :timeout ].freeze)
+
+        end
+      end
+    end
+  end
+end