elasticsearch-xpack 7.8.0 → 7.9.0.pre

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

@@ -31,7 +31,7 @@ module Elasticsearch
           # Deprecated since version 7.5.0
           #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/start-transform.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/start-transform.html
           #
           def start_transform(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
@@ -56,8 +56,8 @@ module Elasticsearch
           ParamsRegistry.register(:start_transform, [
             :timeout
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -33,7 +33,7 @@ module Elasticsearch
           # Deprecated since version 7.5.0
           #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/stop-transform.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/stop-transform.html
           #
           def stop_transform(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
@@ -60,8 +60,8 @@ module Elasticsearch
             :timeout,
             :allow_no_match
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -32,7 +32,7 @@ module Elasticsearch
           # Deprecated since version 7.5.0
           #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/update-transform.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/update-transform.html
           #
           def update_transform(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -58,8 +58,8 @@ module Elasticsearch
           ParamsRegistry.register(:update_transform, [
             :defer_validation
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/enrich/delete_policy.rb

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Enrich
+        module Actions
+          # Deletes an existing enrich policy and its enrich index.
+          #
+          # @option arguments [String] :name The name of the enrich policy
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/delete-enrich-policy-api.html
+          #
+          def delete_policy(arguments = {})
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_enrich/policy/#{Elasticsearch::API::Utils.__listify(_name)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/enrich/execute_policy.rb

@@ -0,0 +1,58 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Enrich
+        module Actions
+          # Creates the enrich index for an existing enrich policy.
+          #
+          # @option arguments [String] :name The name of the enrich policy
+          # @option arguments [Boolean] :wait_for_completion Should the request should block until the execution is complete.
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/execute-enrich-policy-api.html
+          #
+          def execute_policy(arguments = {})
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_enrich/policy/#{Elasticsearch::API::Utils.__listify(_name)}/_execute"
+            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(:execute_policy, [
+            :wait_for_completion
+          ].freeze)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/enrich/get_policy.rb

@@ -0,0 +1,52 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Enrich
+        module Actions
+          # Gets information about an enrich policy.
+          #
+          # @option arguments [List] :name A comma-separated list of enrich policy names
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-enrich-policy-api.html
+          #
+          def get_policy(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _name
+                       "_enrich/policy/#{Elasticsearch::API::Utils.__listify(_name)}"
+                     else
+                       "_enrich/policy"
+                     end
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/enrich/params_registry.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Enrich
+        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/enrich/put_policy.rb

@@ -0,0 +1,52 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Enrich
+        module Actions
+          # Creates a new enrich policy.
+          #
+          # @option arguments [String] :name The name of the enrich policy
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body The enrich policy to register (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-enrich-policy-api.html
+          #
+          def put_policy(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_enrich/policy/#{Elasticsearch::API::Utils.__listify(_name)}"
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/enrich/stats.rb

@@ -0,0 +1,45 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Enrich
+        module Actions
+          # Gets enrich coordinator statistics and information about enrich policies that are currently executing.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/enrich-stats-api.html
+          #
+          def stats(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_enrich/_stats"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/eql/delete.rb

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Eql
+        module Actions
+          # Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
+          #
+          # @option arguments [String] :id The async search ID
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
+          #
+          def delete(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_eql/search/#{Elasticsearch::API::Utils.__listify(_id)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/eql/get.rb

@@ -0,0 +1,60 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Eql
+        module Actions
+          # Returns async results from previously executed Event Query Language (EQL) search
+          #
+          # @option arguments [String] :id The async search ID
+          # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
+          # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
+          #
+          def get(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_eql/search/#{Elasticsearch::API::Utils.__listify(_id)}"
+            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(:get, [
+            :wait_for_completion_timeout,
+            :keep_alive
+          ].freeze)
+        end
+      end
+    end
+  end
+end