elasticsearch-xpack 7.8.1 → 7.9.0.pre

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

data/lib/elasticsearch/xpack/api/actions/eql/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 Eql
+        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/eql/search.rb

@@ -0,0 +1,65 @@
+# 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 results matching a query expressed in Event Query Language (EQL)
+          #
+          # @option arguments [String] :index The name of the index to scope the operation
+          # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
+          # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)
+          # @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
+          # @option arguments [Hash] :body Eql request body. Use the `query` to limit the query scope. (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
+          #
+          def search(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+            arguments[:index] = UNDERSCORE_ALL if !arguments[:index] && arguments[:type]
+
+            _index = arguments.delete(:index)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "#{Elasticsearch::API::Utils.__listify(_index)}/_eql/search"
+            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(:search, [
+            :wait_for_completion_timeout,
+            :keep_on_completion,
+            :keep_alive
+          ].freeze)
+        end
+      end
+    end
+  end
+end

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

@@ -34,7 +34,7 @@ module Elasticsearch
           # Deprecated since version 7.0.0
           #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/graph-explore-api.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/graph-explore-api.html
           #
           def explore(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -47,12 +47,17 @@ module Elasticsearch
 
             _type = arguments.delete(:type)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = if _index && _type
-                       "#{Elasticsearch::API::Utils.__listify(_index)}/#{Elasticsearch::API::Utils.__listify(_type)}/_graph/explore"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
                      else
-                       "#{Elasticsearch::API::Utils.__listify(_index)}/_graph/explore"
-  end
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _index && _type
+                     "#{Elasticsearch::API::Utils.__listify(_index)}/#{Elasticsearch::API::Utils.__listify(_type)}/_graph/explore"
+                   else
+                     "#{Elasticsearch::API::Utils.__listify(_index)}/_graph/explore"
+                   end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
@@ -66,8 +71,8 @@ module Elasticsearch
             :routing,
             :timeout
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :policy The name of the index lifecycle policy
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ilm-delete-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-delete-lifecycle.html
           #
           def delete_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
@@ -43,8 +43,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -27,7 +27,7 @@ module Elasticsearch
           # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ilm-explain-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-explain-lifecycle.html
           #
           def explain_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -53,8 +53,8 @@ module Elasticsearch
             :only_managed,
             :only_errors
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :policy The name of the index lifecycle policy
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ilm-get-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-get-lifecycle.html
           #
           def get_lifecycle(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -39,14 +39,14 @@ module Elasticsearch
                        "_ilm/policy/#{Elasticsearch::API::Utils.__listify(_policy)}"
                      else
                        "_ilm/policy"
-            end
+                     end
             params = {}
 
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ilm-get-status.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-get-status.html
           #
           def get_status(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -38,8 +38,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The new lifecycle step to move to
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ilm-move-to-step.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-move-to-step.html
           #
           def move_to_step(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -44,8 +44,8 @@ module Elasticsearch
             body = arguments[:body]
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The lifecycle policy definition to register
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ilm-put-lifecycle.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ilm-put-lifecycle.html
           #
           def put_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
@@ -44,8 +44,8 @@ module Elasticsearch
             body = arguments[:body]
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end